Skip to main content
Welcome to the Vaultera Switch API Reference! If you haven’t already signed up on the dashboard and created an API key, please refer to the QuickStart section in the Documentation. Once you have your API key, you can proceed with the next steps, beginning with creating and capturing a payment. In the following sections, you’ll find detailed guidance on how the Vaultera Payment APIs work with various payment providers. These resources will help you integrate and process payments seamlessly.

​
Getting Started with the API

​
Base URLs

EnvironmentAPI URLDashboard URL
Sandboxhttps://api.test.switch.vaultera.cohttps://app.test.switch.vaultera.co
Productionhttps://api.switch.vaultera.cohttps://app.switch.vaultera.co

​
Authentication

All API requests require authentication using your API keys. See the API Key guide for details on creating and managing your keys. Your API key should be included in the request header as: 
Authorization: Bearer YOUR_API_KEY

​
Your First Payment

Ready to make your first payment? Follow these steps:

​
API Endpoints

Browse the complete API reference using the sidebar. All endpoints are organized by resource type:

​
Response Format

All API responses follow a consistent JSON structure:
  • Success responses include the requested resource data
  • Error responses include detailed error codes and messages
  • All timestamps are in ISO 8601 format

​
Example Response

{
  "status": "succeeded",
  "payment_id": "pay_1234567890",
  "amount": 1000,
  "currency": "USD",
  "created_at": "2024-01-15T10:30:00Z"
}

​
Rate Limits

API requests are subject to rate limits to ensure fair usage and system stability. See the Rate Limits guide for details.

​
Need Help?