API Documentation

<?php
    $my_payment_url = "https://mail.raksmeypay.com/payment/request/YOUR_PROFILE_ID";
    $profile_key = "YOUR_PROFILE_KEY"; //Replace with your Profile Key
    $transaction_id = 12345678;  // Replace with a unique transaction ID
    $amount = 0.01; // Replace with your transaction amount
    $success_url = urlencode("https://yoursite.com/payment/success?transaction_id=12345678");
    $remark = "payment from Mr.A";
    $hash = sha1($profile_key . $transaction_id . $amount . $success_url . $remark);
    $parameters = [
        "transaction_id" => $transaction_id,
        "amount" => $amount,
        "success_url" => $success_url,
        "remark" => $remark,
        "hash" => $hash
    ];
    $queryString = http_build_query($parameters);
    $payment_link_url = $my_payment_url."?".$queryString;

    //Here is Payment button to put on your website
    echo '<a style="background: #1a9bfc; color: white; padding: 10px 20px;" href="'.$payment_link_url.'">Pay Now</a>';
?>

<!-- Required: jQuery (Only if you don't have it) -->
<script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>

<!-- RaksmeyPay Modal Script -->
<script src="https://mail.raksmeypay.com/js/raksmeypay-modal.js"></script>

// Simple usage
RaksmeyPay.open('YOUR_PAYMENT_URL');

// Customized usage
RaksmeyPay.open('YOUR_PAYMENT_URL', {
    width: '600px',             // Default: 500px
    height: '700px',            // Default: 650px
    closeOnOverlayClick: true   // Default: false
});

<?php
    $qr_api_url   = "https://mail.raksmeypay.com/api/payment/qr-api/YOUR_PROFILE_ID";
    $profile_key  = "YOUR_PROFILE_KEY"; // Replace with your Profile Key
    $transaction_id = 12345678;          // Replace with a unique transaction ID
    $amount       = "5.00";              // Use the exact string you will send
    $remark       = "Order #12345";      // Optional
    $qr_template  = 1;                   // 1 = KHQR-branded card (default), 2 = plain QR

    $hash = sha1($profile_key . $transaction_id . $amount . $remark);

    $data = [
        "transaction_id" => $transaction_id,
        "amount"         => $amount,
        "remark"         => $remark,
        "qr_template"    => $qr_template,
        "hash"           => $hash,
    ];

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $qr_api_url);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $response = curl_exec($ch);
    curl_close($ch);

    $result = json_decode($response, true);
    if (!empty($result["data"]["qr_url"])) {
        // Display the QR image to the customer
        echo '<img src="' . $result["data"]["qr_url"] . '" alt="Scan to Pay">';
    }
?>

{
  "responseCode": 0,
  "responseMessage": "Success",
  "data": {
    "transaction_id": "12345678",
    "amount": "5.00",
    "qr": "00020101021229...",
    "qr_url": "https://yourdomain.com/img/payment-qr/khqr_abc123.png",
    "qr_image_url": "https://yourdomain.com/img/payment-qr/khqr_abc123.png",
    "md5": "d41d8cd98f00b204e9800998ecf8427e",
    "req_time": 1750000000,
    "hash": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"
  }
}

<?php

    $profile_key = "YOUR_PROFILE_KEY"; //Replace with your Profile Key
    $transaction_id = "YOUR_TRANSACTION_ID"; // Replace with your transaction ID

    // RaksmeyPay sends the following parameters as GET variables appended to your Success URL
    $success_time = $_GET["success_time"] ?? "";
    $success_amount = $_GET["success_amount"] ?? "";
    $bakong_hash = $_GET["bakong_hash"] ?? "";
    $success_hash = $_GET["success_hash"] ?? "";

    // Validate token expiration (180 seconds)
    if (empty($success_amount) || (time() - $success_time) > 180) {
        die("Token expired");
    }

    // Compute hash for validation
    $b4hash = $profile_key . $success_time . $success_amount . $bakong_hash . $transaction_id;
    $hash = sha1($b4hash);

    if ($success_hash === $hash) {
        // Handle successful payment
        // Ensure proper validation to prevent duplicate service provision
        echo "Payment successful";
    } else {
        die("Invalid hash");
    }

?>

<?php
    $payment_verify_url = "https://mail.raksmeypay.com/api/payment/verify/YOUR_PROFILE_ID";
    $profile_key = "YOUR_PROFILE_KEY"; //Replace with your Profile Key
    $transaction_id = 12345678; // Replace with your transaction ID
    $transaction_amount = 0.01; // Replace with your transaction amount
    $hash = sha1($profile_key . $transaction_id);
    $data = [
        "transaction_id" => $transaction_id,
        "hash" => $hash
    ];
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $payment_verify_url);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $response = curl_exec($ch);
    curl_close($ch);
    $response = json_decode($response, 1);
    // Ensure that the Payment Status and Payment Amount are correctly validated to match your transaction.
    if(!empty($response["payment_status"])
        && strtoupper($response["payment_status"]) == "SUCCESS"
        && $response["payment_amount"] == $transaction_amount){
        //code to handle payment success
        // *** Proper validation is necessary on your side to prevent the service from being provided more than once.
        echo "payment success";
    }
?>

{"status":1,"payment_amount":0.01,"payment_status":"SUCCESS"}

{"status":1,"payment_amount":0.01,"payment_status":"PENDING"}

{"status":0,"err_msg":"Payment not found"}

<?php

namespace RaksmeyPay;

class RaksmeyPaySDK {
    private $profileId;
    private $profileKey;
    private $baseUrl;

