Skip to main content

Create an Automatic Pix Charge

POST 
/v1/pix/scheduled-payments/automatic-charges
Tag: api-baas-create-pix-automatic-chargeDescription: Creates an automatic pix charge.

Request​

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.

Body

required
    value numberrequired

    Value.

    due_date date-timerequired

    Due date

    pix_automatic_recurrence_id stringrequired

    Pix Automatic Recurrence ID

Responses​

Charge successfully created.

Schema
    id stringrequired

    Charge ID.

    status stringrequired

    Possible values: [PENDING_WAITING, PENDING_CONFIRMED, CREATED, CREATED_FAILED, PAID, NOT_PAID, WAITING_CANCELLATION, CANCELED, CANCELED_FAILED]

    Charge status

Loading...