Skip to main content
GET
Reconcile a contract's deferred origination fee

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string<uuid>
obrigatório

Loan account identifier of the contract.

Exemplo:

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

Resposta

OK

accounts
string[] | null
obrigatório

The contract's own deferred-fee accounts the figures were read from, one per chart the contract lived under, oldest first; always present, empty when the contract's charts defer no fee.

currency
string
obrigatório

Asset the fee is held in.

Exemplo:

"BRL"

loanAccountId
string
obrigatório

Loan account (uuid) of the contract reconciled.

Exemplo:

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

retainedFee
string
obrigatório

Fee the contract record says was withheld at disbursement, summed over every tranche, as a fixed two-decimal string.

Exemplo:

"150.00"

status
enum<string>
obrigatório

MATCH: the ledger deferred exactly the fee the contract retained. DIVERGENT: the two differ, or remaining is negative (the fee was earned more than once); figures.difference says by how much. UNAVAILABLE: the ledger did not answer, so figures is absent.

Opções disponíveis:
MATCH,
DIVERGENT,
UNAVAILABLE
figures
object

What the ledger holds on the fee accounts. Present on MATCH and DIVERGENT, absent on UNAVAILABLE.