Create Instant-Billing Dynamic QR Code

POST 
/pix/deposits/qr-codes/dynamic/instant-billing

Generate a new instant-billing dynamic QR Code 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-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.

application/json

Body

required

key stringrequired

PIX Key.

document_value numberrequired

Value in R$ cents

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

Payer request.

Responses

201

The created dynamic QR Code returned successfully.

application/json

Schema

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.

expiration_date date-time

Expiration date to pay dynamic QR Code.

created_at date-timerequired

Dynamic QR Code created at.

Example (from schema)

{
  "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "key_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "state": "PENDING",
  "summary": "party-payment",
  "description": "The party payment.",
  "expiration_date": "2025-05-11T06:09:43.278Z",
  "created_at": "2025-05-07T20:37:54.302Z"
}

400

If any required params are missing or has invalid format or type.

401

User authentication failed.

422

If any required params are missing or has invalid format or type.

Authorization: http

name: bearertype: httpscheme: bearerbearerFormat: JWT

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://docs.zrobank.io/pix/deposits/qr-codes/dynamic/instant-billing' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "key": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "document_value": 2300,
  "expiration_date": "2025-05-07",
  "summary": "party-payment",
  "description": "Dynamic QR Code to receive payment.",
  "payer_request": "Send receipt to my email."
}'

Request Collapse all

Auth

Bearer Token

Parameters

x-transaction-uuid — headerrequired

nonce — headerrequired

x-lang — header

---pt-BRen-US

x-product-uuid — header

x-product-target-user-uuid — header

Body required

{
  "key": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "document_value": 2300,
  "expiration_date": "2025-05-07",
  "summary": "party-payment",
  "description": "Dynamic QR Code to receive payment.",
  "payer_request": "Send receipt to my email."
}

ResponseClear

Click the Send API Request button above and see the response here!