Skip to main content

Create Instant-Billing Dynamic QR Code

POST 
/pix/deposits/qr-codes/dynamic/instant-billing

Generate a new instant-billing dynamic 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

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

    PIX Key.

    document_value numberrequired

    Value in R$ cents

    expiration_date date-time

    Expiration date to pay dynamic QR Code.

    summary string

    User friendly dynamic QR Code identifier.

    description stringrequired

    User defined payment description.

    payer_request string

    Payer request.

Responses​

The created dynamic QR Code returned successfully.

Schema
    id stringrequired

    Dynamic QR Code ID.

    key_id stringrequired

    Associated key ID.

    state stringrequired

    Possible values: [PENDING, READY, ERROR, PAID]

    Dynamic QR Code state.

    summary string

    User defined payment ID.

    description stringrequired

    User defined payment description.

    expiration_date date-time

    Expiration date to pay dynamic QR Code.

    created_at date-timerequired

    Dynamic QR Code created at.

Loading...