Skip to main content
POST
Reverse a recovery of a written-off contract

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string

Idempotency key of the reversal: 1 to 255 bytes of UTF-8. The route refuses a request without it, or with a blank, longer or non-UTF-8 one (LENDER-0976). X-Request-ID is never read as the key.

Path Parameters

id
string<uuid>
required

Written-off direct-credit loan account.

recoveryId
string<uuid>
required

Recovery to give back.

Response

Created

amount
string
required

Money received (2 d.p. string).

Example:

"9000.00"

controlReleased
string
required

Written-off control the recovery released (2 d.p. string).

Example:

"8650.00"

currency
string
required

ISO 4217 currency of the amounts.

Example:

"BRL"

id
string<uuid>
required

Recorded recovery.

loanAccountId
string<uuid>
required

Written-off loan account.

receivedAt
string<date-time>
required

RFC 3339 instant the money arrived, with fractional seconds.

recordedAt
string<date-time>
required

RFC 3339 instant the recovery was recorded.

recordedBy
string
required

Subject of the validated identity that recorded it; empty when none reached the route.

recoveredBefore
string
required

Recovered by the recoveries recorded before this one (2 d.p. string).

Example:

"1200.00"

remainingAfter
string
required

Debt still standing after this recovery (2 d.p. string).

Example:

"1400.00"

requestId
string
required

X-Idempotency key the recovery was recorded under.

taxAmount
string
required

PIS/COFINS booked on the taxed part; 0.00 when nothing is taxed (2 d.p. string).

Example:

"16.28"

taxedAmount
string
required

Part above W: new revenue, taxed by PIS/COFINS (2 d.p. string).

Example:

"350.00"

untaxedAmount
string
required

Part that settles the written-off amount W first: untaxed (2 d.p. string).

Example:

"8650.00"

writeOffId
string<uuid>
required

Write-off the recovery pays down.

reversedAt
string<date-time>

RFC 3339 instant the recovery was reversed, with fractional seconds; absent while it stands. A reversed recovery no longer counts in recoveredTotal, remainingDebt or controlOpen.

reversedBy
string

Subject that reversed it.