Decode a scanned PIX QR code

curl --request POST \
  --url https://api.example.com/v1/qrcodes/decode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "acc-123",
  "qrCode": "00020126...",
  "ispb": "12345678"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/qrcodes/decode"

	payload := strings.NewReader("{\n  \"accountId\": \"acc-123\",\n  \"qrCode\": \"00020126...\",\n  \"ispb\": \"12345678\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({accountId: 'acc-123', qrCode: '00020126...', ispb: '12345678'})
};

fetch('https://api.example.com/v1/qrcodes/decode', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/qrcodes/decode"

payload = {
    "accountId": "acc-123",
    "qrCode": "00020126...",
    "ispb": "12345678"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "amount": 10050,
  "payee": {
    "accountType": 0,
    "keyType": 2,
    "accountDigit": "7",
    "accountNumber": "123456",
    "branch": "0001",
    "document": "12345678909",
    "ispb": "12345678",
    "name": "Jane Doe"
  },
  "qrCodeType": "DYNAMIC",
  "amountTroco": 0,
  "city": "Sao Paulo",
  "createdAt": "2020-01-20T12:29:15.043Z",
  "description": "Invoice 42",
  "dueDate": "2026-12-31",
  "endToEndId": "E1234567890",
  "isPixSaque": false,
  "isPixTroco": false,
  "ispbPss": "00360305",
  "key": "recipient@bank.com",
  "presentedAt": "2020-01-23T10:21:34.107Z",
  "revision": 0,
  "txId": "TX-001"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Decode a scanned PIX QR code

Decodes a scanned PIX QR-code payload, normalizing static / immediate-dynamic / cobv sub-types into one null-safe response. The payer document is sourced from the CRM alias for the JDPI decode header.

Which of this deployment’s direct participants acts is decided by ispb, by exactly the rule an order’s payerIspb follows: this deployment may act as several direct participants, each with its own customers and its own JDPI credential, and naming none is answerable only while there is one answer. Omit it while this deployment acts as a single participant; once it acts as several, omitting it is 422 PIX-0127 and naming one it is not is 422 PIX-0128. It selects the JDPI credential the decode goes out on and nothing else.

POST

qrcodes

decode

Decode a scanned PIX QR code

curl --request POST \
  --url https://api.example.com/v1/qrcodes/decode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "acc-123",
  "qrCode": "00020126...",
  "ispb": "12345678"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/qrcodes/decode"

	payload := strings.NewReader("{\n  \"accountId\": \"acc-123\",\n  \"qrCode\": \"00020126...\",\n  \"ispb\": \"12345678\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({accountId: 'acc-123', qrCode: '00020126...', ispb: '12345678'})
};

fetch('https://api.example.com/v1/qrcodes/decode', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/qrcodes/decode"

payload = {
    "accountId": "acc-123",
    "qrCode": "00020126...",
    "ispb": "12345678"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "amount": 10050,
  "payee": {
    "accountType": 0,
    "keyType": 2,
    "accountDigit": "7",
    "accountNumber": "123456",
    "branch": "0001",
    "document": "12345678909",
    "ispb": "12345678",
    "name": "Jane Doe"
  },
  "qrCodeType": "DYNAMIC",
  "amountTroco": 0,
  "city": "Sao Paulo",
  "createdAt": "2020-01-20T12:29:15.043Z",
  "description": "Invoice 42",
  "dueDate": "2026-12-31",
  "endToEndId": "E1234567890",
  "isPixSaque": false,
  "isPixTroco": false,
  "ispbPss": "00360305",
  "key": "recipient@bank.com",
  "presentedAt": "2020-01-23T10:21:34.107Z",
  "revision": 0,
  "txId": "TX-001"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

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"

qrCode

string

required

The scanned EMV QR-code payload to decode.

Example:

"00020126..."

ispb

string

The ISPB of the direct participant this decode asks as. This deployment may act as SEVERAL direct SPI participants - one ISPB each, each with its own customers and its own JDPI credential - and this field is the only thing on the request that says which of them acts. OPTIONAL while it acts as a single participant: omit it and that one acts. REQUIRED once it acts as several - omitted is 422 PIX-0127, and an ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply and guarantee, exactly like payerIspb on a transaction: never a credential, never read from a header or a path, and it never widens what your token can reach. It selects the JDPI credential the decode goes out on and nothing else - the decoded charge belongs to the payee, not to you. Send it as an absent key, not an empty string; an empty value is refused 400 PIX-0061.

Pattern: ^[0-9]{8}$

Example:

"12345678"

Response

amount

integer<int64>

required

The decoded amount in centavos.

Example:

10050

payee

object

required

The decoded recipient identity.

Show child attributes

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"

Direct participant APIs

Indirect participant APIs

Decode a scanned PIX QR code

Authorizations

Body

Response