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

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

Fluxo de integração

Consultar Saldo

cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas-walletreports/v1/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": 1.1
  }
}

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

CodeMessage
CBE073É necessário informar pelo menos um dos campos: account, ou documentNumber.
CBE039Account invalido.
CBE040DocumentNumber invalido.
CBE041Account possui tamanho maximo de 20 caracteres.
CBE042DocumentNumber possui tamanho maximo de 14 caracteres.
CBE089Consulta não permitida, Conta esta bloqueada.
CBE090Consulta não permitida.Conta esta encerrada.