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

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires 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.

Loading...