API do Open Finance

23 endpoints em 6 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

24 endpoints

Configuração de provedor

/open-finance/api/v1/provider-configs7

POST/open-finance/api/v1/provider-configsCria a configuração; testa a credencial antes de cifrar e gravarOPENFINANCE_ADMIN
GET/open-finance/api/v1/provider-configsLista, paginadoOPENFINANCE_READ
GET/open-finance/api/v1/provider-configs/:idBusca uma configuraçãoOPENFINANCE_READ
PATCH/open-finance/api/v1/provider-configs/:idAtualiza nome, credenciais, ajustes ou statusOPENFINANCE_ADMIN
DELETE/open-finance/api/v1/provider-configs/:idExclusão lógica. Responde 204OPENFINANCE_ADMIN
POST/open-finance/api/v1/provider-configs/:id/set-defaultMarca como padrão da organizaçãoOPENFINANCE_ADMIN
POST/open-finance/api/v1/provider-configs/:id/testTesta a conexão com o provedorOPENFINANCE_ADMIN

/open-finance/api/v13

POST/open-finance/api/v1/connect/tokenGera o token do widget de autorização. Responde 201OPENFINANCE_WRITE
GET/open-finance/api/v1/connectorsLista as instituições disponíveis. Filtros: filter[name], filter[types], filter[countries], configIdOPENFINANCE_READ
GET/open-finance/api/v1/connectors/:idDetalhe de uma instituição. O :id é **numérico**OPENFINANCE_READ

/open-finance/api/v1/items7

POST/open-finance/api/v1/items/syncRegistra o item criado no widget. Responde 201OPENFINANCE_WRITE
GET/open-finance/api/v1/itemsLista itens. Filtros: filter[status], filter[personId], filter[businessId]OPENFINANCE_READ
GET/open-finance/api/v1/items/:idBusca um itemOPENFINANCE_READ
POST/open-finance/api/v1/items/:id/refreshAtualiza estado e consentExpiresAt a partir do provedorOPENFINANCE_WRITE
POST/open-finance/api/v1/items/:id/sync-dataSincroniza contas, transações e identidadeOPENFINANCE_WRITE
POST/open-finance/api/v1/items/:id/link-personLiga o item a uma pessoa do [Customers](../customers/README.md)OPENFINANCE_WRITE
DELETE/open-finance/api/v1/items/:idEncerra a conexão no provedor e faz exclusão lógica aqui. Responde 204OPENFINANCE_ADMIN

/open-finance/api/v15

GET/open-finance/api/v1/items/:itemId/accountsContas do item. Filtro: filter[accountType]OPENFINANCE_READ
GET/open-finance/api/v1/accounts/:idBusca uma contaOPENFINANCE_READ
GET/open-finance/api/v1/accounts/:accountId/transactionsLançamentos da conta. Filtros: filter[startDate], filter[endDate], filter[category]OPENFINANCE_READ
GET/open-finance/api/v1/transactions/:idBusca um lançamentoOPENFINANCE_READ
GET/open-finance/api/v1/items/:itemId/identityIdentidade do titular no itemOPENFINANCE_READ

/open-finance/api/v1/webhooks1

POST/open-finance/api/v1/webhooks/:providerTypeRecebe eventos do agregador. :providerType é pluggy (aceito sem diferenciar maiúsculas)**Nenhuma** — rota pública, sem authMiddleware e sem requireOrganization

/open-finance/health1