A referência está organizada por módulo. Dentro de cada módulo, as ações estão agrupadas por recurso. Cada página descreve uma ação concreta — por exemplo, “Listar vendedores” — e mostra o método e o caminho HTTP correspondentes.

​
Módulos

Autenticação e usuários

Sessão, registro, recuperação de senha, usuários, grupos e acessos.

Vendedores

Cadastro de vendedor, registro na infraestrutura de pagamento e consulta de MCC.

Vendas

Transações, links de checkout, cobranças, planos de pagamento e estornos.

Planos

Planos de taxa e planos de split.

Contas unificadas

Contas, movimentação financeira, pontos de venda, documentos e métricas.

Eventos

Sistema de ingressos — eventos, ingressos, vendas, cupons e fluxo público.

Assinaturas

Cobrança recorrente — planos, assinantes, pagamentos e fluxo público.

Contas virtuais

Sub-razões financeiras dentro de uma conta unificada e seus lançamentos.

Integrações do vendedor

Webhooks de saída e chaves de API.

​
URL base

URL de produção: https://api.dlpay.cloud. Todos os exemplos usam essa URL base. Ajuste se estiver chamando outro ambiente.

​
Como ler uma página da referência

Toda página de endpoint contém:
  • Título da ação (ex.: “Listar vendedores”), com o método e caminho logo abaixo.
  • Autenticação — qual mecanismo é exigido (JWT, chave de API ou público).
  • Parâmetros de path — valores obrigatórios embutidos na URL.
  • Parâmetros de query — filtros e modificadores opcionais.
  • Corpo da requisição — campos e tipos, com os obrigatórios destacados.
  • Resposta — campos e tipos no corpo de sucesso, com um exemplo JSON.
  • Erros — falhas comuns e o que significam.
  • Exemplos à direita em curl, Python e JavaScript.
  • Dependências — outros recursos ou passos que a chamada assume que já existem.