List All Automatic Pix Recurrences

GET 
/v1/pix/scheduled-payments/automatic-recurrences

Tag: api-baas-get-all-pix-automatic-recurrenceDescription: Retrieve a list of the user's automatic pix recurrences. Use optional filter parameters to refine your search.

Request

Query Parameters

page number

Default value: 1

Page number.

size number

Possible values: <= 100

Default value: 20

Page size. Max size is 100.

sort string

Possible values: [created_at]

Page sort attribute.

order string

Possible values: [asc, desc]

Default value: asc

Page order.

status string[]

Possible values: [PENDING, CREATED, FAILED, APPROVED, REJECTED, CANCELED, EXPIRED, FINISHED]

Recurrence status.

owner_document string

Owner (payer) document (CPF or CNPJ)

debtor_name string

Debtor name

contract_number string

Contract number (reference code)

tags string[]

Recurrence tags

created_at_start date-time

Recurrence created at start. Format: YYYY-MM-DD

created_at_end date-time

Recurrence created at end. Format: YYYY-MM-DD

frequency string

Possible values: [WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]

Recurrence frequency.

next_charge_due_date_start date-time

Next charge due date start. Format: YYYY-MM-DD

next_charge_due_date_end date-time

Next charge due date end. Format: YYYY-MM-DD

Header Parameters

x-wallet-uuid string

Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

nonce stringrequired

The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

x-lang string

Possible values: [pt-BR, en-US]

Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

x-product-uuid string

The product ID is a UUID (v4) used to identify the Z.ro product configuration.

x-product-target-user-uuid string

The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses

200

The recurrences returned successfully.

application/json

Schema

Schema

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
Automatic pix recurrence data
Array [
id stringrequired
Recurrence ID.
status stringrequired
Possible values: [PENDING, CREATED, FAILED, APPROVED, REJECTED, CANCELED, EXPIRED, FINISHED]
Recurrence status
state string
Possible values: [PENDING_CONFIRMED, CREATED_CONFIRMED, CREATED_FAILED, APPROVED_CONFIRMED, REJECTED_CONFIRMED, CANCELED_CONFIRMED, CANCELED_FAILED, EXPIRED_CONFIRMED, FINISHED_CONFIRMED]
Recurrence state
journey stringrequired
Possible values: [JOURNEY_1, JOURNEY_2, JOURNEY_3, JOURNEY_4]
Recurrence journey
frequency stringrequired
Possible values: [WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
Recurrence frequency
start_date YYYY-MM-DDrequired
Recurrence start date
end_date YYYY-MM-DD
Recurrence end date
value number
Recurrence value
floor_max_value number
Recurrence floor max value
beneficiary_ispb stringrequired
Recurrence beneficiary ISPB
beneficiary_document stringrequired
Recurrence beneficiary document
beneficiary_name stringrequired
Recurrence beneficiary name
owner_ispb string
Recurrence owner (payer) ISPB
owner_name string
Recurrence owner (payer) name
owner_person_type string
Possible values: [NATURAL_PERSON, LEGAL_PERSON]
Recurrence owner (payer) person type
owner_document string
Recurrence owner (payer) document
owner_bank_branch string
Recurrence owner (payer) bank branch
owner_bank_account string
Recurrence owner (payer) bank account
debtor_person_type string
Possible values: [NATURAL_PERSON, LEGAL_PERSON]
Recurrence debtor person type
debtor_document string
Recurrence debtor document
debtor_name string
Recurrence debtor name
contract_number stringrequired
Recurrence contract number
contract_description string
Recurrence contract description
tags string[]
Recurrence tags
request_expiration_date date-time
Recurrence request expiration date
cancellation_reason string
Possible values: [ACCOUNT_CANCELED, RECEIVER_COMPANY_CLOSURE, OWNER_DEATH, CONFIRMATION_ERROR, FRAUD_SUSPICION, RECURRENCE_ALREADY_CONFIRMED, RECEIVER_REQUEST, PAYER_REQUEST, RECEIVER_PSP_REQUEST]
Recurrence cancellation reason
next_charge_due_date date-time
Recurrence next charge due date
next_charge_value number
Recurrence next charge value
created_at date-timerequired
Recurrence creation date.
updated_at date-timerequired
Recurrence update date.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "id": "d1952c4b-9348-41ab-99a3-05b11459aded",
      "status": "APPROVED",
      "state": "APPROVED_CONFIRMED",
      "journey": "JOURNEY_1",
      "frequency": "MONTHLY",
      "start_date": "2025-04-15",
      "end_date": "2026-04-15",
      "value": 100,
      "floor_max_value": 50,
      "beneficiary_ispb": "7219",
      "beneficiary_document": "01234567890",
      "beneficiary_name": "John Doe",
      "owner_ispb": "7219",
      "owner_name": "John Doe",
      "owner_person_type": "NATURAL_PERSON",
      "owner_document": "02345678912",
      "owner_bank_branch": "0001",
      "owner_bank_account": "12345678",
      "debtor_person_type": "NATURAL_PERSON",
      "debtor_document": "03456789013",
      "debtor_name": "John Wick",
      "contract_number": "123456-7",
      "contract_description": "Gym monthly subscription",
      "tags": "[\"gym\", \"subscription\"]",
      "request_expiration_date": "2025-10-22T18:41:31.652Z",
      "cancellation_reason": "RECEIVER_REQUEST",
      "next_charge_due_date": "2025-10-22",
      "next_charge_value": 100,
      "created_at": "2025-10-22T18:41:31.652Z",
      "updated_at": "2025-10-22T18:41:31.652Z"
    }
  ]
}

400

If any required params are missing or has invalid format or type.

Loading...