Documentação
DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Consultar Extrato

Suggest Edits

Essa funcionalidade permite que os clientes da Celcoin consigam realizar a consulta do extrato 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 Extrato

cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v2/wallet/movement?Account=300539137798&DateFrom=2022-10-26&DateTo=2022-10-28&DocumentNumber&LimitPerPage' \
--header 'accept: application/json' \
--header 'authorization: Bearer {{token}}'

Para chamadas específicas de um determinado horário ou período do dia, basta informas os campos DateFrom e DateTo no formato: 2022-10-26T16:04:02 - 2022-10-26T16:08:02.

Se o horário não for informado, será retornado o dia inteiro.

Também é possível informar a ordenação que deseja. As opções são decrescente ou ascendente.
Caso não seja informado nada no campo "order", será sempre considerado como ascendente.
Para ordenar as transações da mais recente para a mais antiga, informar no campo order o parametro como "desc". Obrigatório informar com letra minúscula.

Exemplo de retorno

👍

Sucesso 200

{
  "status": "SUCCESS",
  "version": "1.0.0",
  "totalItems": 200,
  "currentPage": 1,
  "totalPages": 10,
  "dateFrom": "2022-01-01",
  "dateTo": "2022-01-02",
  "body": {
    "account": "300151",
    "documentNumber": "34335125070",
    "movements": [
      {
        "id": "aa99877c-6205-45ce-8fd8-18173fdd782a",
        "clientCode": "7a2a4ea2-ee65-4b3d-8e1d-311dd45d3017",
        "description": "Recebimento Pix",
        "createDate": "2022-08-31T17:19:55",
        "lastUpdateDate": "2022-08-31T17:19:55",
        "amount": 10.12,
        "status": "Saldo Liberado",
        "balanceType": "CREDIT",
        "movementType": "PIXPAYMENTIN"
      }
    ]
  }
}

Temos a opção de exibir um objeto opcional no response caso o parâmetro AdditionalInformation seja enviado como true.


cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v2/wallet/movement?Account=300539137798&DateFrom=2022-10-26&DateTo=2022-10-28&AdditionalInformation=true' \
--header 'accept: application/json' \
--header 'authorization: Bearer {{token}}'

Exemplo de retorno

👍

Sucesso 200

Exemplo de Response:

{
  "status": "SUCCESS",
  "version": "1.0.0",
  "totalItems": 200,
  "currentPage": 1,
  "limitPerPage": 1,
  "totalPages": 10,
  "dateFrom": "2022-08-31T17:19:55",
  "dateTo": "2022-08-31T17:19:55",
  "body": {
    "account": "300151",
    "documentNumber": "34335125070",
    "movements": [
      {
        "id": "aa99877c-6205-45ce-8fd8-18173fdd782a",
        "clientCode": "7a2a4ea2-ee65-4b3d-8e1d-311dd45d3017",
        "description": "Recebimento Pix",
        "createDate": "2022-08-31T17:19:55",
        "lastUpdateDate": "2022-08-31T17:19:55",
        "amount": 10.12,
        "status": "Saldo Liberado",
        "balanceType": "CREDIT",
        "movementType": "PIXPAYMENTIN",
        "additionalInformation": {
          "nameCredit": "300151",
          "nameDebit": "34335125070",
          "oldBalance": 0.01,
          "currentBalance": 0.01
        }
      }
    ]
  }
}


Status da Transação

StatusDescrição
Saldo LiberadoTransação Concluída.
Saldo BloqueadoTransação Pendente, Aguardando Confirmação.

Tipos de Movimentação Disponível

Transferência entre contas (P2P)

EventoDescrição
TEFTRANSFERINCredito referente a um cash-in de transferência interna.
TEFTRANSFEROUTDebito referente a um cash-out de transferência interna.

Pix

movementTypeDescrição
PIXPAYMENTINCredito referente a um cash-in Pix.
PIXPAYMENTOUTDebito referente a um cash-out Pix.
PIXREVERSALOUTDebito referente a uma devolução de cash-in Pix.
PIXREVERSALINCredito referente a um recebimento de devolução de cash-out Pix.

TED

EventoDescrição
TEDTRANSFERINCrédito referente a um TED recebido.
TEDTRANSFEROUTDébito referente a um TED enviado.
TEDREVERSALOUTDébito referente a uma devolução de TED recebida.
TEDREVERSALINCrédito referente a uma devolução de TED realizada.

Cobrança Avulsa

EventoDescrição
CHARGEINCrédito referente a um pagamento recebido.

Pagamento de contas

EventoDescrição
BILLPAYMENTDébito referente a um pagamento realizado.
BILLPAYMENTCHARGEBACKCredito referente ao estorno de um pagamento.

Recargas

EventoDescrição
RECHARGEDébito referente a uma recarga realizada.
RECHARGECHARGEBACKCrédito referente ao estorno de uma recarga.

Recebimento de liquidações do arranjo de cartões via SLC (Domicílio Bancario)

EventoDescrição
SLCCrédito referente a um recebimento de recebíveis do arranjo de pagamentos de cartões por meio do SLC.

Bloqueio Judicial

EventoDescrição
JUDICIALMOVEMENTOUTLiberação de valor bloqueado.
JUDICIALMOVEMENTINBloqueio de valor por ordem judicial.

Lançamentos Financeiros

EventoDescrição
ENTRYCREDITRepresenta uma entrada de valor na conta (crédito)
ENTRYDEBITRepresenta uma saída de valor da conta (débito).

Esses lançamentos são gerados internamente pelo time de tesouraria ou operações e refletem ações como reembolsos ou ajustes no saldo na conta bolsão ou individualizada.

❗

Error 400

{
  "status": "ERROR",
  "version": "1.0.0",
  "error": {
    "errorCode": "CBE039",
    "message": "Account invalido.."
  }
}

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.
CBE066Limite sua busca entre 1 a 50.
CBE068dateFrom não pode ser maior que dateTo.
CBE153dateFrom e dateTo são obrigatórios para busca dos lançamentos.
CBE376Consulta conta não permitida. Diferença entre dateFrom e dateTo não pode ultrapassar 7 dias.
CBE080Page invalido
CBE088Limit invalido

📘

Caso tenha uma necessidade de mais de 50 transações por página, entre em contato com nosso time de especialistas explicando a sua necessidade e avaliaremos internamente a sua solicitação.

Updated 3 months ago