API endpoint guide
The base URL is https://api.zewstpay.com/v1. Use your tenant API key as a Bearer token for merchant requests. This page introduces common endpoints; ask your ZewstPay representative for the full OpenAPI specification and schemas for your integration.
| Resource | Common endpoints | Purpose |
|---|---|---|
| Charges | GET /charges, POST /charges, GET /charges/{id} | List, create, and retrieve payments |
| Capture | POST /charges/{id}/capture | Capture an existing authorization |
| Refunds | POST /refunds | Request a full or partial refund |
| Customers | GET /customers, POST /customers | Manage merchant customers |
| Payment links | GET /payment_links, POST /payment_links | Manage hosted payment links |
| Subscriptions | GET /subscriptions, POST /subscriptions | Manage recurring billing |
| Webhooks | POST /webhooks | Register an event endpoint |
Read-only first request
curl 'https://api.zewstpay.com/v1/charges?limit=10' \
-H "Authorization: Bearer $ZEWSTPAY_API_KEY"
Charges return a list envelope with data and has_more. Use starting_after for cursor pagination.
Payment requests
Use integer minor units for amounts, such as 1000 for USD 10.00. Provide an Idempotency-Key where supported when creating or retrying payments. Tokenize payment details using the ZewstPay secure collection flow; never send raw card numbers to the ZewstPay API.
Capabilities, payment-method support, and asynchronous status transitions depend on your enabled account capabilities. Test the full lifecycle in your configured sandbox before enabling live payments.
Payment configuration
Use GET /v1/account/processing to inspect your account's payment mode, readiness and enabled capabilities. ZewstPay manages payment routing; processor selection and account credentials are internal. Hosted checkout selects secure card fields or a redirect through its collection.type field.
For platform splits, configure recipients with their ZewstPay recipientMerchantClientId. Each recipient must be approved under your platform in the same payment mode. Manual payouts are currently unavailable pending settlement verification. API acceptance of a payment or refund does not itself confirm bank settlement.