Saltar al contenido principal
GET
Get returned payment receivable

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id
string<uuid>
requerido

Returned-payment receivable identifier.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440003"

Respuesta

OK

amount
string
requerido

Amount owed (2 d.p. string).

Ejemplo:

"125.00"

borrowerId
string<uuid>
requerido

Party who owes the returned money.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440020"

currency
string
requerido

ISO-4217 currency of the debt.

Ejemplo:

"BRL"

id
string<uuid>
requerido

Returned-payment receivable identifier.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440003"

loanAccountId
string<uuid>
requerido

Loan account whose returned payment opened this debt. The contract itself stays discharged.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

openedAt
string
requerido

RFC 3339 UTC instant the debt was opened.

Ejemplo:

"2026-06-14T12:00:00Z"

openedOn
string
requerido

Civil day the debt was opened on.

Ejemplo:

"2026-06-14"

originalTransactionId
string
requerido

Payment that was given back.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440001"

provisionAmount
string
requerido

Credit-loss allowance the ledger holds against this debt right now (2 d.p. string). Zero on a collected debt, which released it, and on a written-off one, which consumed it.

Ejemplo:

"4.38"

reversalTransactionId
string
requerido

Compensating reversal that opened this debt.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440002"

status
enum<string>
requerido

'open' while the borrower still owes it, 'collected' once it was paid by other means, 'written_off' once the ladder charged it off to loss.

Opciones disponibles:
open,
collected,
written_off
Ejemplo:

"open"

collectedAt
string

RFC 3339 UTC instant of the collection; absent while open.

Ejemplo:

"2026-07-01T12:00:00Z"

collectedBy
string

Authenticated subject that recorded the collection; empty when the collection was recorded by the system.

collectedOn
string

Civil day of the collection; absent while open.

Ejemplo:

"2026-07-01"

stage
string

Where the origin credit product's stage ladder put the debt at its last aging. The vocabulary belongs to the jurisdiction publishing the ladder; absent until the first nightly sweep reaches the row.

Ejemplo:

"stage_1"

writtenOffAt
string

RFC 3339 UTC instant of the charge-off; absent unless written off.

Ejemplo:

"2026-09-01T05:00:00Z"

writtenOffOn
string

Civil day of the charge-off; absent unless written off.

Ejemplo:

"2026-09-01"