Consulta do status da transação
stable
Este endpoint permite consultar a situação das transferências e pagamentos realizados via Pix.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O cliente do parceiro tenha realizado uma transação (pagamento ou transferência) via Pix.
Requisição
Requisição HTTP
GET 'https://api-mtls.sandbox.bankly.com.br/pix/cash-out/accounts/{{accountNumber}}/authenticationcode/{{authenticationCode}}'
--request GET 'https://api-mtls.sandbox.bankly.com.br/pix/cash-out/accounts/{{accountNumber}}/authenticationCode/{{authenticationCode}}' \
--header 'Accept: application/json' \
--header 'x-correlation-id: {{GUID}}' \
--header 'api-version: 1.0'
Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
pix.cashout.read | Concede acesso para consultar uma transferência ou pagamento via Pix realizado. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
x-bankly-pix-user-id | Obrigatório. Número do documento do usuário que está fazendo a requisição. Insira apenas números, sem formatação. |
x-correlation-id | Se desejar, informe um GUID v4, sendo um novo cada requisição. |
Parâmetros da rota (Path)
No path desta requisição envie os seguintes campos:
| Nome | Tipo | Descrição |
|---|---|---|
accountNumber | path | Obrigatório. Número da conta que realizou o pagamento via Pix. |
authenticationCode | path | Obrigatório. Código de autenticação da transação, recebido no retorno da requisição de Pix cash-out. |
Corpo da requisição (Body)
Não é necessário enviar campos no body desta requisição.
Resposta (Response)
O status code 200 indicará sucesso na consulta.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
companyKey | string | Chave que identifica o parceiro dentro do Bankly. |
authenticationCode | string | Código de autenticação da transação. |
endToEndId | string | Identificador único do Pix. |
initializationType | string | Modo pelo qual a transação ocorreu: key (chave de endereçamento Pix), staticQrCode ou dynamicQrCode (QR Code) ou “manual”. |
receiverReconciliationId | string | ID de conciliação utilizado para conciliação dos pagamentos. |
amount | number | Valor transacionado. |
description | string | Campo que pode ser utilizado pelo usuário para enviar mensagens ao destinatário da transferência com informações sobre a transação. |
correlationId | string | GUID informado em cada requisição realizada no endpoint. |
sender | object | Objeto que contém informações sobre a conta do pagador. |
sender.account | object | Objeto que contém informações sobre a conta do pagador. |
sender.account.branch | string | Número da agência. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, o qual pode ser CHECKING para conta corrente, SALARY para conta salário, SAVINGS para conta poupança e PAYMENT para conta de pagamento. |
sender.bank | object | Objeto com os dados do banco do pagador. |
sender.bank.ispb | string | ISPB do banco. |
sender.bank.compe | string | Código do banco. Esse campo não é retornado em caso de Pix externo. |
sender.name | string | Nome de registro conforme consta no cadastro da conta. Quando pessoa física, trata-se do nome de registro, e quando pessoa jurídica, trata-se da razão social da empresa. |
sender.documentNumber | string | Número do documento do pagador. |
sender.documentType | string | Tipo de documento (CPF ou CNPJ). |
recipient | object | Objeto que contém os dados do recebedor. |
recipient.account | object | Objeto que contém informações sobre a conta do recebedor. |
recipient.account.branch | string | Número da agência. |
recipient.account.number | string | Número da conta. |
recipient.account.type | string | Tipo de conta, o qual pode ser CHECKING para conta corrente, SALARY para conta salário, SAVINGS para conta poupança e PAYMENT para conta de pagamento. |
recipient.bank | object | Objeto com os dados do banco recebedor. |
recipient.bank.ispb | string | ISPB da instituição recebedora do pagamento |
recipient.bank.compe | string | Código do banco. |
recipient.bank.name | string | Nome do banco. |
recipient.documentNumber | string | Número do documento do recebedor. |
recipient.documentType | string | Tipo de documento (CPF ou CNPJ). |
recipient.name | string | Nome do recebedor. Esse campo retornará o nome do documento de cadastro, e não o nome social. |
status | string | Possíveis estados para a transação de Pix cash-out. |
channel | string | Indica se a transação é interna (INTERNAL) ou externa (EXTERNAL). |
type | string | Tipo de transação, o qual pode ser CASH_OUT (pagamento/transferência) ou REFUND (devolução). |
createdAt | string | Data de criação da transação, no formato ISO 8601 - UTC. |
updatedAt | string | Data de atualização da transação, no formato ISO 8601 - UTC. |
{
"companyKey": "CompanyKey",
"authenticationCode": "6541a0d-06af-4c4d-b61e-e0f0cb91c9ff",
"endToEndId": "E131400882021021134358423496967",
"initializationType": "StaticQrCode",
"receiverReconciliationId": "6541a0d-06af-4c4d-b61e-e0f0cb91c9ff",
"amount": 1,
"description": "description",
"correlationId": "a7d65c0-cfb9-447b-858e-290954f8e618",
"sender": {
"account": {
"branch": "0001",
"number": "15164",
"type": "CHECKING"
},
"bank": {
"ispb": "13140088",
"compe": "332",
"name": "Acesso Soluções de Pagamento S.A."
},
"documentNumber": "47742663023",
"documentType": "CPF",
"name": "Nísia Floresta"
},
"recipient": {
"account": {
"branch": "0001",
"number": "540108",
"type": "CHECKING"
},
"bank": {
"ispb": "13140088",
"compe": "332",
"name": "Acesso Soluções De Pagamento S.A."
},
"documentNumber": "09992220074",
"documentType": "CPF",
"name": "Quitéria Maria de Jesus"
},
"channel": "INTERNAL",
"status": "DONE",
"type": "CASH_OUT",
"createdAt": "2021-10-21T13:44:17.173+00:00",
"updatedAt": "2021-10-21T13:44:18.393+00:00"
}
{
"companyKey": "CompanyKey",
"authenticationCode": "bc6a1d51-166b-492c-b6fb-bc4b0f47493b",
"endToEndId": "E1314008820210830143122298607300",
"initializationType": "Key",
"amount": 10,
"description": "DESCRIÇÃO",
"correlationId": "37c923c5-0bfc-449f-954d-db6463015cbb",
"sender": {
"documentType": "CPF",
"account": {
"branch": "0001",
"number": "15164",
"type": "CHECKING"
},
"bank": {
"ispb": "13140088"
},
"documentNumber": "47742663023",
"documentType": "CPF",
"name": "Nísia Floresta"
},
"recipient": {
"documentType": "CPF",
"account": {
"branch": "0551",
"number": "5101085860",
"type": "CHECKING"
},
"bank": {
"ispb": "00000000",
"compe": "001",
"name": "Bco Do Brasil S.A."
},
"documentNumber": "09992220074",
"documentType": "CPF",
"name": "Maria Quitéria de Jesus"
},
"channel": "EXTERNAL",
"status": "UNDONE",
"type": "CASH_OUT",
"createdAt": "2021-08-30T14:31:33.359+00:00",
"updatedAt": "2021-08-30T14:31:34.276+00:00"
}
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Status
Nota
A alteração do status da transação também é comunicada ao parceiro via eventos de webhook específicos.
Para receber esses eventos, é preciso realizar a configuração dos webhooks.
Status para transação via Pix cash-out
| Status | Descrição |
|---|---|
| CREATED | Transação criada, não finalizada. |
| IN_PROCESS | Transação em processo, não finalizada. |
| APPROVED | Transação aprovada, não finalizada. |
| REPROVED | Transação reprovada, não finalizada. |
| DONE | Transação concluída com sucesso. |
| UNDONE | Embora a reserva de valor para a transação (hold) tenha ocorrido com sucesso, a transação não pôde ser concluída, devido à reprovação no processo de antifraude transacional. Nesse caso, o valor será devolvido para a conta pagadora. |
| CANCELED | A transação foi cancelada. O saldo não foi afetado. |
Importante
A transação só é considerada como concluída quando o status estiver como DONE, UNDONE ou CANCELED.
Erros
Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated 12 days ago