Skip to main content

Create Decoded QR Code

GET 
/v2/pix/payments/decode

Generate a new Decoded QR Code ID to facilitate pix payments by QR code. Provide the QR Code's information in the request body and execute to obtain its ID (decoded_qr_code_id), which is required for creating pix payments using a QR Code.

Request​

Query Parameters

    emv stringrequired

    QR Emv code.

    paymentDate date-time

    Payment estimated date.

Header Parameters

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    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.

Responses​

QR code decoded successfully.

Schema
    qr_code object
    id stringrequired

    Unique decoded UUID.

    key stringrequired

    Payment link's key.

    txid stringrequired

    Payment txid identifier.

    document_value numberrequired

    Document value.

    recipient_name stringrequired

    Recipient name.

    recipient_person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Recipient person type.

    recipient_document stringrequired

    Recipient document.

    recipient_bank_name stringrequired

    Recipient bank name.

    recipient_bank_ispb stringrequired

    Recipient bank ispb.

    payment_value number

    Payment value.

    expiration_date date-time

    Expiration date.

    payer_person_type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Payer person type value.

    payer_document string

    Payer document.

    payer_name string

    Payer name.

    due_date date-time

    Due date.

    interest_value number

    Interest value.

    fine_value number

    Fine value.

    deduction_value number

    Deduction value.

    discount_value number

    Discount value.

    state stringrequired

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

    QR code state.

    created_at date-timerequired

    Created at.

    change_value number

    Change value.

    additional_infos string[]

    Additional infos object. It is used on QRCODE DYNAMIC.

    additional_info string

    Additional info. It is used on QRCODE STATIC.

    type stringrequired

    Possible values: [QR_CODE_STATIC_INSTANT_PAYMENT, QR_CODE_STATIC_WITHDRAWAL, QR_CODE_DYNAMIC_DUE_DATE, QR_CODE_DYNAMIC_WITHDRAWAL, QR_CODE_DYNAMIC_CHANGE, QR_CODE_DYNAMIC_INSTANT_PAYMENT, QR_CODE_COMPOSITE_PAYMENT]

    QR code type.

    payment_type stringrequired

    Possible values: [ACCOUNT, KEY, QR_CODE, QR_CODE_STATIC_INSTANT, QR_CODE_STATIC_WITHDRAWAL, QR_CODE_DYNAMIC_DUE_DATE, QR_CODE_DYNAMIC_WITHDRAWAL, QR_CODE_DYNAMIC_CHANGE, QR_CODE_DYNAMIC_INSTANT]

    Payment Type.

    allow_update boolean

    Is document value updating allowed?

    withdraw_value number

    Withdrawal value.

    composite_qr_code object
    id stringrequired

    Unique decoded composite qr code UUID.

    journey stringrequired

    Possible values: [JOURNEY_1, JOURNEY_2, JOURNEY_3, JOURNEY_4]

    Composite qr code journey.

    recurrence_id stringrequired

    Composite qr code journey.

    frequency stringrequired

    Possible values: [WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]

    Recurrence frequency.

    start_date date-timerequired

    Recurrence start date.

    end_date date-time

    Recurrence end date.

    value number

    Recurrence value.

    floor_max_value number

    Recurrence floor max value.

    beneficiary_ispb stringrequired

    Recurrence beneficiary ISPB.

    beneficiary_document stringrequired

    Recurrence beneficiary document.

    beneficiary_name stringrequired

    Recurrence beneficiary name.

    debtor_document stringrequired

    Recipient debtor document.

    debtor_name stringrequired

    Recurrence debtor name.

    debtor_person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Recurrence debtor person type.

    contract_number stringrequired

    Recurrence contract number.

    contract_description string

    Recurrence contract description.

    state stringrequired

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

    Composite QR code state.

    retry stringrequired

    Possible values: [NOT_ALLOWED, ALLOWED]

    Recurrency retry.

    history object[]

    Recurrence history.

    receiver_psp_url string

    Recurrence receiver psp url.

    created_at date-timerequired

    Created at.

Loading...