Consulta de status da transação
stable scopes: ted.cashout.read
O processo de transferência via TED passa por validações síncronas e assíncronas. Desse modo, embora a API retorne sucesso na requisição, é possível que a transação ainda não tenha sido finalizada.
Portanto, recomendamos consultar o status da transação por meio de nossas APIs de consulta.
Consulta por conta
O endpoint de consulta por conta permite obter informações de todas as operações de TED realizadas em uma determinada conta bancária.
Etapas
Endpoint
Para o consumo desse endpoint, no path da requisição, é obrigatório enviar os seguintes campos:
branch: número da agência;account: número da conta a ser consultada.
Opcionalmente, envie os campos:
pageSize: informe o número de resultados que deseja que sejam exibidos por página. Por padrão, o número de resultados por página é 100;nextPage: insira o token identificador da próxima página solicitada. Esse token retorna após realizar a primeira consulta de status.
--request GET \
--url "https://api-mtls.sandbox.bankly.com.br/fund-transfers?branch={{branchNumber}}&account={{accountNumber}}&pageSize=2&nextPage={{token}}"
--header 'Accept: application/json' \
--header 'api-version: 1'
Retorno
{
"nextPage": "eyJCYW5rQWNjb3VudCI6eyJTIjoiMDAwMSMxNzM1MDkifSwiQXV0aGVudGljYXRpb25Db2RlIjp7IlMiOiJiNjRiZDVhMi05NmMxLTRjMTEtYjE4NC0zZmU3MTcwZDJmNTIifSwiQ3JlYXRlZEF0Ijp7IlMiOiIyMDIyLTAxLTA3VDE0OjQzOjE0LjA1MVoifX0=",
"data": [
{
"companyKey": " Company_Key ",
"authenticationCode": "180a1541-fc9c-4210-8cdf-53692270b926",
"amount": 1.5,
"description": "DESCRIPTION",
"correlationId": "f970f40b-4fcd-4405-bcc4-b51484e4951f",
"sender": {
"document": "00000000000000",
"name": "NOME_SENDER",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções de Pagamento S.A.",
"compe": "332"
}
}
},
"recipient": {
"document": "12345678900",
"name": "NOME_RECIPIENT",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções De Pagamento S.A.",
"compe": "332"
}
}
},
"channel": "INTERNAL",
"status": "DONE",
"createdAt": "2022-01-13T10:21:51.839-03:00",
"updatedAt": "2022-01-13T10:21:53.724-03:00"
},
{
"companyKey": "Company_Key",
"authenticationCode": "a2cf808f-a00a-4057-8dd6-fb9ffb3ecef7",
"amount": 150,
"description": "DESCRIPTION",
"correlationId": "7195bb6e-16f3-4b7a-bedd-9a63104b1429",
"sender": {
"document": "00000000000000",
"name": "NOME_SENDER",
"account": {
"branch": "0001",
"number": "1234567",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções de Pagamento S.A.",
"compe": "332"
}
}
},
"recipient": {
"document": "12345678900",
"name": "NOME_RECIPIENT",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções De Pagamento S.A.",
"compe": "332"
}
}
},
"channel": "INTERNAL",
"status": "DONE",
"createdAt": "2022-01-13T10:20:27.439-03:00",
"updatedAt": "2022-01-13T10:20:29.466-03:00"
},
{
"companyKey": " Company_Key ",
"authenticationCode": "fa82a7c0-7680-40fc-b873-6932aeebf4a3",
"amount": 0.01,
"description": "DESCRIPTION",
"correlationId": "98e1475d-3207-4df4-b4fa-1a066c2cbcde",
"sender": {
"document": "00000000000000",
"name": "NOME_SENDER",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções de Pagamento S.A.",
"compe": "332"
}
}
},
"recipient": {
"document": "12345678900",
"name": "NOME_RECIPIENT",
"account": {
"branch": "0001",
"number": "123456",
"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": "00000000000000",
"name": "NOME_SENDER",
"account": {
"branch": "0001",
"number": "173509",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções de Pagamento S.A.",
"compe": "332"
}
}
},
"recipient": {
"document": "12345678900",
"name": "NOME_RECIPIENT",
"account": {
"branch": "0001",
"number": "123456",
"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": "13167163000105",
"name": "NOME_SENDER",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções de Pagamento S.A.",
"compe": "332"
}
}
},
"recipient": {
"document": "12345678900",
"name": "NOME_RECIPIENT",
"account": {
"branch": "0001",
"number": "123456",
"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"
},
{
"companyKey": "Company_Key",
"authenticationCode": "651c9c07-79a8-48d7-bbdf-4a10802218f2",
"amount": 4.56,
"description": "DESCRIPTION",
"correlationId": "3204ddec-cc06-41f9-934a-70fe1266b711",
"sender": {
"document": "00000000000000",
"name": "NOME_SENDER",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções de Pagamento S.A.",
"compe": "332"
}
}
},
"recipient": {
"document": "12345678900",
"name": "NOME_RECIPIENT",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções De Pagamento S.A.",
"compe": "332"
}
}
},
"channel": "INTERNAL",
"status": "DONE",
"createdAt": "2022-01-13T10:17:35.363-03:00",
"updatedAt": "2022-01-13T10:17:36.739-03:00"
},
{
"companyKey": "Company_Key",
"authenticationCode": "b64bd5a2-96c1-4c11-b184-3fe7170d2f52",
"amount": 4.56,
"description": "DESCRIPTION",
"correlationId": "66c81640-aa9f-4a0f-88b4-689ca631f503",
"sender": {
"document": "00000000000000",
"name": "NOME_SENDER",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções de Pagamento S.A.",
"compe": "332"
}
}
},
"recipient": {
"document": "39020237080",
"name": "NOME_RECIPIENT",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções De Pagamento S.A.",
"compe": "332"
}
}
},
"channel": "INTERNAL",
"status": "DONE",
"createdAt": "2022-01-07T11:43:14.051-03:00",
"updatedAt": "2022-01-07T11:43:15.472-03:00"
}
]
}
Consulta por código de autenticação
É possível realizar a consulta de uma transação específica utilizando o seu código de autenticação (authenticationCode), obtido no retorno da requisição da transferência.
Etapas
Endpoint
Para o consumo deste endpoint, no path da requisição, é obrigatório enviar os seguintes campos:
authenticationCode: código recebido no retorno da requisição de TED;branch: número da agência;account: número da conta a ser consultada.
--request GET \
--url "https://api-mtls.sandbox.bankly.com.br/fund-transfers/{{authenticationCode}}?branch= {{branchNumber}} &account= {{accountNumber}}" \
--header 'Accept: application/json'
--header 'api-version: 1'
Retorno
{
"companyKey": "Company Key2",
"authenticationCode": "1972e6d9-c505-415d-8d91-7ced35a3bee6",
"amount": 55.5,
"description": "Transfer",
"correlationId": "f3c19268-699f-41a2-9363-cc7ea0e09571",
"sender": {
"document": "12345678900",
"name": "Peter Parker",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"name": "Acesso Soluções de Pagamento S.A.",
"compe": "332"
}
}
},
"recipient": {
"document": "98765432100",
"name": "Carol Denver",
"account": {
"branch": "0001",
"number": "654321",
"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
| Status | Descrição |
|---|---|
| Created | A transação foi recebida com sucesso (já verificamos que os dados da conta estão corretos, que a conta possui saldo e que há limite para realizar a transação). |
| In process | O valor está sendo reservado para a transação. |
| Approved | A transação foi aprovada pela análise antifraude. |
| Reproved | A transação foi reprovada pela análise antifraude. |
| Done | A transação foi completada com sucesso. |
| Undone | A operação foi desfeita devido à reprovação pela análise antifraude. Nesse caso, será gerado um evento de devolução (REFUND_ACCOUNT). |
| Canceled | Falha ao reservar o valor. |
Updated 12 months ago