Skip to main content

Create Dynamic Due Date QR Code

POST 
/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 requisition. All requisitions must have an identifier.

Body

required
    key stringrequired

    PIX Key.

    document_value numberrequired

    Value in R$ cents

    due_date date-timerequired

    Document due date.

    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_city string

    Payer city (IBGE city code).

    payer_person_type objectrequired

    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]

    Dynamic QR Code state.

    summary string

    User defined payment ID.

    description stringrequired

    User defined payment description.

    due_date date-time

    Due date to pay dynamic QR Code.

    expiration_date date-time

    Expiration date to pay dynamic QR Code.

    created_at date-timerequired

    Dynamic QR Code created at.

Loading...