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

# Getting Started

> Platform overview, API keys, environments, and base URLs for Caibo Host-to-Host integration

# Getting Started with Caibo H2H

Welcome to Caibo's Host-to-Host (H2H) payment integration. This guide covers the essential setup steps to start processing payments through our server-to-server API.

## Platform Overview

Caibo H2H enables direct server-to-server payment processing with:

* **Multiple Payment Methods**: Credit cards, UPI, Google Pay, Apple Pay, alternative payments
* **Global Coverage**: Support for international and regional payment methods
* **Enterprise Security**: PCI DSS compliant with advanced fraud protection
* **Real-time Processing**: Instant payment processing and status updates
* **Webhook Notifications**: Real-time payment status updates

## Server URL

* Use a single API base URL for both Test and Production, as assigned by Caibo for your merchant.
* Environment selection is driven by your API key and the H2H payment method ID you use in the path.

## Environment Differences: Test vs Production

* The only difference between environments is the number of enabled H2H payment methods.
* Endpoints, request/response schemas, and error codes are identical in Test and Production.
* Production method availability depends on your tenant's configuration and compliance enablement.

## API Authentication

### API Keys

All API requests require authentication using your API key in the `X-API-Key` header:

```bash theme={null}
curl -X POST "$Caibo_H2H_ENDPOINT/payments/h2h/$Caibo_H2H_METHOD_ID" \
  -H "X-API-Key: $Caibo_API_KEY" \
  -H "Content-Type: application/json"
```

### Environment Variables

Set up your environment variables (same base URL for Test and Production; change API key and method ID per environment):

```bash theme={null}
# Server base URL (assigned by Caibo)
export Caibo_H2H_ENDPOINT="https://YOUR_API_BASE"

# Test credentials
export Caibo_API_KEY="your_test_api_key_here"
export Caibo_H2H_METHOD_ID="your_test_method_id"

# Production credentials
# export Caibo_API_KEY="your_live_api_key_here"
# export Caibo_H2H_METHOD_ID="your_live_method_id"
```

## Getting Your API Keys

1. **Sign up** for a Caibo merchant account
2. **Complete verification** process
3. **Access your dashboard** to retrieve API keys
4. **Configure webhooks** for payment notifications

<Note>
  Keep your API keys secure and never expose them in client-side code or public repositories.
</Note>

## Basic Request Structure

All H2H payment requests follow this structure:

```json theme={null}
{
  "name": "Customer Name",
  "email": "customer@example.com",
  "phoneNumber": "+1234567890",
  "address": "123 Main Street",
  "city": "New York",
  "state": "NY",
  "postalCode": "10001",
  "country": "US",
  "amount": 99.99,
  "unit": "USD",
  "originDomain": "your-store.com",
  "notifyUrl": "https://your-server.com/webhook",
  "successUrl": "https://your-store.com/success",
  "failureUrl": "https://your-store.com/failure"
}
```

## Response Format

All API responses follow a consistent format:

```json theme={null}
{
  "paymentRequestId": "pr_1234567890",
  "status": "pending",
  "redirectUrl": "https://payment-gateway.com/process",
  "message": "Payment initiated successfully"
}
```

## Rate Limits

* **Sandbox**: 100 requests per minute
* **Production**: 1000 requests per minute
* **Burst**: Up to 2x rate limit for short periods

## Next Steps

<CardGroup cols={2}>
  <Card title="10-Minute Quickstart" icon="rocket" href="/h2h/quickstart-h2h">
    Complete your first H2H payment in 10 minutes
  </Card>

  <Card title="Payment Methods" icon="credit-card" href="/h2h/payment-methods">
    Explore available payment methods
  </Card>

  <Card title="Testing & Sandbox" icon="flask" href="/h2h/testing-sandbox">
    Test cards, UPI IDs, and sandbox data
  </Card>

  <Card title="Webhooks" icon="webhook" href="/h2h/notifications">
    Set up real-time payment notifications
  </Card>
</CardGroup>

## Support

* **Documentation**: Browse our comprehensive guides
* **API Reference**: Interactive API explorer
* **Support**: Contact our technical support team
* **Status Page**: Check system status and uptime