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
accountId
Account identifier.
recurrenceId
Recurrence UUID (recurrenceId) or its Pix scheme identifier (RR…/RN…).
Headers
X-Tenant-Id
Tenant context used for authorization and routing.
Response
Recurrence
recurrenceId
recurrenceIdentifier
RR…/RN…, once assigned.
status
rejectionReason
journey
Allowed values:
frequency
Allowed values:
firstPaymentDate
lastPaymentDate
value
maximumValue
payerMaximumValue
Ceiling set by the payer when authorizing.
paymentRetry
contract
payer
receiver
debtor
qrCodeId
requestedAt
requestExpiration
createdAt
updatedAt
history
Errors
403
Forbidden Error
404
Not Found Error
502
Bad Gateway Error