Webhooks

📘

Callbacks para controle assíncrono

Os webhooks devem ser registradas no cadastro do cliente na plataforma CELCOIN, permitindo que a integração seja baseada em eventos assíncronos, otimizando o tempo de chamada à API.

Todas as chamadas de busca de dados na CELCOIN Open Finance API são assíncronas. O controle é feito por meio da variável informationId, utilizada para rastrear a extração de informação com base no consentimento.

O padrão da resposta dos chamados seguem o esquema de dados:

DTO padrãoDTO padrão

DTO padrão

Os seguintes webhooks estão disponíveis para registro:

  • Webhook "Consulta Saldo"
"balanceStatements":
{
    {
        "balance": float,
    };
}
  • Webhook "Consulta Crédito"
"creditStatements":
{
    {
        "date": "2020-06-10T00:00:00.000Z",
        "name": string,
        "description": string,
        "limit": float
    };
}
  • Webhook "Consulta Investimento"
"investStatements":
{
    {
        "date": "2020-06-10T00:00:00.000Z",
        "document": string,
        "entryDetail": string,
        "value": float
    };
}
"investBalanceStatements":
{
    {
        "description": string,
        "balance": float
    };
}
  • Webhook "Extrato Bancário"
"statemenetStatements":
{
    {
        "id": string,
        "value": float,
        "entry": string,
        "type": string,
        "date": "2020-06-10T00:00:00.000Z",
        "descricao": string
    };
}
  • Webhook "Extrato Consumo" Concessionária
"usageStatement":
{
    {
        "amount": float,
        "date": "2020-06-10T00:00:00.000Z",
        "dueDate": "2020-06-10T00:00:00.000Z",
        "unitMeasurement": string,
        "consumptionValue": float
    };
}
  • Webhook "Dados Consumidor" Concessionária
"userInformation":
{
    {
        "name": string,
        "document": string,
        "email": string,
        "phoneNumber": string,
        "contractNumber": string,
        "birthDate": "2020-06-10",
        "registrationNumber": int
    }
}

Exemplos dos webhooks com dados estão disponíveis na url:

Status de envio dos webhooks:

informationStatusId

Signficado

3

Sucesso ao buscar o dado

5

Login inválido

6

Falha ao buscar o dado