POST
/
v1
/
qrcodes
/
static
Create static QR code
curl --request POST \
  --url http://localhost:4011/v1/qrcodes/static \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "12345678901",
  "amount": 100,
  "recipientName": "João da Silva",
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "txId": "TXN123456789",
  "description": "Payment for services",
  "externalId": "EXT123456789"
}'
{
  "qrCode": "00020126580014br.gov.bcb.Pix0136123e4567-e12b-12d1-a456-426655440000520400005303986540510.005802BR5913TESTE ACCOUNT6008BRASILIA62070503***630445C8"
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

Body

application/json
​
key
string
required

Pix key for the QR code

Example:

"12345678901"

​
amount
number
required

Payment amount

Example:

100

​
recipientName
string
required

Name of payment recipient

Example:

"João da Silva"

​
accountId
string<uuid>
required

Account ID generating the QR code

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
txId
string

Transaction identifier

Example:

"TXN123456789"

​
description
string

Payment description

Example:

"Payment for services"

​
externalId
string

External reference identifier

Example:

"EXT123456789"

Response

Static QR code created successfully

​
qrCode
string

Generated QR code payload

Example:

"00020126580014br.gov.bcb.Pix0136123e4567-e12b-12d1-a456-426655440000520400005303986540510.005802BR5913TESTE ACCOUNT6008BRASILIA62070503***630445C8"