List Pix Automático recurrences
Live list from the settlement bank. Without startDate/endDate, the
last 30 days (America/Sao_Paulo). endDate is exclusive. page starts at 1.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
accountId
Account identifier.
Headers
X-Tenant-Id
Tenant context used for authorization and routing.
Query parameters
startDate
Start of the creation period (YYYY-MM-DD). Defaults to 30 days before endDate.
endDate
End of the creation period (YYYY-MM-DD), exclusive. Defaults to tomorrow.
status
Filter by recurrence status.
journey
Filter by how the recurrence was created.
Allowed values:
frequency
Filter by charge frequency.
Allowed values:
payerTaxNumber
Payer CPF/CNPJ (digits only).
debtorTaxNumber
Debtor CPF/CNPJ (digits only).
page
Page number starting at 1.
pageSize
Items per page (1–100).
order
Sort by creation date.
Allowed values:
Response
Page of recurrences
items
page
pageSize
totalItems
totalPages
hasNext
Errors
400
Bad Request Error
403
Forbidden Error
502
Bad Gateway Error