Documentation
Overview
VEYRA is an API-first payment platform. These guides explain the concepts once, clearly, so the reference makes sense.
What the API does
The VEYRA API lets you accept payments, send payouts and reconcile everything against a double-entry ledger. It is a REST API with JSON bodies, predictable resource URLs, standard HTTP status codes and an OpenAPI specification.
Base URL and modes
Sandbox base URL
http://localhost:4610/v1Only the sandbox exists today. Sandbox keys start with sk_test_ and pk_test_; no request made with them can move real money. Live keys cannot be created until live processing is approved — any attempt to use a live-only action returns live_mode_disabled.
Objects and IDs
Every object has a prefixed, random ID so logs and support tickets stay readable:
| Prefix | Object |
|---|---|
| pi_ | Payment Intent |
| cs_ | Checkout Session |
| plink_ | Payment Link |
| re_ | Refund |
| cus_ | Customer |
| po_ | Payout |
| ba_ | Bank Account |
| evt_ | Event |
| we_ | Webhook Endpoint |
Where to go next
- Quickstart — your first payment in about ten minutes.
- Idempotency and Errors — the two pages that save the most production incidents.
- API reference — every endpoint, generated from the specification.