Consulta de dados de uma conta

Este endpoint retorna todos os dados de uma conta de pagamentos.

Requisição

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/accounts/{accountNumber}

curl --request GET \
       --url 'https://api-mtls.sandbox.bankly.com.br/accounts/502000027888?includeBalance=true?code=413?branch=2020' \
      --header 'accept: application/json' \
      --header 'x-bkly-license: 24ac71da-4309-4348-9cc0-a0c88f867993' \

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.
`x-bkly-license`	Obrigatório. Id da licença bancária vinculada ao produto.

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.
`branch`	`query`	Agência associada à conta consultada.

🚧
Importante
Caso a consulta seja de uma conta corrente, é necessário informar o code e a branch.

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 os dados do saldo da conta.
`balance.inProcess`	`object`	Objeto que contém informações sobre saldo em processamento.
`balance.inProcess.amount`	`number`	Valor do saldo em processamento.
`balance.inProcess.currency`	`string`	Sigla da moeda do saldo, de acordo com a ISO 4217. Exemplos: “BRL”.
`balance.available`	`object`	Objeto que contém informações sobre saldo disponível na conta.
`balance.available.amount`	`number`	Valor do saldo disponível.
`balance.available.currency`	`string`	Sigla da moeda do saldo, de acordo com a ISO 4217. Exemplos: “BRL”.
`balance.blocked`	`object`	Objeto que contém informações sobre saldo bloqueado na conta.
`balance.blocked.amount`	`number`	Valor do saldo bloqueado.
`balance.blocked.currency`	`string`	Sigla da moeda do saldo, de acordo com a ISO 4217. Exemplos: “BRL”.
`status`	`string`	Situação da conta, que pode ser active ou closed.
`branch`	`string`	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 os dados bancários da conta.
`bank.ispb`	`string`	ISPB do banco.
`bank.code`	`string`	Código do banco.
`bank.name`	`string`	Nome 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": "2020",
      "number": "502000027845",
      "type": "Checking",
      "bank": {
         "ispb": "01858774",
         "code": "413",
         "name": "BCO BV S.A."
      },
      "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.