Skip to main content

Get Static QR Code by ID

GET 
/pix/deposits/qr-codes/static/:id

Retrieve a specific static QR Code associated with the user by its unique identifier.

Request​

Path Parameters

    id stringrequired

    Static QR Code ID.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    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.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Responses​

Static QR Code found.

Schema
    id stringrequired

    Static QR Code ID.

    txid stringrequired

    PIX txID.

    emv string

    EMV code.

    key_id stringrequired

    Associated key ID.

    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 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.

    state stringrequired

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

    Static QR Code state.

    created_at date-timerequired

    Static QR Code created at.

Loading...