Manual do Dev
InstitucionalBlogService DeskStatus Page

Consulta de dados de uma conta

stable

Suggest Edits

Este endpoint retorna os dados de uma conta regular, seja de pagamentos ou corrente.

Requisição

Requisição HTTP

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

--location --request GET '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:

ScopeDescrição
account.readConcede acesso para consultar informações (status, saldo etc.) sobre uma conta de pagamentos.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

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

NomeTipoDescrição
accountNumberpathObrigatório. Número da conta.
includeBalancequeryInclui o saldo da conta na pesquisa. Informe true ou false.
codequeryCódigo do banco da conta consultada. O valor default é 332.
branchqueryNúmero da 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:

NomeTipoDescrição
balanceobjectObjeto que contém os dados do saldo da conta.
balance.inProcessobjectObjeto que contém informações sobre saldo em processamento.
balance.inProcess.amountnumberValor do saldo em processamento.
balance.inProcess.currencystringSigla da moeda do saldo, de acordo com a ISO 4217. Exemplos: “BRL”.
balance.availableobjectObjeto que contém informações sobre saldo disponível na conta.
balance.available.amountnumberValor do saldo disponível.
balance.available.currencystringSigla da moeda do saldo, de acordo com a ISO 4217. Exemplos: “BRL”.
balance.blockedobjectEste 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.amountnumberValor do saldo bloqueado, o qual sempre retornará 0.
balance.blocked.currencystringSigla da moeda do saldo, de acordo com a ISO 4217. Exemplos: “BRL”.
statusstringSituação da conta, que pode ser active ou closed.
branchstringNúmero da agência associada à conta consultada.
numberstringNúmero da conta consultada.
typestringTipo de conta, que pode ser checking (corrente) ou payment (pagamento).
bankobjectObjeto que contém os dados bancários da conta.
bank.ispbstringISPB do banco.
bank.codestringCódigo do banco.
bank.namestringNome do banco.
programIdstringIdentificador 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 4 months ago