Local Payments API

Overview

The Local Payments API is a completely separate API system from the main ReyPub payment APIs. It enables businesses to accept local payment methods in Pakistan, India, UAE, and Bangladesh.

Key Features

• Separate API keys - Local Payments uses its own X-LP-Key and X-LP-Secret headers
• Admin-managed gateway details - Admin configures all payment account details for security
• Business enables methods - Businesses choose which payment methods to offer, Admin sets up the details
• Admin defaults - Admin can set default gateways that are copied when a business subscribes
• Admin-only transaction approval - Admin verifies and approves/rejects all transactions
• Auto-credit on approval - Approved amounts are automatically added to business balance
• Multiple countries - Support for PK, IN, AE, BD with all local methods
• 1% settlement fee - Only charged on approved transactions
• Key regeneration - Businesses can regenerate LP API keys at any time

Pricing & Packages

Supported Countries & Methods

How It Works

Subscribe to Local Payments

Request Body

Example

{
  "package_slug": "single-country",
  "countries": ["PK"]
}

Response

{
  "success": true,
  "data": {
    "subscription_id": 1,
    "package": "Single Country",
    "countries": ["PK"],
    "api_key": "lp_pk_...",
    "api_secret": "lp_sk_...",
    "settlement_fee": "1%",
    "price_charged": 50,
    "warning": "IMPORTANT: Save your API secret now."
  }
}

Get Subscription

Manage Gateways

Enable a Payment Method

Request Body

Example - Enable JazzCash

{
  "country": "PK",
  "method_type": "jazzcash"
}

Response

{
  "success": true,
  "message": "JazzCash enabled! Admin will set up the payment details. You will be notified once it is active."
}

Toggle Gateway Active/Inactive

Response

{
  "success": true,
  "data": { "is_active": 1 },
  "message": "Gateway enabled"
}

Remove a Gateway

Transactions

Regenerate API Keys

Response

{
  "success": true,
  "data": {
    "api_key": "lp_pk_new_key...",
    "api_secret": "lp_sk_new_secret...",
    "warning": "IMPORTANT: Save your new API secret now. It will NOT be shown again. Old keys are now invalid."
  },
  "message": "API keys regenerated"
}

Dashboard

Checkout API

Checkout Authentication

Every checkout API call requires the X-LP-Key and X-LP-Secret headers. These are generated when you subscribe to Local Payments.

Get Payment Methods

Response Example

{
  "success": true,
  "data": {
    "business_name": "MyShop",
    "countries": [
      {
        "country_code": "PK",
        "country_name": "Pakistan",
        "currency": "PKR",
        "methods": [
          {
            "id": 1,
            "method_type": "jazzcash",
            "method_name": "JazzCash",
            "account_title": "Ali Ahmed",
            "account_number": "03001234567",
            "instructions": "Send to this JazzCash number"
          },
          {
            "id": 2,
            "method_type": "easypaisa",
            "method_name": "Easypaisa",
            "account_title": "Ali Ahmed",
            "account_number": "03451234567"
          }
        ]
      }
    ]
  }
}

Submit Payment

Request Body

Example

{
  "gateway_id": 1,
  "amount": 5000,
  "reference_id": "TXN123456789",
  "order_id": "ORD-001",
  "customer_name": "Muhammad Bilal",
  "customer_phone": "+923001234567"
}

Response

{
  "success": true,
  "data": {
    "transaction_id": "lp_abc123...",
    "status": "submitted",
    "amount": 5000,
    "currency": "PKR",
    "method": "JazzCash",
    "reference_id": "TXN123456789",
    "message": "Payment submitted for verification."
  }
}

Check Payment Status

Status Values

Admin API

Admin endpoints for managing the Local Payments system. All require admin Bearer token authentication.

Admin Dashboard

Default Gateways

Default gateways are template gateways that get copied to new business subscriptions. Set your own JazzCash, bank details here and they will be the default for all new businesses.

Manage Subscriptions

Process Transactions (Admin Only)

All local payment transactions must be approved or rejected by Admin. This is the only way to process transactions - businesses cannot approve/reject.

Request Body

{
  "action": "approve",  // or "reject"
  "admin_note": "Verified via JazzCash app - TXN confirmed"
}

Business Gateways (Admin)

Integration Examples

1. Subscribe to Local Payments (Business)

// Subscribe for Pakistan only ($50)
const response = await fetch('/api/local-payments/subscribe', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_BUSINESS_TOKEN'
  },
  body: JSON.stringify({
    package_slug: 'single-country',
    countries: ['PK']
  })
});
const data = await response.json();
// Save data.data.api_key and data.data.api_secret!

2. Enable JazzCash Gateway (Business)

// Business enables the method - Admin will configure the account details
await fetch('/api/local-payments/gateways/enable', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_BUSINESS_TOKEN'
  },
  body: JSON.stringify({
    country: 'PK',
    method_type: 'jazzcash'
  })
});
// Response: "JazzCash enabled! Admin will set up the payment details."
// Wait for Admin to configure details before gateway goes live

3. Checkout Flow (Customer Side)

// Step 1: Get payment methods
const methods = await fetch('/api/local-payments/checkout/methods?country=PK', {
  headers: {
    'X-LP-Key': 'lp_pk_...',
    'X-LP-Secret': 'lp_sk_...'
  }
});

// Step 2: Show payment details to customer
// Customer pays to the shown JazzCash/Bank details

// Step 3: Customer submits transaction ID
const payment = await fetch('/api/local-payments/checkout/pay', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-LP-Key': 'lp_pk_...',
    'X-LP-Secret': 'lp_sk_...'
  },
  body: JSON.stringify({
    gateway_id: 1,
    amount: 5000,
    reference_id: 'TXN123456789',
    order_id: 'ORD-001',
    customer_name: 'Muhammad Bilal'
  })
});

// Step 4: Check status
const status = await fetch(
  '/api/local-payments/checkout/status/' + payment.data.transaction_id,
  { headers: { 'X-LP-Key': 'lp_pk_...', 'X-LP-Secret': 'lp_sk_...' } }
);

4. Approve Payment (Admin Only)

// NOTE: Only Admin can approve/reject transactions
// Businesses can only VIEW their transactions
await fetch('/api/local-payments/admin/transactions/1/process', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer ADMIN_TOKEN'
  },
  body: JSON.stringify({
    action: 'approve',
    admin_note: 'Verified via JazzCash app - TXN confirmed'
  })
});
// On approval: amount minus 1% fee auto-credited to business balance

5. Regenerate LP API Keys (Business)

const response = await fetch('/api/local-payments/regenerate-keys', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_BUSINESS_TOKEN'
  }
});
const data = await response.json();
// SAVE the new api_key and api_secret immediately!
// Old keys are now invalid

Checkout Flow Diagram