Consultar Saldo

Essa funcionalidade permite que os clientes da Celcoin consigam realizar a consulta do saldo de uma conta BaaS de seus cliente.

Passos para Integrar

Realizar autenticação na API - [API Reference]
Realiza a consulta na API - [Reference]

Fluxo de integração

Consultar Saldo

Campos do Request

Nome	Tipo	Descrição
account	string	Número da conta BaaS que deseja consultar. (obrigatório)
documentNumber	string	Numero do CPF ou CNPJ da conta que deseja buscar.

cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v2/wallet/balance?DocumentNumber=25400754015&Account=1234' \
--header 'accept: application/json' \
--header 'authorization: Bearer {{token}}'

Exemplo de retorno

👍
Sucesso 200

{
    "status": "SUCCESS",
    "version": "1.0.0",
    "body": {
        "amount": 5094489.74,
        "blockedAmount": 0.36,
        "totalAmount": 5094490.10
    }
}

Campos do Response

Nome	Descrição
amount	Valor do saldo disponível
blockedAmount	Valor do saldo bloqueado
totalAmount	Somatória do saldo disponível + Saldo bloqueado

❗
Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "CBE073",
    "message": "É necessário informar pelo menos um dos campos: account, ou documentNumber."
  }
}

Tabela de errorCode

Code	Message
CBE073	É necessário informar pelo menos um dos campos: account, ou documentNumber.
CBE039	Account invalido.
CBE040	DocumentNumber invalido.
CBE041	Account possui tamanho maximo de 20 caracteres.
CBE042	DocumentNumber possui tamanho maximo de 14 caracteres.
CBE089	Consulta não permitida, Conta esta bloqueada.
CBE090	Consulta não permitida.Conta esta encerrada.