Skip to main content

Create Pix Recurrence

POST 

/pix/scheduled-payments/recurrence

Tag: api-paas-post-pix-recurrenceDescription: Initiate a new pix recurrence by providing the required information in the request body and executing the request.

Request

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    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.

Body

required
    frequency objectrequired

    Pix recurrence frequency.

    day_of_the_week string

    Possible values: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

    Day of the week in case of weekly frequency.

    day_of_the_month number

    Day of the month in case of monthly frequency.

    end_date date-timerequired

    End date of the recurrence.

    payment_id objectrequired

    First payment id.

    first_payment_date date-timerequired

    First payment date.

Responses

The recurrence returned successfully.

Schema
    id stringrequired

    Recurrence ID.

    state stringrequired

    Possible values: [ACTIVE, DEACTIVATED]

    Recurrence state.

    created_at date-timerequired

    Recurrence created at.

Authorization: http

name: bearertype: httpscheme: bearerbearerFormat: JWT
curl -L -X POST 'https://docs.zrobank.io/pix/scheduled-payments/recurrence' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"frequency": "MONTHLY",
"day_of_the_week": null,
"day_of_the_month": 1,
"end_date": "2025-06-03",
"payment_id": "0a5c6a43-d7d4-4635-9075-c9a5aaf24a44",
"first_payment_date": "2025-06-03"
}'
Request Collapse all
Auth
Parameters
— headerrequired
— headerrequired
— header
— header
— header
— header
Body required
{
  "frequency": "MONTHLY",
  "day_of_the_week": null,
  "day_of_the_month": 1,
  "end_date": "2025-06-03",
  "payment_id": "0a5c6a43-d7d4-4635-9075-c9a5aaf24a44",
  "first_payment_date": "2025-06-03"
}
ResponseClear

Click the Send API Request button above and see the response here!