Skip to navigation

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

accountIdstringRequired
Account identifier.

Headers

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

Query parameters

startDatedateOptional

Start of the creation period (YYYY-MM-DD). Defaults to 30 days before endDate.

endDatedateOptional

End of the creation period (YYYY-MM-DD), exclusive. Defaults to tomorrow.

statusenumOptional
Filter by recurrence status.
journeyenumOptional
Filter by how the recurrence was created.
Allowed values:
frequencyenumOptional
Filter by charge frequency.
Allowed values:
payerTaxNumberstringOptional

Payer CPF/CNPJ (digits only).

debtorTaxNumberstringOptional

Debtor CPF/CNPJ (digits only).

pageintegerOptional>=1Defaults to 1
Page number starting at 1.
pageSizeintegerOptional1-100Defaults to 50

Items per page (1–100).

orderenumOptional
Sort by creation date.
Allowed values:

Response

Page of recurrences
itemslist of objectsOptional
pageintegerOptional
pageSizeintegerOptional
totalItemsintegerOptional
totalPagesintegerOptional
hasNextbooleanOptional

Errors

400
Bad Request Error
403
Forbidden Error
502
Bad Gateway Error