Consultar uma cobrança - QR Code
Consultar status de uma cobrança - QR Code emitido
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 uma cobrança;
- Consultar o status do pagamento de uma cobrança;
- Gerar novos formatos de saídas para uma cobrança já criada;
Como consultar uma cobrança - QR Code
ENDPOINT: https://kaizen.bt-staging.app/pix-service/wallets/:walletId/qrcodes/:externalId
Esse endpoint utiliza o método GET.
Informação:
Para realizar a consulta desta transação e emiti-la em outros formatos utilize o campo "x-client-external-id" presente no header da response. Mais informações em "Consultar uma Transação"
https://developers.bitcapital.com.br/docs/consultar-uma-transação
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://{{API}}/pix-service/wallets/{{walletID}}/qrcodes/{{KAIexternalId}}?output=json
curl --location -g --request GET '{{baseurl}}/pix-service/wallets/{{walletId}}/qrcodes/{{KAIextrenalId}}?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) |
| x-client-external-id | Código gerado na emissão da cobrança |
Modelo de resposta:
Para a respostas com output formado JSON temos:
{
"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"
}
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 | pending_payment: - status que define que a cobrança está aberta pendente de pagamento paid: - status que define que a cobrança está paga refunded: - status que define que a cobrança foi paga e posteriormente reembolsada |
| emv.transactionAmount | string | - valor da cobrança definido no request de geração de pagamento |
| emv.merchantCategoryCode | string(4) | - código do MCC |
Updated over 1 year ago