    public function __construct($profileId, $profileKey, $baseUrl = 'https://mail.raksmeypay.com') {
        $this->profileId = $profileId;
        $this->profileKey = $profileKey;
        $this->baseUrl = rtrim($baseUrl, '/');
    }

    public function generatePaymentUrl($transactionId, $amount, $successUrl, $remark = '') {
        $encodedSuccessUrl = urlencode($successUrl);
        $hash = sha1($this->profileKey . $transactionId . $amount . $encodedSuccessUrl . $remark);
        $params = [
            'transaction_id' => $transactionId,
            'amount' => $amount,
            'success_url' => $encodedSuccessUrl,
            'remark' => $remark,
            'hash' => $hash
        ];
        return $this->baseUrl . "/payment/request/" . $this->profileId . "?" . http_build_query($params);
    }

    public function createQr($transactionId, $amount, $remark = '', $qrTemplate = 1) {
        $url = $this->baseUrl . "/api/payment/qr-api/" . $this->profileId;
        $hash = sha1($this->profileKey . $transactionId . $amount . $remark);
        $data = [
            'transaction_id' => $transactionId,
            'amount' => $amount,
            'remark' => $remark,
            'qr_template' => $qrTemplate,
            'hash' => $hash
        ];
        return $this->postRequest($url, $data);
    }

    public function verifyTransaction($transactionId) {
        $url = $this->baseUrl . "/api/payment/verify/" . $this->profileId;
        $hash = sha1($this->profileKey . $transactionId);
        $data = ['transaction_id' => $transactionId, 'hash' => $hash];
        return $this->postRequest($url, $data);
    }

    public function validateSuccessHash($params, $transactionId) {
        $successTime = $params['success_time'] ?? '';
        $successAmount = $params['success_amount'] ?? '';
        $bakongHash = $params['bakong_hash'] ?? '';
        $receivedHash = $params['success_hash'] ?? '';
        $computedHash = sha1($this->profileKey . $successTime . $successAmount . $bakongHash . $transactionId);
        return $receivedHash === $computedHash;
    }

    public function validateWebhookHash($payload) {
        $transactionId = $payload['transaction_id'] ?? '';
        $amount = $payload['amount'] ?? '';
        $bakongHash = $payload['bakong_hash'] ?? '';
        $timestamp = $payload['timestamp'] ?? '';
        $receivedHash = $payload['hash'] ?? '';
        $expectedHash = sha1($this->profileKey . $timestamp . $amount . $bakongHash . $transactionId);
        return $receivedHash === $expectedHash;
    }

    private function postRequest($url, $data) {
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        $response = curl_exec($ch);
        curl_close($ch);
        return json_decode($response, true);
    }
}

require_once 'RaksmeyPaySDK.php';
use RaksmeyPay\RaksmeyPaySDK;

$sdk = new RaksmeyPaySDK("YOUR_PROFILE_ID", "YOUR_PROFILE_KEY");

$paymentUrl = $sdk->generatePaymentUrl(
    "TXN_123456", 
    "5.00", 
    "https://mysite.com/success"
);
echo '<a href="' . $paymentUrl . '">Pay Now</a>';

<?php
// Generate URL using SDK
$paymentUrl = $sdk->generatePaymentUrl("TXN_123456", "5.00", "https://mysite.com/success");
?>

<!-- Include jQuery and RaksmeyPay Script -->
<script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
<script src="https://mail.raksmeypay.com/js/raksmeypay-modal.js"></script>

<!-- Button to trigger modal -->
<button onclick="RaksmeyPay.open('<?php echo $paymentUrl; ?>')">Pay via Modal</button>

$response = $sdk->verifyTransaction("TXN_123456");

if (!empty($response['payment_status']) && $response['payment_status'] === 'SUCCESS') {
    // Payment confirmed for 5.00 USD
    if ($response['payment_amount'] == "5.00") {
        echo "Payment successful!";
    }
}

$payload = json_decode(file_get_contents("php://input"), true);

if ($sdk->validateWebhookHash($payload)) {
    // Signature is valid, proceed with processing
    $txnId = $payload['transaction_id'];
    // ...
}

<?php
// webhook.php — your endpoint that receives POST requests from RaksmeyPay

$profile_key    = "YOUR_PROFILE_KEY"; // Replace with your Profile Key
$your_api_key   = "YOUR_API_KEY";     // Replace with your Webhook API Key

// 1. Verify the X-Api-Key header
$receivedKey = $_SERVER["HTTP_X_API_KEY"] ?? "";
if ($receivedKey !== $your_api_key) {
    http_response_code(401);
    exit;
}

// 2. Decode the JSON body
$body = json_decode(file_get_contents("php://input"), true);

$transaction_id = $body["transaction_id"] ?? "";
$amount         = $body["amount"]         ?? "";
$bakong_hash    = $body["bakong_hash"]    ?? "";
$timestamp      = $body["timestamp"]      ?? "";
$hash           = $body["hash"]           ?? "";

// 3. Verify the signature
$expected_hash = sha1($profile_key . $timestamp . $amount . $bakong_hash . $transaction_id);
if (!hash_equals($expected_hash, $hash)) {
    http_response_code(400);
    exit;
}

// 4. Process the payment
// *** Ensure you handle duplicate webhooks — the same transaction_id may arrive more than once.
echo json_encode(["status" => "ok"]);
?>

{
  "transaction_id": "TXN_1718500000",
  "amount": "10.00",
  "currency": "USD",
  "status": "success",
  "profile_id": "9a0b977717b87db68d46a479be987745",
  "bakong_hash": "b7e23ec29af22b0b4e41da31e868d57226121c84",
  "timestamp": 1718500000,
  "hash": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"
}