Skip to main content
POST
End one receivable's funding obligation before its term

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Canonical idempotency request ID. Required: this request extinguishes a liability, and without a key a retry cannot be told apart from a second instruction.

Parâmetros de caminho

setId
string<uuid>
obrigatório

Assignment set identifier.

Corpo

application/json
borrowerPayoff
string
obrigatório

What the borrower actually paid to end his own contract, decimal string. Required: it is the default the fund is offered when no amount is agreed, and a pass-through of nothing would book the whole obligation as a gain.

receivableRef
string
obrigatório

The receivable whose funding obligation ends. The obligation is carried per receivable, so one borrower prepaying ends one obligation and not the cession's others.

Maximum string length: 128
agreedAmount
string

What the fund agreed to take, decimal string. Omit it entirely to pass the borrower's payoff through; an informed amount must be above zero and never above the face of the instalments still owed.

Resposta

OK

assignmentSetId
string
obrigatório

The cession whose obligation was ended.

borrowerPayoff
string
obrigatório

What the borrower paid to get out, decimal string, scale 2, echoed as the third reference.

currency
string
obrigatório

ISO-4217 code the obligation is denominated in.

expense
string
obrigatório

The agreed amount ABOVE the obligation, decimal string, scale 2. Financing cost taken in the period the cession ends in.

face
string
obrigatório

Sum of the instalments still owed, decimal string, scale 2. The ceiling the agreed amount may not cross.

fromState
string
obrigatório

The cession's state before this payoff.

gain
string
obrigatório

The agreed amount BELOW the obligation, decimal string, scale 2. Desagio that stops being appropriable. Exactly one of expense and gain is ever positive.

obligation
string
obrigatório

What the liability stood at on this date (Res. CMN 4.966 art. 29 para 1), decimal string, scale 2. After the payoff it is exactly zero.

periodsEnded
integer<int64>
obrigatório

How many open periods of this receivable's ladder the payoff closed at once.

receivableRef
string
obrigatório

The receivable that ended.

settlement
string
obrigatório

What the fund is owed at once, decimal string, scale 2. Credited to what this institution owes the fund, never to cash.

toState
string
obrigatório

The cession's state after it. It reaches 'settled' only when this was its last open obligation, so a cession of many receivables usually stays where it was.