Skip to main content
POST
Declare that collection of a desk-closed rest ended

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key of the declaration: 1 to 255 bytes of UTF-8. The same key replays it; another key is refused (LENDER-1613).

Required string length: 1 - 255

Path Parameters

id
string<uuid>
required

The retained instalment the desk closed.

Response

Created

collectionEndedAt
string<date-time>
required

RFC 3339 instant the declaration was recorded; the server clock dates it.

collectionEndedBy
string
required

Subject of the validated identity that declared it.

loanAccountId
string<uuid>
required

The contract.

requestId
string
required

X-Idempotency key the declaration was recorded under.

retainedInstallmentId
string<uuid>
required

Desk-closed instalment whose collection ended.