Consulta de dados de uma conta
stable
Este endpoint retorna os dados de uma conta regular, seja de pagamentos ou corrente.
Requisição (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/accounts/{accountNumber}
--request GET
--url 'https://api-mtls.sandbox.bankly.com.br/accounts/502000027888?includeBalance=true?code=413?branch=2020' \
--header 'accept: application/json' \
--header 'api-version: 1.0' \
--header 'Authorization: Bearer {{Token}}' \
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 |
|---|---|
account.read | Concede acesso para consultar informações (status, saldo etc.) sobre uma conta de pagamentos. |
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. |
Parâmetros da rota (Path)
No path desta requisição envie os seguintes campos:
| Nome | Tipo | Descrição |
|---|---|---|
accountNumber | path | Obrigatório. Número da conta. |
includeBalance | query | Inclui o saldo da conta na pesquisa. Informe true ou false. |
code | query | Código do banco da conta consultada. O valor default é 332. |
branch | query | Número da agência associada à conta consultada. |
Importante
Caso a consulta seja de uma conta corrente, é necessário informar o
codee abranch.
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 |
|---|---|---|
balance | object | Objeto que contém informações sobre o saldo da conta. |
balance.inProcess | object | Objeto que contém informações sobre o saldo em processamento. |
balance.inProcess.amount | number | Valor do saldo em processamento. |
balance.inProcess.currency | string | Código da moeda com base na ISO-4217. Exemplo: “BRL”. |
balance.available | object | Objeto que contém informações sobre o saldo disponível na conta. |
balance.available.amount | number | Valor do saldo disponível. |
balance.available.currency | string | Código da moeda com base na ISO-4217. Exemplo: “BRL”. |
balance.blocked | object | Este objeto está obsoleto e, portanto, deve ser desconsiderado, pois sempre retornará o valor zero. Para obter informações sobre o saldo bloqueado, por favor, abra um chamado no Service Desk ou utilize os eventos de Webhook de bloqueio de saldo. |
balance.blocked.amount | number | Valor do saldo bloqueado, o qual sempre retornará 0. |
balance.blocked.currency | string | Código da moeda com base na ISO-4217. Exemplo: “BRL”. |
status | string | Situação da conta, que pode ser "ACTIVE" ou "CLOSED". |
branch | string | Número da agência associada à conta consultada. |
number | string | Número da conta consultada. |
type | string | Tipo de conta, que pode ser "CHECKING" (corrente) ou "PAYMENT" (pagamento). |
bank | object | Objeto que contém informações sobre o banco ao qual a conta pertence. |
bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
bank.code | string | Código do banco. |
bank.name | string | Nome do banco. |
programId | string | Identificador do programa de contas que determina o tipo de conta. |
{
"balance": {
"inProcess": {
"amount": 0,
"currency": "BRL"
},
"available": {
"amount": 10000,
"currency": "BRL"
},
"blocked": {
"amount": 0,
"currency": "BRL"
}
},
"status": "ACTIVE",
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções De Pagamento SA - Instituição de Pagamento"
},
"programId": "d83c37b2-fb71-477c-b689-8ec95ab810c8"
}
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 3 months ago