Skip to navigation

Request settlement retries

Schedules up to 3 retries on dates returned by retry-dates. Only for recurrences created with paymentRetry: true. Each retry is a new scheduling with purpose: retry. Financial operation: requires an M2M credential with pix.automatic.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.
recurrenceIdstringRequired

Recurrence UUID (recurrenceId) or its Pix scheme identifier (RR…/RN…).

settlementIdstringRequired

Settlement id (settlement.settlementId of the scheduling, or settlementId of the webhook).

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

Request

This endpoint expects an object.
dateslist of datesRequired

Response

Retries scheduled
recurrenceIdstringOptionalformat: "uuid"
recurrenceIdentifierstringOptional
settlementIdstringOptional
retrieslist of objectsOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
502
Bad Gateway Error