Referência

Referência da API

Gerada do contrato canônico (OpenAPI 3.1, versão 2026-11-13). Cada rota mostra a situação no código: implementada ou especificada (ainda não disponível).

Contas

Conta financeira selecionada e suas capacidades.

GET/v1/accounts/capabilitiesCapacidades e restrições da contaImplementada
GET/v1/accountConta financeira selecionada e situação do onboardingImplementada
GET/v1/account/payer-notificationsE-mails ao pagador: link do checkout e lembretesImplementada
PUT/v1/account/payer-notificationsConfigurar os e-mails ao pagador (lembretes D-3, D0, D+1 por padrão)Implementada

Clientes

Pagadores da conta.

POST/v1/customersCriar cliente pagadorImplementada
GET/v1/customersListar clientesImplementada
GET/v1/customers/{id}Consultar clienteImplementada
PATCH/v1/customers/{id}Atualizar clienteEspecificada
DELETE/v1/customers/{id}Remover cliente (exclusão lógica; histórico financeiro preservado)Especificada

Pedidos

Pedido local que agrupa as cobranças e define o total.

POST/v1/ordersCriar pedidoImplementada
GET/v1/ordersListar pedidosEspecificada
GET/v1/orders/{id}Consultar pedidoImplementada

Cobranças

Cobranças (Pix, boleto e cartão) como intenções assíncronas.

POST/v1/paymentsCriar cobrança (intenção assíncrona)Implementada
GET/v1/paymentsListar cobrançasImplementada
GET/v1/payments/{id}Consultar cobrançaImplementada
PATCH/v1/payments/{id}Alterar valor, vencimento ou descrição de cobrança pendente (intenção assíncrona)Implementada
GET/v1/payments/{id}/pixQR Code Pix da cobrançaImplementada
GET/v1/payments/{id}/boletoBoleto da cobrançaImplementada
POST/v1/payments/{id}/cancelCancelar cobrança no provedor (operação própria, ADR-0010)Implementada
GET/v1/payments/{id}/parcelsParcelas do parcelamento no cartão (status cru de cada parcela)Implementada

Operações

Acompanhamento de intenções assíncronas, inclusive resultado incerto.

GET/v1/operations/{id}Consultar operaçãoImplementada

Checkout

Checkout hospedado e captura de cartão transparente.

POST/v1/checkout-sessionsCriar sessão de checkoutImplementada
GET/v1/checkout/sessions/{id}Visão pública da sessãoImplementada(CheckoutToken)
POST/v1/checkout/sessions/{id}/confirmConfirmar pagamento na sessãoImplementada(CheckoutToken)
POST/v1/checkout/sessions/{id}/capture-sessionsContexto efêmero de captura de cartãoImplementada(CheckoutToken)
GET/v1/checkout/sessions/{id}/schedule-quoteCalendário de Pix em parcelas ou cartão mensal para exibir e aceitarImplementada(CheckoutToken)
GET/v1/checkout/offers/{code}Oferta pública pelo código do linkImplementada(sem autenticação)
POST/v1/checkout/offers/{code}/sessionsAbrir o checkout da oferta com os dados do compradorImplementada(sem autenticação)

Estornos

Devoluções limitadas ao valor elegível.

POST/v1/payments/{id}/refundsEstornar cobrança (total ou parcial, limitado ao elegível)Implementada
GET/v1/payments/{id}/refundsEstornos da cobrança (inclui os feitos fora do Eclipta Pay)Implementada
GET/v1/refunds/{id}Consultar estornoImplementada

Disputas

Chargebacks e defesa.

GET/v1/disputesListar disputasImplementada
GET/v1/disputes/{id}Consultar disputaImplementada
POST/v1/disputes/{id}/submitEnviar defesa (uma vez)Implementada
POST/v1/disputes/{id}/evidenceAnexar evidência (PDF, JPG ou PNG até 10 MB; corpo binário, nome em X-File-Name)Implementada

