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
QR Emv code.
Payment estimated date.
Header Parameters
Sender Wallet UUID (if empty, your default Wallet UUID will be settled)
The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.
The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.
Possible values: [pt-BR
, en-US
]
Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.
The product ID is a UUID (v4) used to identify the Z.ro product configuration.
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
- 200
- 400
- 401
- 422
QR code decoded successfully.
- application/json
- Schema
- Example (from schema)
Schema
qr_code object
Unique decoded UUID.
Payment link's key.
Payment txid identifier.
Document value.
Recipient name.
Possible values: [NATURAL_PERSON
, LEGAL_PERSON
]
Recipient person type.
Recipient document.
Recipient bank name.
Recipient bank ispb.
Payment value.
Expiration date.
Possible values: [NATURAL_PERSON
, LEGAL_PERSON
]
Payer person type value.
Payer document.
Payer name.
Due date.
Interest value.
Fine value.
Deduction value.
Discount value.
Possible values: [ERROR
, PENDING
, READY
, CANCELED
]
QR code state.
Created at.
Change value.
Additional infos object. It is used on QRCODE DYNAMIC.
Additional info. It is used on QRCODE STATIC.
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.
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.
Is document value updating allowed?
Withdrawal value.
composite_qr_code object
Unique decoded composite qr code UUID.
Possible values: [JOURNEY_1
, JOURNEY_2
, JOURNEY_3
, JOURNEY_4
]
Composite qr code journey.
Composite qr code journey.
Possible values: [WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
Recurrence frequency.
Recurrence start date.
Recurrence end date.
Recurrence value.
Recurrence floor max value.
Recurrence beneficiary ISPB.
Recurrence beneficiary document.
Recurrence beneficiary name.
Recipient debtor document.
Recurrence debtor name.
Possible values: [NATURAL_PERSON
, LEGAL_PERSON
]
Recurrence debtor person type.
Recurrence contract number.
Recurrence contract description.
Possible values: [ERROR
, PENDING
, READY
, CANCELED
]
Composite QR code state.
Possible values: [NOT_ALLOWED
, ALLOWED
]
Recurrency retry.
Recurrence history.
Recurrence receiver psp url.
Created at.
{
"qr_code": {
"id": "d5e0bec8-8695-4557-b0dd-021788cd83ef",
"key": "string",
"txid": "string",
"document_value": 1299,
"recipient_name": "string",
"recipient_person_type": "LEGAL_PERSON",
"recipient_document": "***456789**",
"recipient_bank_name": "string",
"recipient_bank_ispb": "string",
"payment_value": 1299,
"expiration_date": "2025-07-08T15:20:12.004Z",
"payer_person_type": "LEGAL_PERSON",
"payer_document": "***456789**",
"payer_name": "string",
"due_date": "2025-07-08T15:20:12.004Z",
"interest_value": 1299,
"fine_value": 1299,
"deduction_value": 1299,
"discount_value": 1299,
"state": "PENDING",
"created_at": "2025-07-08T15:20:12.004Z",
"change_value": 1299,
"additional_infos": [
{
"name": "Juros",
"value": "10%"
}
],
"additional_info": "string",
"type": "QR_CODE_STATIC_WITHDRAWAL",
"payment_type": "QR_CODE_DYNAMIC_INSTANT",
"allow_update": true,
"withdraw_value": 1299
},
"composite_qr_code": {
"id": "d5e0bec8-8695-4557-b0dd-021788cd83ef",
"journey": "JOURNEY_2",
"recurrence_id": "d5e0bec8-8695-4557-b0dd-021788cd83ef",
"frequency": "WEEKLY",
"start_date": "2025-07-08",
"end_date": "2025-07-08",
"value": 1000,
"floor_max_value": 1000,
"beneficiary_ispb": "31432132",
"beneficiary_document": "12345678901",
"beneficiary_name": "John Doe",
"debtor_document": "12345678901",
"debtor_name": "John Doe",
"debtor_person_type": "NATURAL_PERSON",
"contract_number": 1235434534,
"contract_description": "Recurrence payment for any company.",
"state": "PENDING",
"retry": "ALLOWED",
"history": [
{}
],
"receiver_psp_url": "test.com/TEST/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8=",
"created_at": "2025-07-08T15:20:12.004Z"
}
}
If any required params are missing or has invalid format or type.
User authentication failed.
If any required params are missing or has invalid format or type.