Skip to main content

​
Overview

Welcome to the Caibo Integrated Payment Gateway (IPG) API documentation. This comprehensive guide provides everything you need to integrate Caibo’s payment processing capabilities into your applications, enabling secure and efficient payment transactions across multiple channels and payment methods.

​
About Caibo IPG

Caibo IPG is a robust payment gateway solution that supports a wide range of payment methods including credit cards, digital wallets (Apple Pay, Google Pay), UPI payments, and alternative payment methods. Our platform is designed to handle high-volume transactions with enterprise-grade security and reliability.

​
Key Features

  • Multi-Payment Method Support: Credit cards, digital wallets, UPI, QR codes, and alternative payment methods
  • 3D Secure Authentication: Enhanced security with 3DS support for card transactions
  • Host-to-Host (H2H) Integration: Direct server-to-server payment processing
  • Real-time Transaction Status: Instant payment status updates and webhooks
  • Multi-Currency Support: Process payments in multiple currencies with automatic conversion
  • Comprehensive Callback System: Support for various payment provider callbacks
  • Sandbox Environment: Full-featured testing environment for development and integration

​
Supported Payment Methods

Caibo IPG supports a comprehensive range of payment methods to meet diverse customer preferences:

​
Credit & Debit Cards

  • Visa, Mastercard, American Express: Full support for major card networks
  • 3D Secure Authentication: Enhanced security with 3DS 1.0 and 2.0 support
  • Tokenization: Secure card token storage for recurring payments
  • Multi-Currency Processing: Accept payments in multiple currencies

​
Digital Wallets

  • Apple Pay: Seamless integration with Apple’s payment ecosystem
  • Google Pay: Support for Google’s digital wallet solution
  • Secure Token Processing: Handle encrypted payment tokens securely

​
Alternative Payment Methods

  • UPI (Unified Payments Interface): Support for India’s UPI payment system
  • QR Code Payments: Generate and process QR code-based payments
  • Bank Transfers: Direct bank account debits and transfers

​
Integration Options

​
Payment Request Flow

Create payment requests and handle customer payments through our hosted payment pages or direct API integration.

​
Host-to-Host (H2H) Integration

Direct server-to-server integration for merchants who want full control over the payment experience.

​
Callback & Webhook System

Real-time notifications for payment status updates from various payment providers including:

​
API Endpoints Overview

Endpoint CategoryDescriptionKey Operations
Payment RequestsCreate and manage payment requestsCreate, retrieve, handle payment methods
PaymentsProcess various payment typesCredit card, digital wallet, UPI, QR payments
TransactionsTransaction management and statusGet transaction details and status
CustomersCustomer data managementCreate and update customer information
ExchangesCurrency conversionGet exchange rates and convert amounts
CallbacksPayment provider webhooksHandle provider-specific callbacks

​
Getting Started

​
1. Environment Setup

Use a single base URL for both Test and Production:
  • Server URL: https://apaycaibo.digital
Test vs Production: The base URL is the same. The only difference is which H2H payment method IDs are enabled for your tenant. Endpoints, request/response schemas, and error codes are identical.H2H IDs:
  • Test: 35
  • Live: 36 Use POST /payments/h2h/{id} and set id accordingly.

​
2. Authentication

All API requests require proper authentication using API keys generated from the Caibo Control Panel. Learn how to obtain and use API keys for secure payment processing.

Authentication Guide

Learn how to authenticate with Caibo IPG APIs using Control Panel-generated API keys

​
3. Create Your First Payment Request

{
  "amount": 100.00,
  "unit": "USD",
  "referenceId": "ORDER-123",
  "notifyUrl": "https://your-site.com/webhook",
  "successUrl": "https://your-site.com/success",
  "failureUrl": "https://your-site.com/failure"
}

​
4. Handle Payment Processing

Process payments using various methods:
  • Redirect customers to hosted payment pages
  • Integrate payment forms directly in your application
  • Use server-to-server H2H integration

​
Testing & Development

​
Sandbox Environment

  • Full-featured testing environment
  • Test all payment methods and scenarios
  • No real money transactions
  • Complete API access for development

​
Test Cards & Credentials

Use provided test card numbers and credentials for different payment scenarios including successful payments, declined transactions, and 3DS authentication flows.

​
Next Steps

Authentication

Set up authentication and generate API keys from the Control Panel

API Reference

Explore the complete API reference with detailed endpoint documentation

Payment Methods

Learn about supported payment methods and integration options

Integration Guide

Step-by-step integration guide with code examples