Skip to main content
POST
/
v1
/
qrcodes
/
decode
Decode QR code
curl --request POST \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/qrcodes/decode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "qrCode": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000",
  "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d"
}'
{
  "qrCodeType": "STATIC",
  "endToEndId": "E1234567820230615123456789012345",
  "amount": 100.5,
  "key": "+5511987654321",
  "description": "Payment for services",
  "txId": "tx_abc123",
  "payee": {
    "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "bankAccountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "key": "+5511987654321",
    "keyType": 3
  }
}

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
​
qrCode
string
required

Pix QR code string to decode.

Example:

"00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000"

​
accountId
string<uuid>
required

Account identifier requesting the decode.

Example:

"01989f9e-6508-79f8-9540-835be49fbd0d"

Response

QR code decoded successfully

​
qrCodeType
enum<string>
required

Pix QR code type. String values indicating the behavior and reusability of the QR code.

Valid values:

  • STATIC = Reusable QR code with fixed amount (can be scanned multiple times)
  • DYNAMIC = Single-use QR code (with expiration time and advanced validation)
Available options:
STATIC,
DYNAMIC
Example:

"STATIC"

​
endToEndId
string
required

End-to-end transaction identifier.

Example:

"E1234567820230615123456789012345"

​
amount
number
required

Payment amount.

Example:

100.5

​
key
string
required

Pix key of the recipient.

Example:

"+5511987654321"

​
description
string
required

Payment description.

Example:

"Payment for services"

​
txId
string
required

Unique transaction identifier.

Example:

"tx_abc123"

​
payee
object
required

Bank account information.