Listar QR Codes de um alias

Os QR Codes Pix, utilizados no formato imagem ou URL, seguem um padrão, e devem ser decodificados seguindo uma lógica para extrair as informações do pagamento a ser realizado. Tendo a URL do QR Code, é possível decodificar todas as informações que originaram o mesmo. A decodificação gera um end_to_end_id, que deverá ser utilizado no pagamento do QR Code, juntamente com o receiver_conciliation_id, para identificar o pagamento do QR Code.

Request

ENDPOINT

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

MÉTODO

POST

Request Body: Decode QR Code

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

Campo	Tipo	Descrição	Caracteres
`qr_code_payload`	string	URL do QR Code para pagamento (pix copia e cola).	-

Response

STATUS

200 Ok

Response Body: QR Code estático

{
  "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: QR Code dinâmico com vencimento

{
  "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 dinâmico com vencimento

{
  "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

Campo	Tipo	Descrição	Caracteres
`request_control_key` *	string	Identificador UUID4 único da request que originou o QR Code.	-
`end_to_end_id` *	string	Identificador único da transação Pix, de ponta a ponta.	-
`account_type` *	string	Tipo da conta de origem.	-
`amount` *	float	Valor do QR Code atualmente.	-
`category_code` *	string	Identificador do QR Code para conciliação após o pagamento.	-
`expiration_seconds`	string	Indica qual o tempo de validade do QR Code em segundos, padrão 1 dia.	-
`ispb_number` *	string	Identificador do banco.	-
`payer_document_number` *	string	CPF/ CNPJ do pagador.	-
`payer_name` *	string	Nome do pagador.	-
`payer_request` *	string	Mensagem ao pagador.	-
`receiver_conciliation_id` *	string	Identificador do QR Code para conciliação após o pagamento.	-
`receiver_url` *	string	URL para consulta dos dados do QR Code dinâmico.	-
`qr_code_status` *	string	Status do QR Code.	-
`target_account_branch` *	string	Agência da conta de destino.	-
`target_account_digit` *	string	Digito verificador da conta de destino.	-
`target_account_number` *	string	Número da conta de destino.	-
`target_bank_code` *	string	Código do banco de destino.	-
`target_bank_name` *	string	Nome do banco de destino.	-
`target_document_number` *	string	CPF/ CNPJ do cobrador.	-
`target_name` *	string	Nome do cobrador.	-
`target_trading_name` *	string	Nome fantasia do cobrador - apenas para CNPJ.	-
`target_pix_key` *	string	Chave pix do cobrador.	-
`qr_code_key` *	string	Chave UUID4 identificadora do QR Code.	-
`qr_code_payload` *	string	URL copia e cola do QR Code.	-
`qr_code_type` *	string	Tipo do QR Code.	"static", "dynamic_term" ou "dynamic_instant"
`max_payment_days`	int32	Dias máximos para pagamento da cobrança após vencimento.	-
`expiration_date`	date	Data de vencimento da cobrança (no formato "YYYY-MM-DD").	-
`fine_amount`	float	Multa em valor absoluto após o vencimento.	-
`interest_amount`	float	Valor absoluto por dia de atraso após o vencimento, caso seja pago um dia após o vencimento o valor total será o valor ordinario + multa.	-
`discount_amount`	float	Valor do desconto.	-
`original_amount`	float	Valor original do QR Code.	-
`additional_data`	array of objects	Informações que serão apresentadas para o pagador.	-
`presented_at` *	datetime	Data e hora que o QR Code foi decodificado.	-
`created_at` *	datetime	Data e hora que o QR Code foi criado no sistema.	-
`rebate_amount`	float	Valor absoluto de abatimento antes do pagamento.	-

Objeto qr_code_status

Campo	Tipo	Descrição	Caracteres
`active`	string	QR Code se encontra ativo e disponível para pagamento.	-
`finished`	string	QR Code pago.	-
`written_off`	string	QR Code foi baixado pelo cliente.	-
`bank_written_off`	string	QR Code foi baixado automaticamente devido prazo expirado.	-

Objeto additional_data

Campo	Tipo	Descrição	Caracteres
`key_name` *	string	Nome do campo	-
`value`	string	Valor do campo	-

STATUS

400

Response Body: Impossível decodificar 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 não encontrado

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

Listar QR Codes de um alias

Request​

Response​

Response Body​

Objeto qr_code_status​

Objeto additional_data​

Request

Response

Response Body

Objeto qr_code_status

Objeto additional_data