Skip to navigation

Get a Pix Automático recurrence

Live read from the settlement bank, including the status history.

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…).

Headers

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

Response

Recurrence
recurrenceIdstringOptionalformat: "uuid"
recurrenceIdentifierstringOptional

RR…/RN…, once assigned.

statusenumOptional
rejectionReasonstringOptional
journeyenumOptional
Allowed values:
frequencyenumOptional
Allowed values:
firstPaymentDatedateOptional
lastPaymentDatedateOptional
valuedoubleOptional
maximumValuedoubleOptional
payerMaximumValuedoubleOptional
Ceiling set by the payer when authorizing.
paymentRetrybooleanOptional
contractobjectOptional
payerobjectOptional
receiverobjectOptional
debtorobjectOptional
qrCodeIdstringOptional
requestedAtdatetimeOptional
requestExpirationdatetimeOptional
authorizedAtdatetimeOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional
historylist of objectsOptional

Errors

403
Forbidden Error
404
Not Found Error
502
Bad Gateway Error