Consulta do status da transação

stable scopes: pix.cashout.read

Por meio do endpoint de consulta de status, é possível verificar a situação da transação realizada de Pix cash-out.

Etapas

Endpoint

Para consumo deste endpoint de consulta, preencha no path os seguintes campos obrigatórios:

x-correlation-id: informe um GUID v4, gerado randomicamente. A cada requisição, deve-se gerar um novo GUID v4;
accountNumber: número da conta que realizou o pagamento;
authenticationCode: código recebido no retorno da requisição de Pix cash-out.

--request GET 'https://api-mtls.sandbox.bankly.com.br/pix/cash-out/accounts/{{accountNumber}}/authenticationcode/{{authenticationCode}}' \  
--header 'Accept: application/json' \
--header 'x-correlation-id: {{correlationId}}' \ 
--header 'api-version: 1'

Retorno

A situação da transação será exibida no campo status do retorno. O campo channel indicará se a transação é interna (INTERNAL) ou externa (EXTERNAL):

{
   "companyKey": "CompanyKey",
   "authenticationCode": "65411a0d-06af-4c4d-b61e-e0f0cb91c9ff",
   "endToEndId": "E1314008820211021134358423496967",
   "initializationType": "StaticQrCode",
   "receiverReconciliationId": "codigo1234",
   "amount": 1,
   "description": "description",
   "correlationId": "a7d65c06-cfb9-447b-858e-290954f8e618",
   "sender": {
      "documentType": "CPF",
      "account": {
         "branch": "0001",
         "number": "111470",
         "type": "CHECKING"
      },
      "bank": {
         "ispb": "13140088",
         "compe": "332",
         "name": "Acesso Soluções de Pagamento S.A."
      },
      "documentNumber": "12345678902",
      "name": " Peter Parker"
   },
   "recipient": {
      "documentType": "CPF",
      "account": {
         "branch": "0001",
         "number": "111568",
         "type": "CHECKING"
      },
      "bank": {
         "ispb": "13140088",
         "compe": "332",
         "name": "Acesso Soluções De Pagamento S.A."
      },
      "documentNumber": "12345678900",
      "name": "Carol Denvers"
   },
   "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": "186929",
         "type": "CHECKING"
      },
      "bank": {
         "ispb": "13140088"
      },
      "documentNumber": "12345678900",
      "name": "Carol Denvers"
   },
   "recipient": {
      "documentType": "CPF",
      "account": {
         "branch": "0551",
         "number": "5101085860",
         "type": "CHECKING"
      },
      "bank": {
         "ispb": "00000000",
         "compe": "001",
         "name": "Bco Do Brasil S.A."
      },
      "documentNumber": "12345678902",
      "name": "Peter Parker"
   },
   "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"
}

Status

Os possíveis status da transação de Pix cash-out são:

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	A transação não pôde ser concluída. O valor foi estornado.
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.

Updated over 1 year ago

Did this page help you?