Create Static QR Code

POST 
https://api-baas-hml.zrobank.xyz/v1/pix/deposits/qr-codes/static

Generate a new static 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.

value number

Value in R$ cents.

summary string

User friendly static QR Code identifier.

description string

User defined payment description.

expiration_date date-time

Expiration date to pay static QR Code. Max date is 3 months ahead.

payable_many_times boolean

If it is true, static QR Code can be paid many times. When it is false, expiration date is required.

merchant_id string

User defined payment merchant ID.

Responses

201

The static QR Code returned successfully.

application/json

Schema

Schema

id stringrequired

Static QR Code ID.

txid stringrequired

PIX txID.

emv string

EMV code.

key_id stringrequired

Associated key UUID.

value number

Value in R$ cents.

summary string

User defined payment ID.

description string

User defined payment description.

expiration_date date-time

Expiration date to pay qrCode. Max date is 3 months ahead.

payable_many_times boolean

If it is true, QrCode can be paid many times. When it is false, expiration date is required.

state stringrequired

Possible values: [PENDING, READY, DELETING, DELETED, ERROR]

Static QR Code state.

created_at date-timerequired

Static QR Code created at.

Example (from schema)

{
  "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "txid": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "emv": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "key_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "value": 1299,
  "summary": "party-payment",
  "description": "User defined description",
  "expiration_date": "2025-07-25T01:07:27.617Z",
  "payable_many_times": true,
  "state": "PENDING",
  "created_at": "2025-07-25T01:07:27.617Z"
}

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://api-baas-hml.zrobank.xyz/v1/pix/deposits/qr-codes/static' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "key": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "value": 2300,
  "summary": "party-payment",
  "description": "User defined description",
  "expiration_date": "2025-07-25T01:07:27.616Z",
  "payable_many_times": true,
  "merchant_id": "User defined merchant ID"
}'

Request Collapse all

Base URL

https://api-baas-hml.zrobank.xyz

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",
  "value": 2300,
  "summary": "party-payment",
  "description": "User defined description",
  "expiration_date": "2025-07-25T01:07:27.616Z",
  "payable_many_times": true,
  "merchant_id": "User defined merchant ID"
}

ResponseClear

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