List recurrences

Lists the recurring Pix transfers configured in the account, paginated.

Use this operation to find Recurring Pix transfers when the recurrence ID is not known, or to query recurrences according to the available filters. To retrieve a specific recurrence by ID, use Retrieve a single recurrence.

This resource belongs to the Recurring Pix flow, in which periodic Pix transfers are scheduled, and not to the Automatic Pix flow, which is based on recurring payments with prior authorization from the payer.

Related content

Guides

Error Library

Query Params
integer

List starting element

integer
≤ 100

Number of list elements (max: 100)

string
enum

Filter by recurrence status

Allowed:
number

Filter by recurrence value

string

Filter by receiver name

Responses

403

Forbidden. Occurs when the request body is filled, GET method calls must have an empty body.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json