Gestão de Recebíveis

A Agenda de Recebíveis é um sistema que registra e organiza todas as transações de cartão de crédito realizadas pelos estabelecimentos, onde é detalhado os valores que serão recebidos futuramente e as suas respectivas datas. Abaixo iremos explicar como se integrar com esse módulo do BaaS.

Caso de uso:

Como Fintech quero antecipar meu recebível de cartão de crédito para melhorar meu fluxo de caixa.

Nesse artigo você irá aprender sobre:

• Solicitar Relatório de Recebíveis
• Verificar Status do Relatório de Recebíveis
• Visualizar Relatório de Recebíveis

Pré requisitos para implementação:

• Possuir uma chave api da Celcoin, para mais informações acessar esse link
• Ter familiaridade com apis Rest usando o protocolo OAuth 2.0.
• Ter o produto/solução de sub Celcoin contratado, caso queira usar a funcionalidade em ambiente produtivo, por favor entre em contato com a nossa equipe comercial através do e-mail [email protected]. Para dúvidas técnicas, basta entrar em contato com o suporte através do link.

Solicitar Relatório de Recebíveis

Para solicitar os relatórios de seus recebíveis,, é necessário realizar uma chamada na api Solicitar Relatórios de Recebívies utilizando o método POST, onde precisa informar o período que deseja para visualizar seus recebíveis. Os dados necessários estão no quadro "Parâmetros do Body"

Modelo de requisição:

curl --location --request PUT 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/receivables' \
--header 'accept: application/json' \
--header 'Authorization: Bearer acess_token' \
--header 'Content-Type: application/json' \
--data-raw {
  "startAt": "2024-01-01",
  "endAt": "2024-01-30",
  "settlementStartDate": "2024-01-01",
  "settlementEndDate": "2024-01-30",
  "account": 17128,
  "transactions": [
    1,
    2,
    3
  ],
  "brand": [
    "visa",
    "mastercard"
  ],
  "operation": [
    "captured",
    "reversed",
    "chargeback"
  ],
  "status": [
    "payed",
    "payedPartial",
    "pending"
  ],
  "taxMdr": 1.5
}
'

📘

Atenção!!!

• O limite máximo do período de busca são 30 dias.
• O campo account é obrigatório. Informar o número da conta do BaaS que deseja buscar relatório.
• O arquivo é expirado após 24 horas.
• Os campos settlementStartDate e settlementEndDate, possuem prioridade sobre startAt e endAt, sendo obrigatório passar um dos dois conjuntos sempre

Parâmetros do Body:

Modelo de retorno: necessário validar retorno de sucesso

{
  "type": true,
  "requestId": "8c4f5d18-2fa0-4425-abce-161282e22b3e",
  "status": "PROCESSING"
}

Note que essa api é síncrona, sendo assim, a Celcoin irá retornar para você o resultado final da solicitação de cadastro da empresa.

Tabela descritiva dos campos retornados

📘

Após solicitação do relatório contéudo se tornará disponível através da notificação de receivable-report.

Verificar Status do Relatório de Recebíveis

Caso necessário verificar o status de processamento do relatório de recebíveis solicitado na etapa anterior, você pode realizar uma chamada na api Verificar Status do Relatório informando o requestId referente ao relatório solicitado, utilizando o método GET.

Modelo de request:

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/report/{requestId}
--header 'accept: application/json' \
--header 'Authorization: Bearer acess_token' \
--header 'Content-Type: application/json' \

'

Modelo de retorno:

{
  "entity": "receivable-report",
  "createdAt": "2024-09-24 23:50:00",
  "status": "completed",
  "body": {
    "requestId": "15943-hfgdjk-154",
    "files": [
      "a1b2-c3d4-1.json"
    ]
  }
}

Tabela descritiva dos campos

Visualizar Relatório de Recebíveis

Caso queira visualizar o conteúdo do arquivo de recebíveis , você deve realizar uma chamada na API Visualizar Relatório de Recebíveis utilizando o método GET

Modelo de requisição:

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/report-file/{filename}' \

Parâmetros do Body:

Modelo de retorno:

{
  "status": "success",
  "body": [
    [
      {
        "id": 100380324,
        "account": 15942,
        "paymentBillId": 10540,
        "transactionId": 10664,
        "installment": 1,
        "brand": "visa",
        "operation": "captured",
        "operationDate": "2024-09-27",
        "status": "payed",
        "originalSettlementDate": "2024-10-28",
        "advancementDate": "2024-09-28",
        "settledDate": "2024-09-28",
        "grossValue": 100,
        "netValue": 94.71,
        "taxMdr": 4.18,
        "taxAdvancement": 1.1,
        "settledValue": 100
      }

Tabela descritiva dos campos retornados