Consultar um Pix-boleto - QR Code
Consultar status de um Pix-boleto
Essa funcionalidade tem como objetivo permitir consultar/buscar uma cobrança - QR Code já emitido e gerar essa mesma cobrança em outros formatos, de acordo com a necessidade e opção do cliente.
Usado para:
- Consultar os dados de um Pix-boleto;
- Consultar o status do pagamento de um Pix-boleto;
- Gerar novos formatos de saídas para uma cobrança já criada;
Como consultar uma cobrança - QR Code
ENDPOINT: https://kaizen.bt-{{env}}.app/pix-service/wallets/{{walletId}}/qrcodes/{{externalId}}?output=base64
Esse endpoint utiliza o método GET.
Informação:
Para realizar a consulta desta transação e exportá-la em outros formatos utilize o campo "x-client-external-id" presente no header da response.
Modelo de requisição:
Para efetuar a busca é necessário informar nos parâmetros a walletID e o código ExternalID da transação:
https://{{baseurl}}/pix-service/wallets/{{walletID}}/qrcodes/{{externalId}}?output={{output}}
curl --location 'https://{{url}}/pix-service/wallets/930c6c45-b3ae-463b-8558-3b4e989e4146/qrcodes/PIB7i17026CghFpn4A8PwqQUxJ?output=base64' \
--header 'Authorization: Bearer TOKEN'
Parâmetros da requisição:
Os parâmetros para essa requisição são:
| Parâmetro | Descrição |
|---|---|
| output | Define o formato da saída desejado - raw - json - png - svg - base64 |
| walletID | Número da wallet de origem (Cliente já estará logado) |
| externalId | - Código gerado na emissão da cobrança - caso não esteja emitindo seu próprio header x-client-external-id personalizado, é possivel recuperar o x-client-external-id gerado pela plataforma no response do header na emissão do QRCode |
Modelo de resposta:
{
"createdAt": "2023-08-25T19:55:51.369Z",
"updatedAt": "2023-08-25T19:56:50.266Z",
"deletedAt": null,
"expiresAt": "2023-08-30T16:00:00.000Z",
"walletId": "930c6c45-b3ae-463b-8558-3b4e989e4146",
"emv": {
"countryCode": "BR",
"merchantCity": "Sao Paulo",
"merchantName": "Pixoleto",
"additionalData": {
"referenceLabel": "***"
},
"transactionAmount": "0.01",
"transactionCurrency": "986",
"merchantCategoryCode": "0000",
"payloadFormatIndicator": "01",
"pointOfInitiationMethod": "12",
"merchantAccountInformationPix": {
"gui": "br.gov.bcb.pix",
"url": "qrcode-h.pixame.app/pix/v2/8736b5ba-7c9b-4106-a19e-a6b796036de7"
}
},
"status": "paid"
}
MDAwMjAxMDEwMjEyMjY4ODAwMTRici5nb3YuYmNiLnBpeDI1NjZxcmNvZGUtaC5waXhwYXJhdGkuYXBwL3BpeC92Mi8xYzFiY2Y3NC1kYzUyLTQxMWMtOWVkNi1hMTVhNDc0OGFlOTU1MjA0MDAwMDUzMDM5ODY1NDA0MS4wNjU4MDJCUjU5MDhQaXhvbGV0bzYwMTVKaWpvY2EgZGUgSmVyaWM2MjA3MDUwMyoqKjYzMDQ5N0FG
00020101021226880014br.gov.bcb.pix2566qrcode-h.pixparati.app/pix/v2/1c1bcf74-dc52-411c-9ed6-a15a4748ae9552040000530398654041.065802BR5908Pixoleto6015Jijoca de Jeric62070503***630497AF
Descrição dos campos:
| campo | tipo | descrição |
|---|---|---|
| id | string(uuid) | - qrcodeId. É um identificador interno na plataforma para fácil localização do QRCode gerado |
| walletId | string (uuid) | - walletId do cliente. Wallet que receberá os saldos assim que a cobrança seja paga por uma Instituição Financeira |
| status | ENUM | pix_pending_payment: - status que define que a cobrança está aberta pendente de pagamento pix_paid: - status que define que a cobrança está paga boleto_paid: - status que define que o boleto atrelado a cobrança foi pago boleto_error_payment: - status que define que que o boleto atrelado a cobrança não foi pago (poderá haver retentativa) boleto_refunded: - status que define que que o boleto atrelado a cobrança foi pago e posteriormente devolvido pelo banco liquidante (pós-liquidação) pix_refunded: - status que define que que a cobrança foi paga mas reembolsada por motivo de falha no pagamento do boleto atrelado |
| emv.transactionAmount | string | - valor da cobrança definido no request de geração de pagamento |
| emv.merchantCategoryCode | string(4) | - código do MCC |
Updated 7 months ago