POST
/
v1
/
qrcodes
/
dynamic
Create dynamic QR code
curl --request POST \
  --url http://localhost:4011/v1/qrcodes/dynamic \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "IMMEDIATE",
  "key": "12345678901",
  "amount": 50,
  "recipientName": "João da Silva",
  "payer": {
    "document": "98765432100",
    "validate": true,
    "name": "Maria Santos"
  },
  "dueDate": "2024-12-31",
  "expirationTime": 3600,
  "city": "São Paulo",
  "zipCode": "01234567",
  "recipientConciliationId": "CONC123456789",
  "partnerId": "550e8400-e29b-41d4-a716-446655440001",
  "description": [
    {
      "name": "Invoice",
      "value": "INV-001"
    }
  ]
}'
{
  "qrCode": "00020101021226890014br.gov.bcb.Pix2567qrcod-dynamic.Pix.example.com/v2/cobv/9d36b84fc70b478fb95c12729b90ca255204000053039865802BR5913Joao da Silva6009Sao Paulo61080123456762070503***6304A9F2",
  "qrCodeId": "9d36b84fc70b478fb95c12729b90ca25",
  "expirationDate": "2024-09-26T13:30:00.000Z"
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

Body

application/json
​
type
enum<string>
required

Dynamic QR code type

Available options:
IMMEDIATE,
DUE_DATE
Example:

"IMMEDIATE"

​
key
string
required

Pix key for the QR code

Example:

"12345678901"

​
amount
number
required

Payment amount

Example:

50

​
recipientName
string
required

Name of payment recipient

Example:

"João da Silva"

​
recipientConciliationId
string
required

Recipient conciliation identifier

Example:

"CONC123456789"

​
payer
object
​
dueDate
string<date>

Payment due date (if applicable)

Example:

"2024-12-31"

​
expirationTime
integer

QR code expiration time in seconds

Example:

3600

​
city
string

Recipient city

Example:

"São Paulo"

​
zipCode
string

Recipient ZIP code

Example:

"01234567"

​
partnerId
string<uuid>

Partner identifier

Example:

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

​
description
object[]

Response

Dynamic QR code created successfully

​
qrCode
string

Generated dynamic QR code payload

Example:

"00020101021226890014br.gov.bcb.Pix2567qrcod-dynamic.Pix.example.com/v2/cobv/9d36b84fc70b478fb95c12729b90ca255204000053039865802BR5913Joao da Silva6009Sao Paulo61080123456762070503***6304A9F2"

​
qrCodeId
string

Unique QR code identifier

Example:

"9d36b84fc70b478fb95c12729b90ca25"

​
expirationDate
string<date-time>

QR code expiration timestamp

Example:

"2024-09-26T13:30:00.000Z"