URL Base

Todas as requisições devem ser feitas para:
https://api.appzucropay.com

Autenticação

Todas as requisições (exceto webhooks recebidos) devem incluir sua API Key:
X-API-Key: zp_sua_api_key_aqui
Veja mais em Autenticação.

Endpoints Disponíveis

Cobranças

MétodoEndpointDescrição
POST/api/v1/chargesCriar nova cobrança
GET/api/v1/charges/:idConsultar cobrança
GET/api/v1/chargesListar cobranças

Saldo

MétodoEndpointDescrição
GET/api/v1/balanceConsultar saldo

Webhooks

MétodoEndpointDescrição
POST/api/webhooksCriar webhook
GET/api/webhooksListar webhooks
DELETE/api/webhooks/:idDeletar webhook

API Keys

MétodoEndpointDescrição
POST/api/v1/keysCriar API Key
GET/api/v1/keysListar API Keys
DELETE/api/v1/keys/:idRevogar API Key

Formato de Resposta

Todas as respostas são em JSON:
{
  "id": "abc123...",
  "object": "charge",
  ...
}

Códigos de Status

CódigoDescrição
200Sucesso
201Criado com sucesso
400Requisição inválida
401Não autenticado
403Sem permissão
404Não encontrado
429Rate limit excedido
500Erro interno

Erros

Erros retornam o seguinte formato:
{
  "error": "Mensagem de erro",
  "code": "ERROR_CODE",
  "details": {} // opcional
}