Skip to navigation

Get the retry dates of a failed settlement

After pix.automatic.settlement.failed, returns the dates the scheme accepts for a retry, the remaining attempts and the window end.

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.

Response

Retry window
recurrenceIdstringOptionalformat: "uuid"
recurrenceIdentifierstringOptional
settlementIdstringOptional
originalDueDatedateOptional
suggestedDateslist of datesOptional
maxRetryDatesintegerOptional
maxCalendarDaysintegerOptional
remainingAttemptsintegerOptional
windowEnddateOptional
nextCycleStartsOndateOptional

Errors

403
Forbidden Error
404
Not Found Error
502
Bad Gateway Error