Skip to main content

Create Dynamic Due Date QR Code

POST 
/v1/pix/deposits/qr-codes/dynamic/due-date

Generate a new dynamic due date QR Code with a specific due date 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-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.

Body

required
    key stringrequired

    PIX Key.

    document_value numberrequired

    Value in R$ cents

    due_date daterequired

    Document due date.

    expiration_date date

    Expiration date to pay dynamic QR Code. The default value is the due date.

    summary string

    User friendly dynamic QR Code identifier.

    description stringrequired

    User defined payment description.

    payer_city string

    Payer city (IBGE city code).

    payer_person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Person type:

    • NATURAL_PERSON.
    • LEGAL_PERSON.

    payer_document stringrequired

    Payer document number.

    payer_name stringrequired

    Payer name.

    payer_email string

    Payer email.

    payer_phone string

    Payer phone.

    payer_address string

    Payer address.

    payer_request string

    Payer request.

Responses​

The created dynamic due date 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.

    due_date date-timerequired

    Due date to pay dynamic QR Code.

    expiration_date date-timerequired

    Expiration date to pay dynamic QR Code.

    created_at date-timerequired

    Dynamic QR Code created at.

Loading...