Skip to main content
POST
/
v1
/
qrcodes
/
dynamic
Create dynamic QR code
curl --request POST \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/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": "00020101021226850014br.gov.bcb.pix2563qrcode-h.jdpix.com.br/v2/cobv/9d36b84fc70b478fb95c12729b90ca255204000053039865802BR5913Merchant Name6009Sao Paulo62070503***63042C43"
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Body

application/json
​
type
enum<string>
required

Specifies the QR Code type. For IMMEDIATE, this indicates a single-use QR Code generated for instant Pix payments with a predefined amount and expiration time.

Available options:
IMMEDIATE
Example:

"IMMEDIATE"

​
key
string
required

Pix key of the recipient.

Example:

"12345678901"

​
amount
number
required

Amount for the dynamic QR code.

Example:

50

​
recipientName
string
required

Name of the recipient (payee).

Example:

"João da Silva"

​
payer
object
required

Payer information.

​
dueDate
string<date>
required

Due date for the payment (YYYY-MM-DD).

Example:

"2024-12-31"

​
expirationTime
integer
required

Expiration time in seconds after which the QR code becomes invalid.

Example:

3600

​
city
string
required

City of the recipient.

Example:

"São Paulo"

​
zipCode
string
required

ZIP code of the recipient (8 digits).

Example:

"01234567"

​
recipientConciliationId
string
required

Identifier for conciliation by the recipient.

Example:

"CONC123456789"

​
partnerId
string<uuid>
required

Identifier for the partner system.

Example:

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

​
description
object[]
required

List of descriptions for the payment.

Response

Dynamic QR code created successfully

​
qrCode
string
required

Generated Pix QR code string.

Example:

"00020101021226850014br.gov.bcb.pix2563qrcode-h.jdpix.com.br/v2/cobv/9d36b84fc70b478fb95c12729b90ca255204000053039865802BR5913Merchant Name6009Sao Paulo62070503***63042C43"