API Reference
The VantagePay API is a JSON-over-HTTPS REST API.
Base URL: https://sandbox-api.vantagepay.dev/
Authentication: All endpoints (except POST /v1/auth/login) require a Bearer access token issued by the login flow. Access tokens are short-lived and refreshed using the refreshToken issued alongside the access token. See Authentication for the full lifecycle.
Standard status codes: 200 / 202 success; 400 validation error; 401 unauthorized (expired or invalid token); 403 forbidden; 404 not found; 422 unprocessable entity; 429 rate limited; 500 unexpected error.
Content type: Requests and responses use application/json.
Categories
Browse the API by domain:
- Authentication
- Lookups
- Consumers
- Merchants
- Payments
- Products
- Tokens
- Notifications
- QR Codes
- Content
- System
- Localization
- Admin APIs
SDKs
Use the official SDKs to call the API from your application: