Manual do Dev
InstitucionalBlogService DeskStatus Page

Consulta do status da transação

stable

Suggest Edits

Este endpoint permite consultar a situação das transações realizadas via Pix cash-out.

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 (Request)

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/pix/cash-out/accounts/{{accountNumber}}/authenticationcode/{{authenticationCode}}

--request GET \
--url '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.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:

ScopeDescrição
pix.cashout.readConcede acesso para consultar uma transferência ou pagamento via Pix realizado.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.
x-correlation-idObrigatório. Informe um GUID, sendo um novo cada requisição.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

NomeTipoDescrição
accountNumberpathObrigatório. Número da conta que realizou o pagamento via Pix.
authenticationCodepathObrigató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:

NomeTipoDescrição
companyKeystringChave que identifica o parceiro dentro do Bankly.
authenticationCodestringIdentificador único da transação, no formato GUID v4.
endToEndIdstringIdentificador único do Pix.
initializationTypestringModo pelo qual a transação ocorreu, que pode ser "key" (chave de endereçamento Pix), "staticQrCode" ou "dynamicQrCode" (QR Code) ou “manual”.
receiverReconciliationIdstringID de conciliação utilizado para conciliação dos pagamentos.
amountnumberValor da transação.
descriptionstringCampo que pode ser utilizado pelo cliente do parceiro para registrar informações referentes à transação. Essas informações poderão ser visualizadas pelo destinatário da transferência.
correlationIdstringGUID informado em cada requisição realizada no endpoint.
senderobjectObjeto que contém informações sobre o pagador da transação.
sender.accountobjectObjeto que contém informações sobre a conta do pagador da transação.
sender.account.branchstringNúmero da agência.
sender.account.numberstringNúmero da conta.
sender.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
sender.bankobjectObjeto que contém informações sobre o banco pagador da transação.
sender.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco pagador da transação.
sender.bank.compestringCódigo do banco. Esse campo não é retornado em caso de Pix externo.
sender.namestringNome de registro do pagador da transação, 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.documentNumberstringNúmero do documento.
sender.documentTypestringTipo de documento do pagador da transação, que pode ser "CPF" ou "CNPJ".
recipientobjectObjeto que contém informações sobre o recebedor da transação.
recipient.accountobjectObjeto que contém informações sobre a conta do recebedor da transação.
recipient.account.branchstringNúmero da agência.
recipient.account.numberstringNúmero da conta.
recipient.account.typestringTipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
recipient.bankobjectObjeto que contém informações sobre o banco do recebedor da transação.
recipient.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco recebedor da transação.
recipient.bank.compestringCódigo do banco.
recipient.bank.namestringNome do banco.
recipient.documentNumberstringNúmero do documento.
recipient.documentTypestringTipo de documento do recebedor da transação, que pode ser "CPF" ou "CNPJ".
recipient.namestringNome do recebedor da transação. Esse campo retornará o nome do documento de cadastro, e não o nome social.
statusstringPossívei estados da transação de Pix cash-out.
channelstringIndica se a transação é interna ("INTERNAL") ou externa ("EXTERNAL").
typestringTipo de transação, que pode ser "CASH_OUT" (pagamento/transferência) ou "REFUND" (devolução).
createdAtstringData de criação da transação, no formato ISO 8601 - UTC.
updatedAtstringData 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

Status da transação Pix cash-out

StatusDescrição
CREATEDTransação criada, não finalizada.
IN_PROCESSTransação em processo, não finalizada.
APPROVEDTransação aprovada, não finalizada.
REPROVEDTransação reprovada, não finalizada.
DONETransação concluída com sucesso.
UNDONEEmbora 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.
CANCELEDA 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 7 days ago

Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados