Skip to main content
GET
Get returned payment receivable

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string<uuid>
obrigatório

Returned-payment receivable identifier.

Exemplo:

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

Resposta

OK

amount
string
obrigatório

Amount owed (2 d.p. string).

Exemplo:

"125.00"

borrowerId
string<uuid>
obrigatório

Party who owes the returned money.

Exemplo:

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

currency
string
obrigatório

ISO-4217 currency of the debt.

Exemplo:

"BRL"

id
string<uuid>
obrigatório

Returned-payment receivable identifier.

Exemplo:

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

loanAccountId
string<uuid>
obrigatório

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

Exemplo:

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

openedAt
string
obrigatório

RFC 3339 UTC instant the debt was opened.

Exemplo:

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

openedOn
string
obrigatório

Civil day the debt was opened on.

Exemplo:

"2026-06-14"

originalTransactionId
string
obrigatório

Payment that was given back.

Exemplo:

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

reversalTransactionId
string
obrigatório

Compensating reversal that opened this debt.

Exemplo:

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

status
enum<string>
obrigatório

'open' while the borrower still owes it, 'collected' once it was paid by other means.

Opções disponíveis:
open,
collected
Exemplo:

"open"

collectedAt
string

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

Exemplo:

"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.

Exemplo:

"2026-07-01"