> ## Documentation Index
> Fetch the complete documentation index at: https://docs.switch.vaultera.co/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference Overview

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](start/exploration-guide) 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

| Environment | API URL                               | Dashboard URL                         |
| ----------- | ------------------------------------- | ------------------------------------- |
| Sandbox     | `https://api.test.switch.vaultera.co` | `https://app.test.switch.vaultera.co` |
| Production  | `https://api.switch.vaultera.co`      | `https://app.switch.vaultera.co`      |

### Authentication

All API requests require authentication using your API keys. See the [API Key](api-reference/api-key/api-key--create) guide for details on creating and managing your keys.

Your API key should be included in the request header as:

```http theme={"system"}
Authorization: Bearer YOUR_API_KEY
```

## Your First Payment

Ready to make your first payment? Follow these steps:

* **[Create a Payment](api-reference/payments/payments--create)** - Initiate a new payment
* **[Confirm a Payment](api-reference/payments/payments--confirm)** - Confirm the payment after customer authentication
* **[Capture a Payment](api-reference/payments/payments--capture)** - Capture authorized funds
* **[Cancel a Payment](api-reference/payments/payments--cancel)** - Cancel before capture if needed

## API Endpoints

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

* **[Payments](api-reference/payments/Introduction--to--payments)** - Create, confirm, capture, and manage payments
* **[Payment Methods](api-reference/payment-methods/paymentmethods--create)** - Handle saved payment methods
* **[Customers](api-reference/customers/customers--create)** - Manage customer information
* **[Refunds](api-reference/refunds/refunds--create)** - Process full and partial refunds
* **[Disputes](api-reference/disputes/disputes--list)** - Handle payment disputes and chargebacks
* **[Merchant Account](api-reference/merchant-account/merchant-account--create)** - Configure merchant accounts
* **[Routing](api-reference/routing/routing--create)** - Configure payment routing rules
* **[Webhooks & Events](api-reference/event/events--list)** - Receive real-time updates
* And more...

## 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

```json theme={"system"}
{
  "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](essentials/rate_limit) guide for details.

## Need Help?

* Check the [Error Codes](essentials/error_codes) reference
* Review the [Go Live Checklist](essentials/go-live)
* Contact [Support](mailto:switch@vaultera.co)