KlyroPay API Documentation

Authentication

All API requests require an API key in the request header.

X-Api-Key: your_api_key
Content-Type: application/json

PayIn

Collect UPI payments from your customers. Supports GPay, PhonePe, Paytm, BHIM and all UPI apps.

1. Create PayIn

Request Body

{
    "order_id":       "YOUR-ORDER-001",
    "amount":         1000,
    "customer_phone": "9876543210",
    "customer_name":  "Rahul Sharma"
}

Response — 201

{
    "success": true,
    "data": {
        "transaction_id": "txn_xxxxxxxxxxxxxxxx",
        "order_id":       "YOUR-ORDER-001",
        "txn_ref":        "PAYIN-REF-XXXXX",
        "amount":         1000.00,
        "commission":     10.00,
        "intent_url":     "upi://pay?pa=xxxxx&am=1000.00&cu=INR",
        "expires_in":     600,
        "status":         "pending"
    }
}

Showing the Payment to Customer

<script src="https://cdnjs.cloudflare.com/ajax/libs/
qrcodejs/1.0.0/qrcode.min.js"></script>

<div id="qrcode"></div>
<input type="hidden" id="upi-url"
    value="{{ $intentUrl }}">

<script>
new QRCode(document.getElementById('qrcode'), {
    text: document.getElementById('upi-url').value,
    width: 220, height: 220
});
</script>

<!-- Pass via hidden input to avoid
     HTML encoding issues -->
<input type="hidden" id="upi-url"
    value="{{ $intentUrl }}">

<button onclick="
    window.location.href =
    document.getElementById('upi-url').value
">
    Pay with UPI App
</button>

2. Check Payment Status

{
    "success": true,
    "data": {
        "transaction_id": "txn_xxxxxxxxxxxxxxxx",
        "order_id":       "YOUR-ORDER-001",
        "txn_ref":        "PAYIN-REF-XXXXX",
        "amount":         1000.00,
        "commission":     10.00,
        "utr":            "407241812279",
        "status":         "success",
        "created_at":     "2024-04-30T10:00:00.000000Z"
    }
}

3. Transaction History

Payout

Transfer money directly to any bank account via IMPS.

1. Initiate Payout

Request Body

{
    "mobile_no":          "9876543210",
    "beneficiary_name":   "Rahul Sharma",
    "account_no":         "1234567890",
    "ifsc":               "SBIN0001234",
    "bank_name":          "State Bank of India",
    "amount":             5000,
    "transfer_type":      "5",
    "partner_request_id": "YOUR-UNIQUE-ORDER-ID"
}

Response — Success

{
    "success": true,
    "message": "Payout transferred successfully.",
    "data": {
        "transaction": {
            "transaction_id":     "txn_xxxxxxxxxxxxxxxx",
            "reference_id":       "bank_reference_number",
            "partner_request_id": "YOUR-UNIQUE-ORDER-ID",
            "status":             "success",
            "amount":             5000.00,
            "charge":             10.00,
            "net_amount":         5010.00
        }
    }
}

Response — Pending

{
    "success": true,
    "message": "Payout is being processed. You will be notified once settled.",
    "data": {
        "transaction": {
            "status":  "pending",
            "amount":  5000.00,
            "charge":  10.00,
            "net_amount": 5010.00
        }
    }
}

2. Transaction History

3. Single Transaction

Wallet

Check your wallet balance and transaction history.

Balance

{
    "success": true,
    "data": {
        "balance":        45000.00,
        "locked_balance": 0.00
    }
}

Callback (Webhook)

KlyroPay sends a POST request to your registered callback URL when a transaction reaches a final status.

Callback Request

POST https://yourserver.com/your-callback-endpoint
Content-Type: application/json
X-KlyroPay-Event: transaction.updated
X-KlyroPay-Signature: hmac_sha256_signature

{
    "event":          "transaction.updated",
    "transaction_id": "txn_xxxxxxxxxxxxxxxx",
    "service":        "payin",
    "status":         "success",
    "amount":         1000.00,
    "commission":     10.00,
    "net_amount":     990.00,
    "order_id":       "YOUR-ORDER-001",
    "txn_ref":        "PAYIN-REF-XXXXX",
    "utr":            "407241812279",
    "timestamp":      "2024-04-30T10:05:00.000000Z"
}

{
    "event":              "transaction.updated",
    "transaction_id":     "txn_xxxxxxxxxxxxxxxx",
    "service":            "payout",
    "status":             "success",
    "amount":             5000.00,
    "commission":         10.00,
    "net_amount":         5010.00,
    "reference_id":       "bank_ref_number",
    "partner_request_id": "YOUR-ORDER-ID",
    "timestamp":          "2024-04-16T10:30:00.000000Z"
}

Verify Signature

Always verify the signature to ensure the callback is from KlyroPay.

$sig      = $_SERVER['HTTP_X_KLYROPAY_SIGNATURE'];
$payload  = json_decode(
    file_get_contents('php://input'), true
);
$expected = hash_hmac(
    'sha256',
    json_encode($payload),
    'YOUR_API_KEY'
);

if (!hash_equals($expected, $sig)) {
    http_response_code(401);
    exit;
}

// Valid — process the callback
http_response_code(200);
echo json_encode(['status' => 'ok']);

const crypto = require('crypto');

const sig = req.headers[
    'x-klyropay-signature'
];
const expected = crypto
    .createHmac('sha256', 'YOUR_API_KEY')
    .update(JSON.stringify(req.body))
    .digest('hex');

if (!crypto.timingSafeEqual(
    Buffer.from(expected),
    Buffer.from(sig)
)) {
    return res.status(401).send('Unauthorized');
}

res.status(200).json({ status: 'ok' });

Error Reference

All error responses follow this format:

{ "success": false, "message": "Error description.", "data": null }

Quick Reference