List QR Codes of an alias

PIX QR Codes, used in image or URL format, follow a standard and must be decoded using logic to extract the payment information. With the URL of the QR Code, it is possible to decode all the information that originated it. The decoding generates an end_to_end_id, which must be used in the QR Code payment along with the receiver_conciliation_id to identify the QR Code payment.

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/qrcode/decode

METHOD

POST

Request Body: Decode QR Code

{
   "qr_code_payload": "00020126580014br.gov.bcb.pix0136a23bf0e9-5175-4829-bf89-e8fe6ac09aa1520400005303986540530.005802BR5914TywinLannister6008saopaulo62070503***6304D4FD",
}

Field	Type	Description	Characters
qr_code_payload	string	URL of the QR Code for payment (PIX copy and paste).	-

Response

STATUS

200 Ok

Response Body: Static QR Code

{
  "end_to_end_id": "E32402502202303131806WTFZTGAOWiq",
  "qr_code_data": {
    "additional_data": null,
    "amount": null,
    "ispb_number": "90400888",
    "receiver_conciliation_id": "01GVGV9NXBCY287Z6CJ4S0ENW9",
    "target_account_branch": "2980",
    "target_account_digit": "5",
    "target_account_number": "0000000000022039741",
    "target_account_type": "checking_account",
    "target_bank_code": 33,
    "target_bank_name": "BCO SANTANDER (BRASIL) S.A.",
    "target_document_number": "00000000000000",
    "target_name": "JOSE RONALDO",
    "target_pix_key": "00000000000000"
  },
  "qr_code_key": "e54671f5-3eda-4180-8539-0ac6271fe185",
  "qr_code_payload": "00020126360032br.gov.bcb.pix0111234590280001665204000051234565802BR5925JOSE RONALDO BERNARDINO 26008BRASILIA62070503***63044293",
  "qr_code_type": "static"
}

STATUS

200 Ok

Response Body: Dynamic QR Code with due date

{
  "request_control_key": "037b46b1-0c67-4c0d-aac3-1e395dfdcb10",
  "end_to_end_id": "E32402502202303101532yCipbxgUnUj",
  "qr_code_data": {
    "account_type": "payment_account",
    "additional_data": [],
    "amount": "55.59",
    "category_code": "0000",
    "max_payment_days": 16,
    "discount_amount": null,
    "expiration_date": "2023-03-27",
    "fee_amount": null,
    "fine_amount": null,
    "ispb_number": "20018183",
    "original_amount": "55.59",
    "payer_document_number": "00000000000",
    "payer_name": "Willian Rocha",
    "payer_request": null,
    "receiver_conciliation_id": "8b434df48c30482a81f7c936ae35cc87",
    "receiver_url": "invoice.starkbank.com/v2/cobv/8b434df48c30482a81f7c936ae351234",
    "reduction_amount": null,
    "qr_code_status": "active",
    "target_account_branch": "0001",
    "target_account_digit": "8",
    "target_account_number": "589575519784140",
    "target_bank_code": null,
    "target_bank_name": "Stark Bank S.A.",
    "target_document_number": "00000000000000",
    "target_name": "TESTE LTDA.",
    "target_pix_key": "e623e7b0-d00a-400e-aee6-79632430e817",
    "target_trading_name": null,
    "presented_at": "2023-03-10T15:32:15.87Z",
    "created_at": "2023-01-10T19:49:58.30Z",
  },
  "qr_code_key": "8c2c19bd-f260-4714-955c-956f3eaa30ca",
  "qr_code_payload": "00020101021226840014br.gov.bcb.pix2562invoice.starkbank.com/v2/cobv/8b434df48c30482a81f7c936ae35cc123456000053039865802BR5925Oncred Sociedade de Credi6015TESTE 62070503***6304D008",
  "qr_code_type": "dynamic_term"
}

STATUS

200 Ok

Response Body: QR Code with due date

