API Docs

Documentação da API

Referência dos endpoints atuais do `z-pay-api`.

Base URL

/api/zpay

Exemplo rápido

curl -X POST "http://localhost:3000/api/zpay/v1/payment-intents" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "externalRef": "pedido-123",
    "amountCents": 19990,
    "currency": "BRL",
    "paymentMethods": ["card", "pix"],
    "metadata": { "source": "payment-test" }
  }'

Endpoints (34)

GET/v1/system/pingpublic

Healthcheck da API

POST/v1/auth/registerpublic

Cadastro da conta Z-Pay

POST/v1/auth/loginpublic

Login da conta Z-Pay

GET/v1/auth/meautenticação da conta

Perfil autenticado

GET/v1/dashboard/summaryautenticação da conta

Resumo do dashboard

GET/v1/checkoutsautenticação da conta

Lista links de pagamento

POST/v1/checkoutsautenticação da conta

Cria link de pagamento

GET/v1/checkouts/public/{id}public

Consulta checkout público

GET/v1/productsautenticação da conta

Lista produtos da loja

POST/v1/productsautenticação da conta

Cria produto da loja

GET/v1/products/public/merchant/{merchantId}public

Lista produtos públicos da loja

GET/v1/couponsautenticação da conta

Lista cupons

GET/v1/walletautenticação da conta

Resumo da carteira

GET/v1/wallet/settingsautenticação da conta

Configurações da carteira

GET/v1/wallet/split-rulesautenticação da conta

Lista regras de split

GET/v1/settingsautenticação da conta

Configurações da plataforma

GET/v1/subscriptionsautenticação da conta

Lista planos de assinatura

GET/v1/subscriptions/metricsautenticação da conta

Métricas de assinatura

GET/v1/subscriptions/providerautenticação da conta

Assinaturas por provedor interno

GET/v1/subscriptions/public/{id}public

Consulta plano público

GET/v1/subscriptions/public/merchant/{merchantId}public

Lista planos públicos por conta

POST/v1/payment-intentsautenticação da conta

Cria payment intent

POST/v1/payment-intents/{intentId}/simulate/{result}autenticação da conta

Simula resultado do pagamento

GET/v1/payments/{id}autenticação da conta

Consulta pagamento

POST/v1/payments/{id}/refundautenticação da conta

Solicita estorno

POST/v1/connect/stripe/onboardingautenticação da conta

Cria URL de onboarding do provedor

GET/v1/connect/stripe/statusautenticação da conta

Status de conexão do provedor

GET/v1/webhooks/configsautenticação da conta

Lista configs webhook

POST/v1/webhooks/configsautenticação da conta

Cria config webhook

PUT/v1/webhooks/configs/{id}autenticação da conta

Atualiza config webhook

DELETE/v1/webhooks/configs/{id}autenticação da conta

Remove config webhook

POST/v1/reconciliation/sicredi/entriesautenticação da conta

Ingestão de entrada bancária

POST/v1/reconciliation/runautenticação da conta

Executa reconciliação

GET/v1/reconciliation/entriesautenticação da conta

Lista entradas de reconciliação