POST
/
v1
/
qrcodes
/
decode
Decode QR code
curl --request POST \
  --url http://localhost:4011/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": "DYNAMIC",
  "endToEndId": "E1234567820250926120000002",
  "amount": 50,
  "key": "12345678901",
  "description": "Payment for services",
  "txId": "TXN789012345",
  "dueDate": "2024-12-31T23:59:59.000Z",
  "payee": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "bankAccountType": 0,
    "accountNumber": "123456",
    "accountDigit": "0",
    "key": "12345678901",
    "bankName": "Banco Example"
  }
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

Body

application/json
​
qrCode
string
required

QR code payload to decode

Example:

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

​
accountId
string<uuid>
required

Account ID requesting the decode

Example:

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

Response

QR code decoded successfully

​
qrCodeType
enum<string>

Type of QR code

Available options:
DYNAMIC,
STATIC
Example:

"DYNAMIC"

​
endToEndId
string

End-to-end transaction identifier

Example:

"E1234567820250926120000002"

​
amount
number

Payment amount

Example:

50

​
key
string

Pix key from QR code

Example:

"12345678901"

​
description
string

Payment description

Example:

"Payment for services"

​
txId
string

Transaction identifier

Example:

"TXN789012345"

​
dueDate
string<date-time>

Payment due date (if applicable)

Example:

"2024-12-31T23:59:59.000Z"

​
payee
object