Comece por aqui
Endpoints
URLs da plataforma e da API em produção. Use HTTPS em todas as chamadas.
Abaixo estão as URLs da plataforma e da API do Gateway. Todas as rotas da API ficam sob o prefixo /api.
Plataforma
| Recurso | Produção |
|---|---|
| Área do desenvolvedor | https://gateway.credito-direto.com/desenvolvedores |
| Documentação | https://gateway.credito-direto.com/docs |
| Aplicação (login e dashboard) | https://gateway.credito-direto.com/login |
API do Gateway
| Recurso | Produção |
|---|---|
| Base da API | https://gateway.credito-direto.com/api |
Recursos
| Seção | Prefixo |
|---|---|
| Saúde | /api/health |
| Autenticação | /api/auth |
| Cobranças | /api/charges |
| Links de pagamento | /api/payment-links |
| Páginas públicas de link | /api/public/payment-pages |
| Saldo | /api/payments/balance |
| Pagamentos (lotes e Pix out) | /api/payments |
| Chaves Pix | /api/pix-keys |
| QR Codes | /api/qr-codes |
| Perfil | /api/profile |
| Parceiros | /api/partners |
Cartão de crédito
As rotas de cartão usam a chave X-API-KEY e a URL base entregue na habilitação do meio. O guia completo está em Ciclo de vida do cartão.
| Operação | Método e caminho |
|---|---|
| Criar cobrança | POST /v2/payment |
| Capturar | PUT /v2/creditCard/capture/{idTransaction}/{amount} |
| Estornar | DELETE /v2/creditCard/cancel/{idTransaction}/{amount} |
| Parcelamento | GET /v2/creditCard/installmentValue |
| Criar token | POST /v2/token |
| Excluir token | DELETE /v2/token/delete |
| Buscar chargeback | GET /v2/chargeback/get |
| Listar chargebacks | GET /v2/chargeback/list |
| Simular antecipação | POST /v2/anticipation/simulate |
| Efetivar antecipação | POST /v2/anticipation/effectSimulate |
Em desenvolvimento local a API responde em http://localhost:3010/api e o frontend em http://localhost:5174.