Developer API Documentation

Integrate automated deposits into your website or gaming platform in 5 minutes.

Version 1.0 (Live)
POST
1. Create Payment Request (Generate Checkout Session)

When a customer initiates a deposit on your platform, send a backend POST request to PaidFaster to generate their hosted checkout session URL:

API Endpoint:
POST https://paidfaster.site/api/create_payment.php
Request Payload (JSON or POST Form-Data):
{
    "api_key": "pk_live_your_merchant_api_key",
    "order_id": "YOUR_WEBSITE_ORDER_12345",
    "amount": 500,
    "customer_mobile": "03481234567",
    "callback_url": "https://yourwebsite.com/api/payment_webhook.php",
    "return_url": "https://yourwebsite.com/deposit_success.php"
}
Successful Response (HTTP 200 OK):
{
    "status": "success",
    "message": "Payment created successfully.",
    "order_id": "PAY_98234BCA7189",
    "merchant_order_ref": "YOUR_WEBSITE_ORDER_12345",
    "amount": 500.00,
    "currency": "PKR",
    "checkout_url": "https://paidfaster.site/checkout.php?order=PAY_98234BCA7189",
    "expires_at": "2026-10-13 18:30:00"
}
Next Action: Redirect your customer to checkout_url. The customer will pay via Easypaisa, JazzCash, or Bank QR, and verification starts automatically.
WEBHOOK / IPN
2. Instant Webhook Notification (Automated Credit)

As soon as the customer payment is verified, PaidFaster instantly sends an HMAC-SHA256 signed POST notification to your specified callback_url:

Payload Sent to Your Callback URL:
{
    "event": "payment.paid",
    "order_id": "PAY_98234BCA7189",
    "merchant_order_ref": "YOUR_WEBSITE_ORDER_12345",
    "amount": 500.00,
    "net_amount": 500.00,
    "fee": 0.00,
    "trx_id": "57170923045",
    "sender_mobile": "03481234567",
    "status": "paid",
    "paid_at": "2026-10-13 18:15:30",
    "timestamp": 1760364930,
    "signature": "hmac_sha256_hash_here"
}
PHP Example to Handle Webhook on Your Website:
<?php
$payload = json_decode(file_get_contents('php://input'), true);

if ($payload && isset($payload['status']) && $payload['status'] === 'paid') {
    $orderRef = $payload['merchant_order_ref'];
    $amount = (float)$payload['amount'];
    $trxId = $payload['trx_id'];

    // 1. Credit player balance in your platform database
    // updateUserBalance($orderRef, $amount, $trxId);

    // 2. Respond with HTTP 200 OK
    http_response_code(200);
    echo json_encode(['status' => 'acknowledged']);
    exit;
}
?>
GET
3. Query Payment Status API

If you need to verify or poll transaction state directly:

GET https://paidfaster.site/api/check_status.php?order_id=PAY_98234BCA7189
Response Sample:
{
    "status": "success",
    "order_id": "PAY_98234BCA7189",
    "merchant_order_ref": "YOUR_WEBSITE_ORDER_12345",
    "amount": 500.00,
    "payment_status": "paid",
    "is_paid": true,
    "trx_id": "57170923045",
    "paid_at": "2026-10-13 18:15:30"
}
FORWARDER APP
4. Android SMS Forwarder Webhook Endpoint

Configure your Android notification/SMS forwarder application with this URL:

https://paidfaster.site/get_webhook.php?msg={msg}&time={time}&app={app-name}
Supports both GET query parameters and raw POST JSON payloads.