Consulta por conta
stable
Este endpoint permite obter informações de todas as operações de TED realizadas por uma determinada conta bancária.
Nota
Este endpoint retorna apenas informações sobre TEDs enviadas. Para verificar as TEDs recebidas por uma conta, utilize a API de consulta de eventos.
Requisição (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/fund-transfers?branch={branchNumber}&account={accountNumber}&pageSize={numberOfResults}&nextPage={token}
curl --request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/fund-transfers?branch=0001&account=15164&pageSize=100' \
--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 |
|---|---|---|
branch | query | Obrigatório. Número da agência da conta consultada. |
account | query | Obrigatório. Número da conta. |
pageSize | query | Número de resultados a serem exibidos por página (o padrão é 100). |
nextPage | query | Token identificador da próxima página solicitada. Ele pode ser obtido no retorno da primeira consulta de status. |
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 |
|---|---|---|
nextPage | string | Se o campo pageSize tiver sido enviado na requisição e se ainda houver dados não apresentados na primeira página retornada, o campo nextPage será retornado com um token que deverá ser utilizado na próxima consulta para visualizar as demais páginas. |
data | array of objects | Objeto que contém todos os dados da consulta. |
data.companyKey | string | Chave que identifica o parceiro dentro do Bankly. |
data.authenticationCode | string | Código identificador da transação. |
data.amount | number | Valor transferido. |
data.description | string | Descrição da transferência. |
data.correlationId | string | GUID informado em cada requisição realizada no endpoint. |
data.sender | object | Objeto que contém os dados do pagador da transação. |
data.sender.document | string | Número do documento. |
data.sender.name | string | Nome do pagador. |
data.sender.account | object | Objeto que contém os dados da conta bancária do pagador. |
data.sender.account.branch | string | Agência bancária. |
data.sender.account.number | string | Número da conta. |
data.sender.account.bank | object | Objeto que contém os dados do banco do pagador. |
data.sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
data.sender.account.bank.name | string | Nome do banco. |
data.sender.account.bank.compe | string | Código do banco. |
data.recipient | object | Objeto que contém os dados do recebedor da transação. |
data.recipient.document | string | Número do documento. |
data.recipient.name | string | Nome do recebedor. |
data.recipient.account | object | Objeto que contém os dados da conta bancária do recebedor. |
data.recipient.account.branch | string | Agência bancária. |
data.recipient.account.number | string | Número da conta. |
data.recipient.account.bank | object | Objeto que contém os dados do banco do recebedor. |
data.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
data.recipient.account.bank.name | string | Nome do banco. |
data.recipient.account.bank.compe | string | Código do banco. |
data.channel | string | Indica se a transação é interna (INTERNAL) ou externa (EXTERNAL). |
data.status | string | Situação da transação. |
data.createdAt | string | Data de criação da transferência, no formato ISO 8601 - UTC. |
data.updatedAt | string | Data de de atualização dos dados da transferência, no formato ISO 8601 - UTC. |
{
"nextPage": "eyJCYW5rQWNjb3VudCI6eyJTIjoiMDAwMSMxNzM1MDkifSwiQXV0aGVudGljYXRpb25Db2RlIjp7IlMiOiJiNjRiZDVhMi05NmMxLTRjMTEtYjE4NC0zZmU3MTcwZDJmNTIifSwiQ3JlYXRlZEF0Ijp7IlMiOiIyMDIyLTAxLTA3VDE0OjQzOjE0LjA1MVoifX0=",
"data": [
{
"companyKey": "FLORESTA_ED",
"authenticationCode": "180a1541-fc9c-4210-8cdf-53692270b926",
"amount": 1.5,
"description": "DESCRIPTION",
"correlationId": "f970f40b-4fcd-4405-bcc4-b51484e4951f",
"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": "CREATED",
"createdAt": "2023-05-08T10:21:51.839-03:00",
"updatedAt": "2022-05-09T10:21:53.724-03:00"
},
{
"companyKey": " Company_Key ",
"authenticationCode": "fa82a7c0-7680-40fc-b873-6932aeebf4a3",
"amount": 0.01,
"description": "DESCRIPTION",
"correlationId": "98e1475d-3207-4df4-b4fa-1a066c2cbcde",
"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": "2022-01-13T10:18:47.001-03:00",
"updatedAt": "2022-01-13T10:18:48.454-03:00"
},
{
"companyKey": "Company_Key",
"authenticationCode": "e4bc18a3-0020-4397-bf92-25d9f55d0a78",
"amount": 10,
"description": "DESCRIPTION",
"correlationId": "5748604e-da70-4c31-9059-807d6aa3e77c",
"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": "2022-01-13T10:18:10.363-03:00",
"updatedAt": "2022-01-13T10:18:12.691-03:00"
},
{
"companyKey": "Company_Key",
"authenticationCode": "418cf850-206e-466e-8ced-4fc18e367334",
"amount": 0.1,
"description": "DESCRIPTION",
"correlationId": "659386ac-dc7f-4e41-8d6f-7ff5713d5118",
"sender": {
"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"
}
}
},
"recipient": {
"document": "47742663023",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções De Pagamento S.A.",
"compe": "332"
}
}
},
"channel": "INTERNAL",
"status": "DONE",
"createdAt": "2022-01-13T10:17:41.472-03:00",
"updatedAt": "2022-01-13T10:17:42.845-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