Assinaturas

Recorrência SaaS.

POST/v1/subscriptionsCriar assinatura SaaSImplementada
GET/v1/subscriptionsListar assinaturas (com MRR)Implementada
GET/v1/subscriptions/{id}Consultar assinaturaImplementada
PATCH/v1/subscriptions/{id}Alterar valor, ciclo ou vencimento (só cobranças futuras)Implementada
POST/v1/subscriptions/{id}/cancelCancelar assinaturaImplementada
POST/v1/subscriptions/{id}/pausePausar (para de gerar cobranças; existentes mantidas)Implementada
POST/v1/subscriptions/{id}/resumeRetomar com novo vencimentoImplementada
GET/v1/subscriptions/{id}/paymentsCobranças geradas pela assinaturaImplementada

Planos

Pix em parcelas e parcelamento mensal no cartão.

POST/v1/payment-plansCriar Pix em parcelas ou parcelamento mensal no cartãoImplementada
GET/v1/payment-plansListar planos (filtro por pedido)Implementada
GET/v1/payment-plans/{id}Consultar planoImplementada
PUT/v1/payment-plans/{id}/payment-methodTrocar cartão do planoImplementada
POST/v1/payment-plans/{id}/cancelCancelar plano (corta despachos futuros)Implementada
GET/v1/orders/{id}/schedule-quoteCalendário de um plano para o pedido (exibir e colher o aceite)Implementada

Dois cartões

Pagamento dividido em dois cartões.

POST/v1/payment-groupsPagamento com dois cartõesImplementada
GET/v1/payment-groupsListar grupos de dois cartões (filtro por pedido)Implementada
GET/v1/payment-groups/{id}Consultar grupoImplementada
POST/v1/payment-groups/{id}/refundsEstornar grupo (alocação proporcional)Implementada

Saldo

Saldos e extrato conciliado.

GET/v1/balanceSaldos observados, conciliados e elegíveisImplementada
GET/v1/statementExtrato conciliadoImplementada
GET/v1/reconciliation/casesCasos de conciliação da contaImplementada

Transferências

Favorecidos e saques com aprovação.

POST/v1/beneficiariesCadastrar favorecido (mesma titularidade; validação por pessoa com step-up e quarentena)Implementada
GET/v1/beneficiariesListar favorecidos (destino mascarado)Implementada
POST/v1/transfersSolicitar transferência (reserva saldo e aguarda aprovação no painel)Implementada
GET/v1/transfersListar transferênciasImplementada
GET/v1/transfers/{id}Consultar transferênciaImplementada
GET/v1/beneficiaries/{id}Consultar favorecidoImplementada

Webhooks

Endpoints, entregas assinadas, retentativas e reenvio.

POST/v1/webhook-endpointsCadastrar endpoint de webhookImplementada
GET/v1/webhook-endpointsListar endpoints de webhookImplementada
GET/v1/webhook-endpoints/{id}Consultar endpoint de webhookImplementada
PATCH/v1/webhook-endpoints/{id}Atualizar, pausar ou reativar endpointImplementada
DELETE/v1/webhook-endpoints/{id}Remover endpoint (cancela entregas pendentes)Implementada
POST/v1/webhook-endpoints/{id}/rotate-secretRotacionar o segredo de assinatura com sobreposiçãoImplementada
POST/v1/webhook-endpoints/{id}/testEnviar evento de teste ao endpointImplementada
GET/v1/webhook-deliveriesListar entregas de webhookImplementada
GET/v1/webhook-deliveries/{id}Consultar entrega e tentativasImplementada
POST/v1/webhook-deliveries/{id}/replayReenviar entrega (mesmo eventId)Implementada

Eventos

Catálogo versionado de eventos dos últimos 30 dias.

GET/v1/eventsEventos dos últimos 30 diasImplementada
GET/v1/events/{id}Consultar eventoImplementada
POST/v1/events/{id}/resendReenviar evento aos endpointsImplementada