v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Loan Accounts

Apply loan account PDD stage transition

Records a PDD transition or cure and updates prospective accrual eligibility.

post/api/v1/br/loan-accounts/{id}/pdd-stage/transitions

Path parameters

idstring uuid required

Loan account identifier.

Request body

businessDatestring required

Business date (YYYY-MM-DD or RFC3339).

effectiveAtstring required

Effective timestamp (RFC3339 or YYYY-MM-DD).

idempotencyKeystring

Client-supplied idempotency key; deduplicated at the persistence layer.

jurisdictionCodestring

Jurisdiction code.

profileVersionstring

Jurisdiction profile version.

reasonstring

Reason for the transition or cure.

toStage'current' | 'stage_1' | 'stage_2' | 'stage_3' required

Target PDD stage.

triggeredBystring

Actor or system that triggered the transition.

Example request

{
  "businessDate": "2026-06-14",
  "effectiveAt": "2026-06-14T12:00:00Z",
  "jurisdictionCode": "BR",
  "profileVersion": "1.0.0",
  "toStage": "stage_1"
}

Response

accrualStatestring required

Interest accrual state implied by the current stage: accruing or suspended.

businessDatestring required

Business date the current stage applies to (YYYY-MM-DD, UTC).

currentStagestring required

Current PDD delinquency stage: one of current, stage_1, stage_2, stage_3.

effectiveAtstring required

RFC3339 UTC timestamp at which the current stage became effective.

jurisdictionCodestring required

ISO jurisdiction code governing the staging (e.g. "BR").

latestTransitionIdstring required

UUID of the most recent PDD stage transition applied to the account.

loanAccountIdstring required

UUID of the loan account whose PDD staging state is reported.

profileVersionstring required

Jurisdiction profile version in effect for the staging rules.

reasonstring required

Reason recorded for entering the current stage.

triggeredBystring required

Actor or system that triggered the current stage.

updatedAtstring required

RFC3339 UTC timestamp when the staging state was last updated.

Example response

{
  "accrualState": "accruing",
  "businessDate": "2026-06-14",
  "currentStage": "stage_1",
  "effectiveAt": "2026-06-14T12:00:00Z",
  "jurisdictionCode": "BR",
  "latestTransition": {
    "accrualState": "accruing",
    "businessDate": "2026-06-14",
    "createdAt": "2026-06-14T12:00:00Z",
    "effectiveAt": "2026-06-14T12:00:00Z",
    "fromStage": "current",
    "id": "550e8400-e29b-41d4-a716-446655440002",
    "jurisdictionCode": "BR",
    "profileVersion": "1.0.0",
    "toStage": "stage_1"
  },
  "latestTransitionId": "550e8400-e29b-41d4-a716-446655440001",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440000",
  "profileVersion": "1.0.0",
  "updatedAt": "2026-06-14T12:00:00Z"
}