Referência da API

Operações disponíveis para pagamentos, consultas, estornos, recibos e métodos habilitados.

Antes de chamar um endpoint

Use a Base URL correta, envie x-api-key em todas as chamadas e idempotency-key em operações POST. Credenciais de Sandbox não funcionam em Produção e devem permanecer exclusivamente no backend.

curl https://api.leonapay.com.br/api/v2/companies/{companyId} \
+  --header 'Accept: application/json' \
+  --header 'x-api-key: SUA_CHAVE'

Gerenciar endpoints de webhook pela API

O POST retorna data.id: esse é o webhookId usado nas rotas de consulta, edição e exclusão. O segredo é exibido somente na criação.

Se perder o webhookId, use GET /api/v2/webhooks e localize o endpoint pela URL. O segredo não volta a ser exibido.

Método	Endpoint	Descrição
`GET`	`/api/v2/webhooks`	`Listar e recuperar os IDs`
`POST`	`/api/v2/webhooks`	`Criar e obter webhookId + segredo`
`GET`	`/api/v2/webhooks/{webhookId}`	`Consultar configuração`
`PATCH`	`/api/v2/webhooks/{webhookId}`	`Editar URL, eventos ou status`
`DELETE`	`/api/v2/webhooks/{webhookId}`	`Excluir endpoint`

curl --request POST \
+  --url https://api.leonapay.com.br/api/v2/webhooks \
+  --header 'x-api-key: SUA_CHAVE' \
+  --header 'Content-Type: application/json' \
+  --data '{"url":"https://seusite.com/leonapay/callback","events":["payment.paid","payment.failed","withdrawal.completed"]}'

# Resposta
{"success":true,"data":{"id":"wh_01J...","secret":"whsec_...","url":"https://seusite.com/leonapay/callback"}}

Pagamentos

Crie e consulte transações de qualquer método habilitado no negócio.

Método	Endpoint	Descrição
`POST`	`/api/v2/payments`	`Criar pagamento`
`GET`	`/api/v2/transactions/{transactionId}`	`Consultar pagamento por ID`

Estornos e recibos

Estornos usam uma chave de idempotência própria.

Método	Endpoint	Descrição
`POST`	`/api/v2/payments/{id}/refunds`	`Solicitar estorno`
`GET`	`/api/v2/refunds/{id}`	`Consultar estorno`
`GET`	`/api/v2/payments/{id}/receipt`	`Obter comprovante`

Métodos e webhooks

Consulte os métodos disponíveis para cada moeda e teste a entrega de eventos.

Método	Endpoint	Descrição
`GET`	`/api/v2/payment-methods`	`Métodos habilitados`
`GET`	`/api/v2/webhooks`	`Listar webhooks`
`POST`	`/api/v2/webhooks`	`Criar webhook`
`GET`	`/api/v2/webhooks/{webhookId}`	`Consultar webhook`
`PATCH`	`/api/v2/webhooks/{webhookId}`	`Editar URL, eventos ou status`
`DELETE`	`/api/v2/webhooks/{webhookId}`	`Excluir webhook`

Empresas e saldos

Consulte cadastro, saldo disponível, liberações e retenções de cada negócio.

Método	Endpoint	Descrição
`GET`	`/api/v2/companies/{companyId}`	`Consultar empresa`
`GET`	`/api/v2/companies/{companyId}/balance`	`Consultar saldo`
`GET`	`/api/v2/companies/{companyId}/balances/releasing`	`Valores em liberação`
`GET`	`/api/v2/companies/{companyId}/balances/blocked`	`Valores bloqueados`

Saques

Solicitações financeiras exigem saldo disponível, idempotência e permissão de saque.

Método	Endpoint	Descrição
`POST`	`/api/v2/withdrawals/pix`	`Solicitar saque PIX`
`POST`	`/api/v2/withdrawals/spei`	`Solicitar saque SPEI`
`POST`	`/api/v2/withdrawals/bank-transfer`	`Solicitar transferência bancária em ARS ou COP`
`POST`	`/api/v2/withdrawals/crypto`	`Sacar USDT TRC20 ou BTC`

Operações e clientes

Consulte a trilha de pagamentos, clientes e responda tratativas pelo identificador.

Método	Endpoint	Descrição
`GET`	`/api/v2/transactions/{transactionId}`	`Consultar transação`
`POST`	`/api/v2/refunds/{refundId}/responses`	`Responder estorno`
`GET`	`/api/v2/customers`	`Consultar clientes`