API
API overview
The merchant payment API is the Payment Engine.
Base URLs
| Environment | Base URL |
|---|---|
| Live | https://merchant.venpays.com |
| Sandbox | https://init-vpay.venlabs.link |
Conventions
- JSON request and response bodies
- Auth header:
X-API-KEY: <your-secret-or-legacy-key>(not a publishable key) - Primary identifier:
track_id - Amounts are decimal numbers (BHD commonly uses three decimal places)
Endpoint groups
| Group | Docs |
|---|---|
| Initiate / status / refund | Initiate, Status, Refunds |
| Chooser | Payment chooser |
| JavaScript checkout | JavaScript checkout SDK |
| Flutter checkout | Flutter checkout SDK |
| Subscriptions | Subscriptions API |
| Streams | Streams API |
| Native Apple Pay | Apple Pay iOS |
Prefer webhooks for asynchronous updates, and use exponential backoff if you poll status.