Skip to main content
POST
Retry accrual run items

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 moves money, and without a key a retry cannot be told apart from a second instruction.

Parâmetros de caminho

id
string<uuid>
obrigatório

Accrual run identifier.

Corpo

application/json
itemIds
string<uuid>[] | null
obrigatório

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.

Required array length: 1 - 500 elements

Resposta

OK

id
string
obrigatório

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.

Exemplo:

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

itemIds
string[] | null
obrigatório

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
obrigatório

UUID of the accrual run whose recognitions were retried.

Exemplo:

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

status
string
obrigatório

"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.

Exemplo:

"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.