Referência completa da API REST Dinie v3. Orientada a recursos, com URLs previsíveis, JSON e códigos HTTP padrão.
| Ambiente | URL |
|---|---|
| Sandbox | https://api-dev.dinietech.io/api/v3 |
| Produção | https://api.dinie.com/api/v3 |
Todos os exemplos desta documentação usam a URL de sandbox. Substitua ao ir para produção. Veja o guia Indo para Produção para o checklist completo.
Entenda os fundamentos técnicos antes de integrar:
Autenticação
OAuth 2.0 client credentials, tokens de acesso e rotação de credenciais.
Erros
Estrutura de erro padrão, códigos HTTP, tipos de erro e resolução.
Webhooks
Verificação de assinatura, retentativas, eventos disponíveis e Standard Webhooks.
Idempotência
Como usar Idempotency-Key para garantir operações seguras em retentativas.
Paginação
Paginação baseada em cursor, parâmetros de listagem e navegação de resultados.
Cadastre e gerencie clientes (empresas tomadoras de crédito).
| Método | Endpoint | Descrição |
|---|---|---|
POST | /customers | Cadastrar cliente |
GET | /customers | Listar clientes |
GET | /customers/:id | Consultar cliente |
PATCH | /customers/:id | Atualizar cliente |
POST | /customers/:id/kyc-attachments | Enviar documento KYC |
POST | /customers/:id/biometrics | Sessão de biometria |
GET | /customers/:id/bank-account | Consultar conta bancária |
POST | /customers/:id/bank-account | Criar ou atualizar conta bancária |
GET | /banks | Listar bancos |
Consulte ofertas de crédito geradas automaticamente pela análise da Dinie.
| Método | Endpoint | Descrição |
|---|---|---|
GET | /customers/:id/credit-offers | Listar ofertas do cliente |
GET | /credit-offers | Listar todas as ofertas |
GET | /credit-offers/:id | Consultar oferta |
Simule, crie e consulte empréstimos a partir de ofertas de crédito.
| Método | Endpoint | Descrição |
|---|---|---|
POST | /credit-offers/:id/simulations | Criar simulação |
POST | /loans | Criar empréstimo |
GET | /loans/:id | Consultar empréstimo |
GET | /loans/:id/transactions | Listar transações |
Configure endpoints para receber notificações de eventos em tempo real.
| Método | Endpoint | Descrição |
|---|---|---|
POST | /webhooks/endpoints | Criar endpoint |
GET | /webhooks/endpoints | Listar endpoints |
GET | /webhooks/endpoints/:id | Consultar endpoint |
PATCH | /webhooks/endpoints/:id | Atualizar endpoint |
DELETE | /webhooks/endpoints/:id | Remover endpoint |
POST | /webhooks/endpoints/:id/rotate-secret | Rotacionar secret |
GET | /webhooks/endpoints/:id/deliveries | Listar entregas |
POST | /webhooks/endpoints/:id/deliveries/:delivery_id/retry | Reenviar entrega |