Skip to main content

Create Static QR Code

POST 
/v1/pix/deposits/qr-codes/static

Generate a new static QR Code for the user.

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.

    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
    key stringrequired

    PIX Key.

    value number

    Value in R$ cents.

    summary string

    User friendly static QR Code identifier.

    description string

    User defined payment description.

    expiration_date date-time

    Expiration date to pay static QR Code. Max date is 3 months ahead.

    payable_many_times boolean

    If it is true, static QR Code can be paid many times. When it is false, expiration date is required.

    merchant_id string

    User defined payment merchant ID.

Responses​

The static QR Code returned successfully.

Schema
    id stringrequired

    Static QR Code ID.

    txid stringrequired

    PIX txID.

    emv string

    EMV code.

    key_id stringrequired

    Associated key UUID.

    value number

    Value in R$ cents.

    summary string

    User defined payment ID.

    description string

    User defined payment description.

    expiration_date date-time

    Expiration date to pay qrCode. Max date is 3 months ahead.

    payable_many_times boolean

    If it is true, QrCode can be paid many times. When it is false, expiration date is required.

    state stringrequired

    Possible values: [PENDING, READY, DELETING, DELETED, ERROR]

    Static QR Code state.

    created_at date-timerequired

    Static QR Code created at.

Loading...