{
  "request_control_key": "037b46b1-0c67-4c0d-aac3-1e395dfdcb10",
  "end_to_end_id": "E32402502202303141907qlBAF1evdJ2",
  "qr_code_data": {
    "account_type": "checking_account",
    "additional_data": [],
    "amount": "9367.61",
    "category_code": "0000",
    "expiration_seconds": 201574,
    "ispb_number": "00000000",
    "payer_document_number": "10003550206",
    "payer_name": "ISMAEL FATIMA AMARAL",
    "payer_request": "Liquidacao de Parcelas",
    "receiver_conciliation_id": "fgnb4NTt7pOUBGfrcporERwVVqr0f8PWRfK",
    "receiver_url": "qrcodepix.bb.com.br/pix/v2/d373e385-dfe7-49f6-b9ec-14ba60a90000",
    "qr_code_status": "active",
    "target_account_branch": "1253",
    "target_account_digit": "8",
    "target_account_number": "107260",
    "target_bank_code": 1,
    "target_bank_name": "BCO DO BRASIL S.A.",
    "target_document_number": "0000000000000",
    "target_name": "TESTE LTDA.",
    "target_pix_key": "teste.cobrancapix@gmail.com.br",
    "presented_at": "2023-03-14T19:07:48.729Z",
    "created_at": "2023-03-13T19:00:28.440Z",
  },
  "qr_code_key": "ffd7d60a-0f2d-4b29-9ae2-7f2b919fa65e",
  "qr_code_payload": "00020101021226850014br.gov.bcb.pix2563qrcodepix.bb.com.br/pix/v2/d373e385-dfe7-49f6-b9ec-14ba60a9b8285204001234567895802BR5925TESTE DE JANEIRO62070503***63047B7D",
  "qr_code_type": "dynamic_instant"
}

Response Body

Field	Type	Description	Characters
request_control_key *	string	Unique UUID4 identifier of the request that originated the QR Code.	-
end_to_end_id *	string	Unique identifier of the Pix transaction, end-to-end.	-
account_type *	string	Type of origin account.	-
amount *	float	QR Code amount currently.	-
category_code *	string	QR Code identifier for reconciliation after payment.	-
expiration_seconds	string	Indicates the validity time of the QR Code in seconds, default is 1 day	-
ispb_number *	string	Bank identifier.	-
payer_document_number *	string	Payer's CPF/ CNPJ.	-
payer_name *	string	Payer's name.	-
payer_request *	string	Message to the payer.	-
receiver_conciliation_id *	string	QR Code identifier for reconciliation after payment.	-
receiver_url *	string	URL for querying the dynamic QR Code data.	-
qr_code_status *	string	QR Code status.	-
target_account_branch *	string	Destination account branch.	-
target_account_digit *	string	Destination account check digit.	-
target_account_number *	string	Destination account number.	-
target_bank_code *	string	Destination bank code.	-
target_bank_name *	string	Destination bank name.	-
target_document_number *	string	Collector's CPF/ CNPJ.	-
target_name *	string	Collector's name.	-
target_trading_name *	string	Collector's trade name - only for CNPJ.	-
target_pix_key *	string	Collector's PIX key.	-
qr_code_key *	string	UUID4 key identifying the QR Code.	-
qr_code_payload *	string	QR Code copy and paste URL.	-
qr_code_type *	string	Type of the QR Code.	"static", "dynamic_term", or "dynamic_instant"
max_payment_days	int32	Maximum days for paying the charge after due date.	-
expiration_date	date	Due date of the charge (in the format "YYYY-MM-DD").	-
fine_amount	float	Absolute fine amount after the due date.	-
interest_amount	float	Absolute value per day of delay after the due date.	-
discount_amount	float	Discount amount.	-
original_amount	float	Original QR Code amount.	-
additional_data	array of objects	Information to be presented to the payer.	-
presented_at *	datetime	Date and time the QR Code was decoded.	-
created_at *	datetime	Date and time the QR Code was created in the system.	-
rebate_amount	float	Absolute rebate amount before payment.	-

Object qr_code_status

Field	Type	Description	Characters
active	string	QR Code is active and available for payment.	-
finished	string	QR Code has been paid.	-
written_off	string	QR Code has been canceled by the client.	-
bank_written_off	string	QR Code was automatically canceled due to expiration.	-

Object additional_data

Field	Type	Description	Characters
key_name *	string	Name of the field	-
value	string	Value of the field	-

STATUS

400

Response Body: Impossible to decode QR Code

{
    "title": "Bad Request",
    "description": "Could not decode QR Code.",
    "translation": "Não foi possível decodificar o QR Code.",
    "code": "QRI000001"
}

STATUS

404

Response Body: QR Code not found

{
    "title": "Not found",
    "description": "Could not find the queried QR Code.",
    "translation": "Não possível encontrar o QR Code buscado.",
    "code": "QRI000002"
}