Decode QR code

Decode and extract payment information from a Pix QR code string. Validates format, structure, and expiration status.

POST /v1/qrcodes/decode

Decode QR code

cURL

curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/qrcodes/decode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "qrCode": "00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081",
  "accountId": "019c96a0-0a98-7287-9a31-786e0809c769"
}
'

200

Example

{
  "qrCodeType": "STATIC",
  "endToEndId": "E1234567820230615123456789012345",
  "amount": 100.5,
  "key": "[phone]",
  "description": "Payment for services",
  "txId": "tx_abc123",
  "payee": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "accountId": "019c96a0-0a98-7287-9a31-786e0809c769",
    "bankAccountType": 0,
    "key": "[phone]",
    "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.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081"

accountId · string<uuid> · required

Account identifier requesting the decode.

Example:

"019c96a0-0a98-7287-9a31-786e0809c769"

Response

200

application/json

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<double> · required

Payment amount.

Example:

100.5

key · string · required

Pix key of the recipient.

Example:

"[phone]"

description · string · required

Payment description.

Example:

"Payment for services"

txId · string · required

Unique transaction identifier.

Example:

"tx_abc123"

payee · object · required

Bank account information.

Show child attributes