Decode PIX QR Code

Decode a PIX QR Code payload.

Endpoint

POST /cashin/pix/decode-qrcode

Authentication

Merchant Credential. See Authentication.

Request headers

Name	In	Type	Required	Description	Example
Content-Type	header	string	Yes		application/json
X-Nonce	header	string	Yes		a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-Id	header	string	Yes		2492265300
X-Timestamp	header	string	Yes		1638123456
Digest	header	string	Yes		SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
Authorization	header	string	Yes		Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

Request body

Field	Type	Required	Description
qrcode	string	Yes	Merchant order number — QR code value (maxLength=32; pattern=^[A-Za-z0-9|_|-]{1-32})

Request example

{
  "qrcode": "00020101021226840023br.gov.bcb.pix2563qr.iugu.com/public/payload/v2/68A08B21C34E43B398137645AC2BF5E7520400015313986540520.005802BR5912AAAAABB LTDA6009SAO PAULO62070503***63046D60"
}

Response

HTTP 200 — Success

Field	Type	Required	Description
status	integer	Yes
msg	null	Yes
data	object	Yes

data fields

Field	Type	Required	Description
type	string	Yes	QR type (enum=STATIC, DYNAMIC, DYNAMIC_IMMEDIATE)
amount	number	Yes	Amount
allowsChangeAmount	boolean	Yes	Whether amount modification is allowed
toPix	string	Yes	Payee Pix key
toPixType	string	Yes	Payee Pix key type
toIspb	string	Yes	Payee PSP ISPB (8 digits, zero-padded)
toName	string	Yes	Payee / institution name
toCpfCnpj	string	Yes	CPF or CNPJ
agency	string	Yes	Payee bank branch
toAccount	string	Yes	Account

Response example

{
  "status": 200,
  "msg": null,
  "data": {
    "type": "STATIC",
    "amount": 1200,
    "allowsChangeAmount": true,
    "toPix": "bd1e5560-2ff9-4a82-82b8-000000000000",
    "toPixType": "EVP",
    "agency": "0001",
    "toAccount": "123456",
    "toIspb": "22896431",
    "toName": "SEBASTIAO CONCEICAO SANTOS",
    "toCpfCnpj": "473******53"
  }
}