Skip to main content
POST
Decode a PIX QR code via its payload URL

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
accountId
string
required

The CRM account id of the scanning payer (sources the PI-PayerID document).

Example:

"acc-123"

payloadUrl
string
required

The payee-published JWS payload URL to decode (urlPayloadJson; schema-less).

Example:

"example.com/pix/8b3da2f3"

municipalityCode
string

Payer municipality code (codMun; cobv holiday calc).

Example:

"3550308"

paymentDate
string

Intended payment date (dPP; aaaa-mm-dd; cobv valorFinal calc).

Example:

"2026-01-30"

Response

OK

amount
integer<int64>
required

The decoded amount in centavos.

Example:

10050

payee
object
required

The decoded recipient identity.

qrCodeType
string
required

The decoded QR type (STATIC or DYNAMIC; cobv folds onto DYNAMIC).

Example:

"DYNAMIC"

amountTroco
integer<int64>

The Pix Troco amount in centavos (troco only).

Example:

0

city
string

Recipient city (cidade; §8.3.3 Obrg=Sim on every block).

Example:

"Sao Paulo"

createdAt
string

When the dynamic charge was created (dtHrCriacao; §8.3.3 Obrg=Sim).

Example:

"2020-01-20T12:29:15.043Z"

description
string

Additional data (dadosAdicionais).

Example:

"Invoice 42"

dueDate
string

Due date (cobv/static optional).

Example:

"2026-12-31"

endToEndId
string

The SPI end-to-end id.

Example:

"E1234567890"

isPixSaque
boolean

Whether the QR carries a Pix Saque leg.

Example:

false

isPixTroco
boolean

Whether the QR carries a Pix Troco leg.

Example:

false

ispbPss
string

The saque/troco PSS participant ISPB (a v5.5.0 string; leading zeros are significant).

Example:

"00360305"

key
string

The recipient PIX key.

Example:

"recipient@bank.com"

presentedAt
string

When the payer captured the QR, i.e. the moment of this decode (dtHrApresentacao; §8.3.3 Obrg=Sim).

Example:

"2020-01-23T10:21:34.107Z"

revision
integer<int64>

Charge revision counter (revisao). Always present on a DYNAMIC decode, including at its initial value 0; absent on a STATIC one, whose §8.3.3 block declares no revisao.

Example:

0

txId
string

Conciliation id (idConciliacaoRecebedor).

Example:

"TX-001"