REST APIs

Use these endpoints for operational setup beyond creating checkouts.

• POST /webhooks — register your webhook endpoint to receive normalized payment updates.
• POST /tenant — create or update tenant configuration (provider, props, and secrets references).
• GET /health — health and deployment status checks.

POST /webhooks
Content-Type: application/json
X-Tenant-ID: TENANT_ABC
X-APIKEY: TENANT_API_KEY

{
  "url": "https://your-app.com/payment/webhook",
  "events": ["payment.succeeded", "payment.failed", "payment.cancelled"]
}

Create this endpoint in your app and use it to update your order state and execute business logic.

{
  "event": "payment.succeeded",
  "payment": {
    "id": 321,
    "externalId": "order-1001",
    "tenantId": "TENANT_ABC",
    "status": "succeeded",
    "amount": 19999,
    "currency": "ZAR",
    "checkoutId": "chk_123"
  },
  "original": {
    "provider": "paystack",
    "eventType": "charge.success",
    "raw": {}
  }
}

On receive: validate payload, update order status, and run fulfilment (credits/tickets/subscription activation).