Retry accrual run items

Re-sends to the ledger the recognitions of a run that it has not acknowledged. Of the items selected, only those still unposted are re-sent; an acknowledged recognition is never sent twice, and each re-send carries the same deterministic key as the original attempt, so a recognition already in the ledger is deduplicated there rather than booked again. The response lists the items actually re-sent, which may be fewer than those asked for; whatever it could not send is listed in unpostableItems with a reason. Status is “queued” when at least one recognition went out, “nothing_to_retry” only when the ledger had already acknowledged everything selected, and “blocked” when unacknowledged recognitions exist and none of them could be re-sent. An id that belongs to no item of this run is refused with 422 (LENDER-0407) before any of that is decided, and nothing is re-sent — so “nothing_to_retry” can only ever mean the ledger has everything selected. That refusal names AT MOST TEN unknown ids, one per errors[] member at body.itemIds; the detail always states how many there are in total, so a selection with more than ten unknown ids reports the true count and lists the first ten. Safe to repeat: pressing retry twice enqueues one posting per recognition.

POST /api/v1/accrual-runs/{id}/retry

Retry accrual run items

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/accrual-runs/{id}/retry \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "itemIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

200

{
  "id": "550e8400-e29b-41d4-a716-446655440005",
  "itemIds": [
    "<string>"
  ],
  "retriedRunId": "550e8400-e29b-41d4-a716-446655440005",
  "status": "queued",
  "unpostableItems": [
    {
      "itemId": "550e8400-e29b-41d4-a716-446655440006",
      "reason": "quarantined"
    }
  ]
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string · requerido

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

Parámetros de ruta

id · string<uuid> · requerido

Accrual run identifier.

Cuerpo

application/json

itemIds · string<uuid>[] | null · requerido

Accrual run item identifiers to retry. Selecting an item the ledger has already acknowledged is not an error — it is skipped, and the response says which items were actually re-sent. An id that is not an item of this run IS an error: the whole request is refused with 422 and the unknown ids are named.

Required array length: 1 - 500 elements

Respuesta

200

application/json

OK

id · string · requerido

UUID of the accrual run this retry acted on. A retry is a new attempt on that run, not a new run, so it equals retriedRunId.

Ejemplo:

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

itemIds · string[] | null · requerido

UUIDs of the accrual run items actually re-sent. This is never an echo of the request: items already acknowledged by the ledger are excluded, and so is any item this retry could not send — those appear in unpostableItems.

retriedRunId · string · requerido

UUID of the accrual run whose recognitions were retried.

Ejemplo:

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

status · string · requerido

"queued" when at least one recognition was re-sent and is waiting for the ledger; "nothing_to_retry" when the ledger had already acknowledged every selected recognition, which is a success and not an error; "blocked" when recognitions the ledger has NOT acknowledged exist and none of them could be re-sent — money is still outside the ledger and unpostableItems says why.

Ejemplo:

"queued"

unpostableItems · object[] | null

Accrual run items the ledger has not acknowledged and this retry could NOT send, with the reason for each. A non-empty list means money is still outside the ledger and pressing retry again will not change it on its own.

Show child attributes