API Documentation v1

Quick Start

Central Payment API v1 provides a unified interface for processing payments across multiple providers with enhanced hosted checkout, multi-gateway fallbacks, and comprehensive transaction management. Get started in minutes with our simple REST API.

Required Headers

X-Api-Key: your_api_key
X-Signature: hmac_sha256_signature  
X-Timestamp: unix_timestamp
Content-Type: application/json

POST /api/v1/payments/hosted-url
{
  "amount": 99.99,
  "currency": "USD",
  "description": "Premium upgrade",
  "customer_email": "user@example.com",
  "return_url": "https://yoursite.com/success"
}

POST /api/v1/subscriptions
{
  "customer_email": "user@example.com",
  "customer_name": "John Doe",
  "plan_id": "plan_premium_monthly",
  "trial_days": 14
}

Authentication

Central Payment API uses HMAC-SHA256 signatures for secure authentication. Each request must include your API key and a properly signed request.

Generating Signatures

const crypto = require('crypto');

function generateSignature(timestamp, body, secretKey) {
    const payload = `${timestamp}.${body}`;
    return crypto
        .createHmac('sha256', secretKey)
        .update(payload)
        .digest('hex');
}

API Endpoints

Subscription Management API

Central Payment API v1 provides comprehensive subscription management with automated recurring billing, flexible plans, invoice generation, and complete lifecycle management. Perfect for SaaS, membership sites, and any business requiring recurring payments.

Subscription Lifecycle

Available Plans

Invoice & Billing

Example: Create Subscription

POST /api/v1/subscriptions
Content-Type: application/json
X-Api-Key: your_api_key
X-Signature: hmac_sha256_signature
X-Timestamp: unix_timestamp

{
  "customer_email": "customer@example.com",
  "customer_name": "John Doe",
  "plan_id": "plan_premium_monthly",
  "start_date": "2025-01-01",
  "trial_days": 14,
  "metadata": {
    "source": "website",
    "campaign": "winter_sale"
  }
}

{
  "success": true,
  "subscription": {
    "id": "sub_1234567890",
    "status": "trialing",
    "customer": {
      "email": "customer@example.com",
      "name": "John Doe"
    },
    "plan": {
      "id": "plan_premium_monthly",
      "name": "Premium Monthly",
      "price": 29.99,
      "currency": "USD",
      "billing_cycle": "monthly"
    },
    "trial_end": "2025-01-15T00:00:00Z",
    "current_period_start": "2025-01-01T00:00:00Z",
    "current_period_end": "2025-02-01T00:00:00Z",
    "created_at": "2025-01-01T12:00:00Z"
  }
}

This integration kit contains all the essential endpoints for building applications with Central Payment API.

Webhooks

v1 webhooks provide enhanced event notifications with automatic retry mechanisms, comprehensive delivery tracking, and bidirectional webhook management. All webhooks are signed with HMAC-SHA256 for security.

v1 Key Features