Webhooks Celcoin (v2)
A API v2 notifica sua aplicação quando recursos Open Finance são sincronizados. Configure endpoints no Dashboard → Webhooks (provider Celcoin) e assine os eventos desejados.
Formato do payload
Cada entrega HTTP contém um único objeto. Não há mais *.created / *.updated / *.sync nem campo changes. O fluxo é: receber o evento → consultar a listagem com query_parameters.
Campos
| Field | Type | Description |
|---|---|---|
| event | string | Nome do evento (valor do enum CelcoinWebhookEvent). Ex.: accounts, accounts.transactions. |
| resource | string | Âmbito do resource_id. Em eventos de recurso: consents. Em eventos *.transactions: accounts, credit-cards, funds, etc. (kebab-case). |
| resource_id | string (uuid) | ID do recurso. Em eventos de recurso: UUID do consentimento. Em *.transactions: UUID da conta/cartão/investimento. |
| query_parameters | string | Query string com filtros de timestamp (fromCreatedAt, toCreatedAt, fromUpdatedAt, toUpdatedAt) para buscar só o que mudou na janela da sync. Sempre presente nos eventos disparados após sincronização. |
Dois tipos de evento
Recurso ( (accounts, credit_cards, loans, …) — sincronização do recurso no consentimento. resource é sempre consents e resource_id é o UUID do consentimento.
GET https://api.polp.com.br/api/v2/consents/{resource_id}/accounts?{query_parameters}Transações (*.transactions) — transações/movimentações de um recurso específico. resource é o path kebab-case ((accounts, credit-cards, funds, …) e resource_id é o UUID desse recurso.
GET https://api.polp.com.br/api/v2/accounts/{resource_id}/transactions?{query_parameters}query_parameters
Janela da sincronização, no formato de query string. Concatene na URL da listagem:
fromCreatedAt=…&toCreatedAt=…&fromUpdatedAt=…&toUpdatedAt=…
- Filtra por
created_ateupdated_at(ISO 8601). - Quando created e updated vêm juntos, a API combina com OR.
- Empréstimos e financiamentos emitem só eventos de recurso (sem
*.transactions).
Exemplos de payload
{
"event": "accounts",
"resource": "consents",
"resource_id": "bb0e8400-e29b-41d4-a716-446655440006",
"query_parameters": "fromCreatedAt=2026-07-17T13:00:00.000000&toCreatedAt=2026-07-17T13:00:05.000000&fromUpdatedAt=2026-07-17T13:00:00.000000&toUpdatedAt=2026-07-17T13:00:05.000000"
}Em seguida chame:
GET /api/v2/consents/bb0e8400-e29b-41d4-a716-446655440006/accounts?fromCreatedAt=2026-07-17T13:00:00.000000&toCreatedAt=2026-07-17T13:00:05.000000&fromUpdatedAt=2026-07-17T13:00:00.000000&toUpdatedAt=2026-07-17T13:00:05.000000
{
"event": "accounts.transactions",
"resource": "accounts",
"resource_id": "550e8400-e29b-41d4-a716-446655440000",
"query_parameters": "fromCreatedAt=2026-07-17T13:00:00.000000&toCreatedAt=2026-07-17T13:00:05.000000&fromUpdatedAt=2026-07-17T13:00:00.000000&toUpdatedAt=2026-07-17T13:00:05.000000"
}Em seguida chame:
GET /api/v2/accounts/550e8400-e29b-41d4-a716-446655440000/transactions?fromCreatedAt=2026-07-17T13:00:00.000000&toCreatedAt=2026-07-17T13:00:05.000000&fromUpdatedAt=2026-07-17T13:00:00.000000&toUpdatedAt=2026-07-17T13:00:05.000000
{
"event": "credit_cards.transactions",
"resource": "credit-cards",
"resource_id": "660e8400-e29b-41d4-a716-446655440001",
"query_parameters": "fromCreatedAt=2026-07-17T13:00:00.000000&toCreatedAt=2026-07-17T13:00:05.000000&fromUpdatedAt=2026-07-17T13:00:00.000000&toUpdatedAt=2026-07-17T13:00:05.000000"
}Em seguida chame:
GET /api/v2/credit-cards/660e8400-e29b-41d4-a716-446655440001/transactions?fromCreatedAt=2026-07-17T13:00:00.000000&toCreatedAt=2026-07-17T13:00:05.000000&fromUpdatedAt=2026-07-17T13:00:00.000000&toUpdatedAt=2026-07-17T13:00:05.000000
{
"event": "loans",
"resource": "consents",
"resource_id": "bb0e8400-e29b-41d4-a716-446655440006",
"query_parameters": "fromCreatedAt=2026-07-17T13:00:00.000000&toCreatedAt=2026-07-17T13:00:05.000000&fromUpdatedAt=2026-07-17T13:00:00.000000&toUpdatedAt=2026-07-17T13:00:05.000000"
}Em seguida chame:
GET /api/v2/consents/bb0e8400-e29b-41d4-a716-446655440006/loans?fromCreatedAt=2026-07-17T13:00:00.000000&toCreatedAt=2026-07-17T13:00:05.000000&fromUpdatedAt=2026-07-17T13:00:00.000000&toUpdatedAt=2026-07-17T13:00:05.000000
{
"event": "funds.transactions",
"resource": "funds",
"resource_id": "880e8400-e29b-41d4-a716-446655440003",
"query_parameters": "fromCreatedAt=2026-07-17T13:00:00.000000&toCreatedAt=2026-07-17T13:00:05.000000&fromUpdatedAt=2026-07-17T13:00:00.000000&toUpdatedAt=2026-07-17T13:00:05.000000"
}Em seguida chame:
GET /api/v2/funds/880e8400-e29b-41d4-a716-446655440003/transactions?fromCreatedAt=2026-07-17T13:00:00.000000&toCreatedAt=2026-07-17T13:00:05.000000&fromUpdatedAt=2026-07-17T13:00:00.000000&toUpdatedAt=2026-07-17T13:00:05.000000