Consulta por código de autenticação

stable

Este endpoint permite realizar a consulta específica de uma transferência via TED por meio de seu código de autenticação (authenticationCode), obtido no retorno da requisição da transferência.

Requisição (Request)

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/fund-transfers/{authenticationCode}?branch= {branchNumber}&account={accountNumber} \

curl --request GET \
     --url 'https://api-mtls.sandbox.bankly.com.br/fund-transfers/1972e6d9-c505-415d-8d91-7ced35a3bee6?branch=0001&account=15164' \
     --header 'accept: application/json' \
     --header 'api-version: 1.0' \
     --header 'Authorization: Bearer {{token}}'
     --header 'x-correlation-id: {{correlationId}}'

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
`ted.cashout.read`	Concede acesso para consultar detalhes de uma transferência via TED.

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-correlation-id`	Obrigatório. Informe um GUID, sendo um novo cada requisição.

Parâmetros da rota (Path)

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

Nome	Tipo	Descrição
`authenticationCode`	`path`	Obrigatório. Código de autenticação da transação a ser consultada.
`branch`	`query`	Obrigatório. Agência da conta a partir da qual se realizou a transferência.
`account`	`query`	Obrigatório. Número da conta.

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 identificador da transação.
`amount`	`number`	Valor transferido.
`description`	`string`	Descrição da transferência.
`correlationId`	`string`	GUID informado em cada requisição realizada no endpoint.
`sender`	`object`	Objeto que contém os dados do pagador da transação.
`sender.document`	`string`	Número do documento.
`sender.name`	`string`	Nome do pagador.
`sender.account`	`object`	Objeto que contém os dados da conta bancária do pagador.
`sender.account.branch`	`string`	Agência bancária.
`sender.account.number`	`string`	Número da conta.
`sender.account.bank`	`object`	Objeto que contém os dados do banco do pagador.
`sender.account.bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`sender.account.bank.name`	`string`	Nome do banco.
`sender.account.bank.compe`	`string`	Código do banco.
`recipient`	`object`	Objeto que contém os dados do recebedor da transação.
`recipient.document`	`string`	Número do documento.
`recipient.name`	`string`	Nome do recebedor.
`recipient.account`	`object`	Objeto que contém os dados da conta bancária do recebedor.
`recipient.account.branch`	`string`	Agência bancária.
`recipient.account.number`	`string`	Número da conta.
`data.recipient.account.bank`	`object`	Objeto que contém os dados do banco do recebedor.
`recipient.account.bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`recipient.account.bank.name`	`string`	Nome do banco.
`recipient.account.bank.compe`	`string`	Código do banco.
`channel`	`string`	Indica se a transação é interna (INTERNAL) ou externa (EXTERNAL).
`status`	`string`	Situação da transação.
`createdAt`	`string`	Data de criação da transferência, no formato ISO 8601 - UTC.
`updatedAt`	`string`	Data de de atualização dos dados da transferência, no formato ISO 8601 - UTC.

{
   "companyKey": "FLORESTA_ED",
   "authenticationCode": "1972e6d9-c505-415d-8d91-7ced35a3bee6",
   "amount": 55.5,
   "description": "Transfer",
   "correlationId": "f3c19268-699f-41a2-9363-cc7ea0e09571",
   "sender": {
      "document": "47742663023",
      "name": "Nísia Floresta",
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "name": "Acesso Soluções de Pagamento S.A.",
            "compe": "332"
         }
      }
   },
   "recipient": {
      "document": "09992220074",
      "name": "Maria Quitéria de Jesus",
      "account": {
         "branch": "0001",
         "number": "540108",
         "bank": {
            "ispb": "13140088",
            "name": "Acesso Soluções De Pagamento S.A.",
            "compe": "332"
         }
      }
   },
   "channel": "INTERNAL",
   "status": "DONE",
   "createdAt": "2021-10-28T10:42:53.431-03:00",
   "updatedAt": "2021-10-28T10:42:56.656-03:00"
}

Possíveis status da transação

Status	Descrição
CREATED	A transferência via TED foi criada.
IN PROCESS	A transação está passando pela análise de risco do sistema antifraude do Bankly e o valor está sendo reservado para a transação.
APPROVED	A transação foi aprovada.
REPROVED	A transação foi reprovada.
DONE	A transação foi completada com sucesso e o valor foi enviado para a conta de destino.
UNDONE	A transação foi desfeita devido à reprovação pela análise antifraude e o valor retornou para a conta de origem. Nesse caso, será gerado um evento de devolução (REFUND_ACCOUNT).
CANCELED	Falha ao reservar o valor.

👍
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

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 about 1 month ago

Requisição (Request)

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

Resposta (Response)

Possíveis status da transação

👍Dica

Erros

Eventos

👍
Dica