Documentação
DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Saldo Dia & Movimentações Diárias Consolidadas

Suggest Edits

Este endpoint retorna o saldo total da conta no dia, juntamente com um resumo das transações realizadas, individualizadas por tipo (créditos, débitos, etc.), para o período até o horário de corte diário, que é às 00:00.

🚧

Atenção

O acesso a este endpoint está disponível somente mediante solicitação do cliente para liberação. Caso tenha interesse, entre em contato com o suporte.


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 'https://sandbox.openfinance.celcoin.dev/baas-walletreports/v1/wallet/dayBalance?account=3005396817799&dateFrom=2024-11-12&dateTo=2024-11-13&ShowMovementType=false&Order=asc' \
--header 'accept: application/json' \
--header 'authorization: Bearer {{token}}'

Exemplo de retorno

👍

Sucesso 200

{
    "status": "SUCCESS",
    "version": "1.0.0",
    "totalItems": 2,
    "currentPage": 1,
    "limitPerPage": 20,
    "totalPages": 1,
    "dateFrom": "2024-11-12T00:00:00",
    "dateTo": "2024-11-13T23:59:59.9999999",
    "body": {
        "account": "300539681779",
        "documentNumber": "36676319012",
        "currentBalance": 0.01,
        "balances": [
            {
                "date": "2024-11-12",
                "balance": 2.94,
                "totalMovement": 0.00,
                "totalMovementDebit": 0.00,
                "totalMovementCredit": 0.00,
                "qtdMovement": 0,
                "qtdMovementDebit": 0,
                "qtdMovementCredit": 0
            },
            {
                "date": "2024-11-13",
                "balance": 0.00,
                "totalMovement": -2.94,
                "totalMovementDebit": -25.56,
                "totalMovementCredit": 22.62,
                "qtdMovement": 4,
                "qtdMovementDebit": 3,
                "qtdMovementCredit": 1
            }
        ]
    }
}

Exemplo de retorno com o parâmetro: ShowMovementType = true

👍

Sucesso 200

{
    "status": "SUCCESS",
    "version": "1.0.0",
    "totalItems": 1,
    "currentPage": 1,
    "limitPerPage": 20,
    "totalPages": 1,
    "dateFrom": "2024-11-13T00:00:00",
    "dateTo": "2024-11-13T23:59:59.9999999",
    "body": {
        "account": "300539681779",
        "documentNumber": "36676319012",
        "currentBalance": 0.01,
        "balances": [
            {
                "date": "2024-11-13",
                "balance": 0.00,
                "totalMovement": -2.94,
                "totalMovementDebit": -25.56,
                "totalMovementCredit": 22.62,
                "qtdMovement": 4,
                "qtdMovementDebit": 3,
                "qtdMovementCredit": 1,
                "movements": [
                    {
                        "qtdMovement": 3,
                        "totalMovement": 25.56,
                        "balanceType": "Debito",
                        "movementType": "PIXPAYMENTOUT",
                        "movementDescription": "Pagamento Pix",
                        "date": "2024-11-13"
                    },
                    {
                        "qtdMovement": 1,
                        "totalMovement": 22.62,
                        "balanceType": "Credito",
                        "movementType": "TEFTRANSFERIN",
                        "movementDescription": "Recebimento de Transferencia entre contas BaaS ",
                        "date": "2024-11-13"
                    }
                ]
            }
        ]
    }
}

Descrição dos Campos de Retorno

Nome do CampoDescrição
accountNumero da Conta
documentNumberNumero do Documento
currentBalanceSaldo no momento da consulta
balances[Array
dateSaldo dia do cliente no dia 28/10
balanceValor do saldo dia no dia do campo "date" (Saldo as 00 hrs)
totalMovementValor total de movimentações do cliente no dia
totalMovementDebitValor total de movimentações de debito
totalMovementCreditValor total de movimentações de credito
qtdMovementQuantidade de movimentações
qtdMovementDebitQuantidade de movimentações de debito
qtdMovementCreditQuantidade de movimentações de credito
movements[Array
qtdMovementQuantidade de movimentações
totalMovementValor total de movimentações
balanceTypeTipo de lançamento (debito ou credito)
movementTypeTipo de movimentação (PIXPAYMENTOUT)
movementDescriptionDescrição da movimentação (Pagamento Pix)
dateData onde ocorreu as movimentações



❗

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
CBE039Account invalido.
CBE030Não encontramos nenhuma conta através do parâmetro informado.
CBE153dateFrom e dateTo são obrigatórios para busca dos lançamentos.
CBE068dateFrom não pode ser maior que dateTo.
CBE376Diferença entre dateFrom e dateTo não pode ultrapassar 7 dias.
CBE152Página informada não contem lançamentos

Updated 1 day ago