Record a guarantee execution receipt

Books what one external execution of a guarantee brought in, split by the operator across its linked contracts, all or nothing. Each allocation pays what is due on its contract at receivedAt as a repayment, or as a credit-loss recovery on a written-off contract; what passes the part due prepays the contract’s debt with the prepayment discount, and only what passes the whole debt stays as the borrower’s held cash, a balance to return through the refund desk. A contract left with nothing to pay leaves the book. Redelivering the same X-Idempotency key with the same split replays the receipt and moves nothing; the same key with another split, amount or money day is refused (LENDER-1709).

POST /api/v1/br/guarantees/{id}/execution-receipts

Record a guarantee execution receipt

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/br/guarantees/{id}/execution-receipts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allocations": [
    {
      "amount": "12500.00",
      "loanApplicationId": "<string>"
    }
  ],
  "receivedAt": "2027-03-10T13:00:00Z"
}
'

201

{
  "guaranteeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "receipts": [
    {
      "amount": "12500.00",
      "appliedAs": "repayment",
      "heldAmount": "0.00",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "loanApplicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prepaidAmount": "0.00"
    }
  ],
  "receivedAt": "2023-11-07T05:31:56Z",
  "recordedAt": "2023-11-07T05:31:56Z",
  "recordedBy": "<string>",
  "requestId": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string

Idempotency key of the receipt: 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-1712). X-Request-ID is never read as the key.

Parámetros de ruta

id · string · requerido

The executed guarantee (a UUID).

Cuerpo

application/json

allocations · object[] | null · requerido

1 to 50 allocations, one per contract.

Show child attributes

receivedAt · string

RFC 3339 instant the money arrived; its São Paulo day dates the entry. Required (LENDER-1712 when blank), so a resend with the same key replays.

Ejemplo:

"2027-03-10T13:00:00Z"

Respuesta

201

application/json

Created

guaranteeId · string<uuid> · requerido

The executed guarantee.

receipts · object[] | null · requerido

One per contract, ordered by contract.

Show child attributes

receivedAt · string<date-time> · requerido

RFC 3339 instant the money arrived.

recordedAt · string<date-time> · requerido

RFC 3339 instant the receipt was recorded.

recordedBy · string · requerido

Subject that recorded it.

requestId · string · requerido

X-Idempotency key the receipt was recorded under.