README

Pay Bridge is a PHP library that provides a consistent way to integrate multiple payment gateways (Pakistan-focused). Each gateway has its own *Client (configuration + HTTP) and *API (operations) class.

Table of Contents

• Requirements
• Installation
• Quick Start
• Examples
• Gateways
• Docs
• Configuration
• Error Handling
• Security Notes
• License

Requirements

• PHP ^8.0
• Extensions: ext-curl, ext-json, ext-openssl

Installation

To install Pay Bridge, you can use Composer. Run the following command:

composer require shaqi-labs/pay-bridge

Quick Start

Every gateway follows the same pattern:

1. Create a *Client with your credentials/config
2. Create a *API using that client
3. Call the API methods

Example (AbhiPay):

<?php
require __DIR__ . '/vendor/autoload.php';

use ShaqiLabs\AbhiPay\AbhiPayAPI;
use ShaqiLabs\AbhiPay\AbhiPayClient;

$client = new AbhiPayClient([
    'merchant_id' => 'YOUR_MERCHANT_ID',
    'secret_key' => 'YOUR_SECRET_KEY',
    'return_url' => 'https://example.com/return',

    // Optional network hardening (defaults are already set)
    'timeout' => 30,
    'connect_timeout' => 10,
]);

$api = new AbhiPayAPI($client);

$result = $api->createCheckoutLink([
    'amount' => 25.30,
    'description' => 'Test order',
], 'url'); // url / response / redirect

var_dump($result);

Examples

Examples live in examples/ and use placeholder credentials (replace with your sandbox/production values).

composer install
php examples/AbhiPay.php

Gateways

Docs

• Usage guides (per gateway) are in src/<Gateway>/Usage Guide <Gateway>.md and linked in the table above.
• PDF/API documentation shipped in this repo (see docs/):
  • Alfalah APG: API Docs Alfalah APG (PDF)
  • BaadMay: API Docs BaadMay (PDF)
  • JazzCash: API Docs JazzCash (PDF)
  • UBL: Api Docs UBL (PDF)
• Internal notes (this repo):
  • PayFast: Notes
  • EasyPaisa: Notes

Configuration

• Most clients accept:
  • environment (usually sandbox / production, where supported)
  • timeout (seconds) and connect_timeout (seconds)
• Where supported, prefer returning data/URL and handle redirects in your application:
  • AbhiPay: createCheckoutLink($order, 'url' | 'response' | 'redirect')
  • BaadMay: createCheckoutLink($order, 'url' | 'response' | 'redirect')

Error Handling

• Each gateway throws its own exception class (e.g. ShaqiLabs\AbhiPay\AbhiPayException).
• Network layer throws on:
  • cURL errors
  • HTTP status >= 400
  • Unparsable JSON responses (where JSON is expected)

Security Notes

• Never commit real merchant credentials / API keys into the repository.
• Use environment variables or a secrets manager in production.
• Avoid automatic redirects inside libraries when building APIs/CLI apps; return URLs/data and redirect at the application layer.

License

MIT