Introduction

Payment Gateway Specification Document

This documentation aims to provide all the information you need to work with our API.

Supported payment methods

	ABA PAY			ACLEDA Pay
	AliPay			BAKONG
	Bakong KHQR			Canadia Bank Plc.
	Chip Mong Bank			eMoney
	FTB Bank			HATTHA Bank
	iBank			KESS PAY
	KHQR			Oriental Bank
	Phillip Bank Plc			PPCBank
	Sathapana			TrueMoney
	UnionPay			Vattanac Bank
	Visa/Master Card			WeChat Pay
	Wing Bank

Authenticating

Authenticate requests to this API's endpoints by sending an Authorization header with the value "Bearer {ACCESS TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

POST {baseUrl}/oauth/token

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/oauth/token' \
--header 'Content-Type: application/json' \
    --data-raw '{
    "grant_type": "password",
    "client_id": "{CLIENT ID}",
    "client_secret": "{CLIENT SECRET}",
    "username": "{USERNAME}",
    "password": "{PASSWORD}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/oauth/token',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "grant_type": "password",
        "client_id": "{CLIENT ID}",
        "client_secret": "{CLIENT SECRET}",
        "username": "{USERNAME}",
        "password": "{PASSWORD}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
         
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    

{
    "token_type": "Bearer",
    "expires_in": "1800",
    "access_token": "ACCESS TOKEN",
    "refresh_token": "REFRESH TOKEN"
}
              
                    
                

Merchant API Gateway

Use a single endpoint to access every available service based on its service’s name and dynamical parameters.

Merchant Info

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.merchantinfo",
    "sign_type": "MD5",
    "seller_code": "{SELLER CODE}",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.merchantinfo",
        "sign_type": "MD5",
        "seller_code": "{SELLER CODE}",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "id": 6900,
        "phone_number": "010222333",
        "user_id": "CU2501-101139033689723678",
        "email": "xxx@gmail.com",
        "full_name": "xxx Admin",
        "muser_identity": null,
        "created_at": "2025-01-13 09:32:21",
        "wallet": {
            "id": "CW2501-101139033689723679",
            "balance": 0,
            "currency": "USD",
            "account_number": "000024916"
        },
        "multi_wallets": [
            {
                "id": "CW2501-101139033689723679",
                "balance": 0,
                "currency": "USD",
                "account_number": "000024916",
                "funds_type": "DEFAULT"
            },
            {
                "id": "CW2501-101139033689723680",
                "balance": 0,
                "currency": "KHR",
                "account_number": "000024917",
                "funds_type": "MAIN"
            }
        ]
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Create User

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.adduserundermerchant",
    "seller_code": "{SELLER CODE}",
    "first_name": "xx",
    "last_name": "xx",
    "phone_number": "010222333",
    "email": "xx@gmail.com",
    "muser_identity": "N0102345",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.adduserundermerchant",
        "seller_code": "{SELLER CODE}",
        "first_name" : "xx",
        "last_name" : "xx",
        "phone_number":"010222333",
        "email": "xx@gmail.com",
        "muser_identity": "N0102345",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "id": 6900,
        "phone_number": "010222333",
        "user_id": "CU2501-101139033689723678",
        "email": "xxx@gmail.com",
        "full_name": "xxx Admin",
        "muser_identity": null,
        "created_at": "2025-01-13 09:32:21",
        "wallet": {
            "id": "CW2501-101139033689723679",
            "balance": 0,
            "currency": "USD",
            "account_number": "000024916"
        },
        "multi_wallets": [
            {
                "id": "CW2501-101139033689723679",
                "balance": 0,
                "currency": "USD",
                "account_number": "000024916",
                "funds_type": "DEFAULT"
            },
            {
                "id": "CW2501-101139033689723680",
                "balance": 0,
                "currency": "KHR",
                "account_number": "000024917",
                "funds_type": "MAIN"
            }
        ]
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

List User Under Merchant

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.getUserUnderMerchant",
    "sign_type": "MD5",
    "seller_code": "{SELLER CODE}",
    "page": 1,
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.getUserUnderMerchant",
        "sign_type": "MD5",
        "seller_code": "{SELLER CODE}",
        "page" : 1,
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "data" : [
            {
            "id": 6900,
            "phone_number": "010222333",
            "user_id": "CU2501-101139033689723678",
            "email": "xxx@gmail.com",
            "full_name": "xxx Admin",
            "muser_identity": null,
            "created_at": "2025-01-13 09:32:21",
            "wallet": {
                "id": "CW2501-101139033689723679",
                "balance": 0,
                "currency": "USD",
                "account_number": "000024916"
            },
            "multi_wallets": [
                {
                    "id": "CW2501-101139033689723679",
                    "balance": 0,
                    "currency": "USD",
                    "account_number": "000024916",
                    "funds_type": "DEFAULT"
                },
                {
                    "id": "CW2501-101139033689723680",
                    "balance": 0,
                    "currency": "KHR",
                    "account_number": "000024917",
                    "funds_type": "MAIN"
                }
            ]
        }
        ],
        "current_page" : 1,
        "last_page": 2
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

User Info

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.userprofile",
    "sign_type": "MD5",
    "seller_code": "{SELLER CODE}",
    "user_id": "xxx",
    "muser_identity": "xxx",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.userprofile",
        "sign_type": "MD5",
        "seller_code": "{SELLER CODE}",
        "user_id": "xxx",
        "muser_identity":"xxx",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "id": 6900,
        "phone_number": "010222333",
        "user_id": "CU2501-101139033689723678",
        "email": "xxx@gmail.com",
        "full_name": "xxx Admin",
        "muser_identity": null,
        "created_at": "2025-01-13 09:32:21",
        "wallet": {
            "id": "CW2501-101139033689723679",
            "balance": 0,
            "currency": "USD",
            "account_number": "000024916"
        },
        "multi_wallets": [
            {
                "id": "CW2501-101139033689723679",
                "balance": 0,
                "currency": "USD",
                "account_number": "000024916",
                "funds_type": "DEFAULT"
            },
            {
                "id": "CW2501-101139033689723680",
                "balance": 0,
                "currency": "KHR",
                "account_number": "000024917",
                "funds_type": "MAIN"
            }
        ]
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

List Transaction

POST {baseUrl}/api/mch/v2/gateway requires authentication

Filter Field
start_date, end_date, order_id, user_id, wallet_id, status, sort : desc|asc

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.getTxnLists",
    "sign_type": "MD5",
    "seller_code": "{SELLER CODE}",
    "page": 1,
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.getTxnLists",
        "sign_type": "MD5",
        "seller_code": "{SELLER CODE}",
        "page" : 1,
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "data" : [
            {
                "transaction_ref": "TR2501-101139033689723727",
                "credited_amount": 9.65,
                "credited_currency": "USD",
                "debited_amount": 10,
                "debited_currency": "USD",
                "fees_amount": 0.35,
                "transaction_type": "in",
                "sender_name" : "xx",
                "reciever_name" : "xx",
                "payment_method" : "xx",
                "bank_bic" : "xx",
                "bank_logo" : "xx",
                "fees_ccy": "USD",
                "status": "Succeed",
                "created_at": "2025-01-13 09:54:39",
                "debited_user_id": "AU2501-101139033689723700",
                "credited_user_id": "CU2501-101139033689723678",
                "readable_created_at": "1 week ago",
                "order_id" : "123454"
            }
        ],
        "current_page" : 1,
        "last_page": 2
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Transaction Info

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.getTxnDetail",
    "sign_type": "MD5",
    "seller_code": "{SELLER CODE}",
    "transaction_ref": "xxx",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.getTxnDetail",
        "sign_type": "MD5",
        "seller_code": "{SELLER CODE}",
        "transaction_ref": "xxx",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "transaction_ref": "TR2501-101139033689723727",
        "credited_amount": 9.65,
        "credited_currency": "USD",
        "debited_amount": 10,
        "debited_currency": "USD",
        "fees_amount": 0.35,
        "transaction_type": "in",
        "sender_name" : "xx",
        "reciever_name" : "xx",
        "payment_method" : "xx",
        "bank_bic" : "xx",
        "bank_logo" : "xx",
        "fees_ccy": "USD",
        "status": "Succeed",
        "created_at": "2025-01-13 09:54:39",
        "debited_user_id": "AU2501-101139033689723700",
        "credited_user_id": "CU2501-101139033689723678",
        "readable_created_at": "2 weeks ago"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Money Transfer

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.moneytransfer",
    "seller_code": "{SELLER CODE}",
    "amount": 10,
    "currency": "USD",
    "from_wallet_id": "CW2501-101139033689723679",
    "to_wallet_id": "AW2501-101139033689723906",
    "comment": "User comment",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.moneytransfer",
        "seller_code": "{SELLER CODE}",
        "amount" : 10,
        "currency" : "USD",
        "from_wallet_id":"CW2501-101139033689723679",
        "to_wallet_id": "AW2501-101139033689723906",
        "comment": "User comment",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "transaction_ref": "TR2501-101200989918337879",
        "amount": 25,
        "currency": "USD",
        "comment": "",
        "created_at": "2025-01-29 10:17:46"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

List Special Transaction

POST {baseUrl}/api/mch/v2/gateway requires authentication

Filter Field
start_date end_date user_id, wallet_id, status : Succeed|Failed|Blocked

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.getSpecialTxnLists",
    "sign_type": "MD5",
    "start_date": "2025-01-25",
    "end_date": "2025-01-26",
    "seller_code": "{SELLER CODE}",
    "page": 1,
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.getSpecialTxnLists",
        "sign_type": "MD5",
        "start_date" : "2025-01-25",
        "end_date" : "2025-01-26",
        "seller_code": "{SELLER CODE}",
        "page" : 1,
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "data" : [
            {
           	"id": 422784,
           	"status": "Succeed",
          	"type": "Transfer",
           	"debit_amount": 1.01,
           	"debit_currency": "USD",
           	"credit_amount": 1.01,
           	"credit_currency": "USD",
           	"debit_user_id": "AU2012-26962261197195583",
           	"credit_user_id": "CU2102-27049025911915701",
           	"payment_method": "KESS_WALLET",
           	"bank_bic": null,
           	"logo": "https://clientdev.kesspay.io/storage/users/default.png",
           	"auto_display": {
               		"Trx_ID": "TR2410-100957722249362435",
               		"title": "Received from Van Happy",
               		"trx_date": "2024-10-07 23:15:40",
               		"total_amount": "$1.01",
               		"credit_amount": "$1.01",
               		"from_wallet": "000001181",
               		"to_wallet": "000001332",
               		"status": "Succeed",
               		"remark": "87-alg6zH1bL1s98IrC9cXg"
           	},
           	"receiver": {
               		"id": "CU2102-27049025911915701",
               		"first_name": "yu",
               		"last_name": "na",
               		"phone_number": "100000003",
               		"user_name": "010000003@yuna.com",
               		"avatar": "https://clientdev.kesspay.io/users/March2021/lBIzQCkUsozwUs1.png",
               		"email": "Yuna885@gmail.com",
               		"alias": null
           	},
            "sender": {
           		"id": "AU2012-26962261197195583",
           		"first_name": "Van",
           		"last_name": "Happy",
           		"avatar": "https://clientdev.kesspay.io/storage/users/default.png"
       		},
           	"is_payout": false,
           	"created_at": "2024-10-07 23:15:40"
       	}
        ],
        "pagination" : {
            "total" : 100,
            "current_page" : 1,
            "per_page" : 25,
            "last_page" : 2,
            "from" : 1,
            "to": 25
        }
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Special Transaction Info

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.getSpecialTxnDetail",
    "sign_type": "MD5",
    "seller_code": "{SELLER CODE}",
    "transaction_id": "xxx",
    "user_id": "xxxx",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.getSpecialTxnDetail",
        "sign_type": "MD5",
        "seller_code": "{SELLER CODE}",
        "transaction_id": "xxx",
		"user_id" : "xxxx",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
           	"id": 422784,
           	"status": "Succeed",
          	"type": "Transfer",
           	"debit_amount": 1.01,
           	"debit_currency": "USD",
           	"credit_amount": 1.01,
           	"credit_currency": "USD",
           	"debit_user_id": "AU2012-26962261197195583",
           	"credit_user_id": "CU2102-27049025911915701",
           	"payment_method": "KESS_WALLET",
           	"bank_bic": null,
           	"logo": "https://clientdev.kesspay.io/storage/users/default.png",
           	"auto_display": {
               		"Trx_ID": "TR2410-100957722249362435",
               		"title": "Received from Van Happy",
               		"trx_date": "2024-10-07 23:15:40",
               		"total_amount": "$1.01",
               		"credit_amount": "$1.01",
               		"from_wallet": "000001181",
               		"to_wallet": "000001332",
               		"status": "Succeed",
               		"remark": "87-alg6zH1bL1s98IrC9cXg"
           	},
           	"receiver": {
               		"id": "CU2102-27049025911915701",
               		"first_name": "yu",
               		"last_name": "na",
               		"phone_number": "100000003",
               		"user_name": "010000003@yuna.com",
               		"avatar": "https://clientdev.kesspay.io/users/March2021/lBIzQCkUsozwUs1.png",
               		"email": "Yuna885@gmail.com",
               		"alias": null
           	},
			"sender": {
           		"id": "AU2012-26962261197195583",
           		"first_name": "Van",
           		"last_name": "Happy",
           		"avatar": "https://clientdev.kesspay.io/storage/users/default.png"
       		},
           	"is_payout": false,
           	"created_at": "2024-10-07 23:15:40"
       	},
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Upload Kyc User

POST {baseUrl}/api/mch/v2/upload-attachments requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --form 'service="webpay.acquire.uploadUserKyc"' \
--form 'sign_type="MD5"' \
--form 'seller_code="CU2501-101139033689723677"' \
--form 'user_id="U2501-101200989918335818"' \
--form 'attachments[front]=@"path"' \
--form 'attachments[back]=@"path"' \
--form 'attachments[selfe]=@"path"' \


                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>array('service' => 'webpay.acquire.uploadUserKyc','sign_type' => 'MD5','seller_code' => 'CU2501-101139033689723677','user_id' => 'U2501-101200989918335818','attachments[front]'=> new CURLFILE({path}),'attachments[back]'=> new CURLFILE({path}),'attachments[selfe]'=> new CURLFILE({path})),
    CURLOPT_HTTPHEADER => array(
         'Content-Type: multipart/form-data' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "ref": "KYC2509-101504183252836186",
        "status": "validation_asked",
        "message": "The user is KYC is already under review."
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Bakong API Gateway

Use a single endpoint to access every available service based on its service’s name and dynamical parameters.

List Bakong Members

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.getbakongmembers",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.getbakongmembers",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": [
        {
            "name": "xxx",
            "bic": "xx",
            "logo": "xx",
        }
    ],
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Withdraw By Bank Account

Withdraw from merchant wallet to Bank Account.

API specification

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.withdrawByBankNumber",
    "sign": "79e69e298da1c85cf09366c35e366917",
    "sign_type": "MD5",
    "seller_code": "{SELLER CODE}",
    "bank_account": "123456789",
    "out_trade_no": "WD-00000TEST0002",
    "total_amount": 10,
    "currency": "USD",
    "expires_in": 300,
    "customer": "{ENCRYPTED CUSTOMER DATA}",
    "notify_url": "https:\/\/sample.com\/notifyme",
    "bic": "ACLBKHPPXXX"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.withdrawByBankNumber",
        "sign": "79e69e298da1c85cf09366c35e366917",
        "sign_type": "MD5",
        "seller_code": "{SELLER CODE}",
        "bank_account": "123456789",
        "out_trade_no": "WD-00000TEST0002",
        "total_amount": 10,
        "currency": "USD",
        "expires_in": 300,
        "customer": "{ENCRYPTED CUSTOMER DATA}",
        "notify_url" : "https://sample.com/notifyme",
        "bic": "ACLBKHPPXXX"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "token": "UHlHRHk2Nzg462df82a70a8bc",
        "out_trade_no": "WD-00000TEST0002",
        "transaction_id": null,
        "body": "Fund transfer",
        "total_amount": -10,
        "currency": "USD",
        "status": "WAITING",
        "paid_at": null,
        "settled_at": null,
        "settlement_date": null,
        "expired_at": "2022-07-26T06:04:03.000000Z",
        "created_at": "2022-07-26T05:59:03.000000Z",
        "detail": [],
        "seller": {
            "code": "{SELLER CODE}",
            "display_name": "Merchant Name"
        },
        "payment_detail": {
            "id": 8949,
            "payer_id": 793,
            "method_id": 12,
            "tokenize_id": 944,
            "method_desc": "Transfer to customer bank (From Merchant wallet)",
            "holder_name": "airport.taxi",
            "card_info": null,
            "bank_info": null,
            "created_at": "2022-07-26T05:59:03.000000Z",
            "payment_method_bic": "ABAAKHPP",
            "payment_method": {
                "id": 12,
                "title": "ABA PAY",
                "swift_code": "ABAAKHPP"
            }
        }
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Generate KHQR

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.generateKhqr",
    "sign_type": "MD5",
    "wallet_id": "xx",
    "user_id": "xx",
    "amount": 0,
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.generateKhqr",
        "sign_type": "MD5",
        "wallet_id": "xx",
        "user_id": "xx",
        "amount": 0,
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "qr_string": "00020101021129490009khqr@kess01090000249240219Kess Innovation Plc5204599953038405802KH5910Bunna Roth6010Phnom Penh62130209015703635991700131738910956926630400AA",
        "md5": "bf6ce95e56672e6991d3bd42af8f481a"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Decode KHQR

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.decodeKhqr",
    "sign_type": "MD5",
    "qrcode": "xx",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.decodeKhqr",
        "sign_type": "MD5",
        "qrcode": "xx",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "merchantType": "29",
        "bakongAccountID": "khqr@kess",
        "accountInformation": "000024924",
        "merchantID": null,
        "acquiringBank": "xx Innovation Plc",
        "billNumber": null,
        "mobileNumber": "015xxx",
        "storeLabel": null,
        "terminalLabel": null,
        "purposeOfTransaction": null,
        "languagePreference": null,
        "merchantNameAlternateLanguage": null,
        "merchantCityAlternateLanguage": null,
        "payloadFormatIndicator": "01",
        "pointofInitiationMethod": "12",
        "unionPayMerchant": null,
        "merchantCategoryCode": "5999",
        "transactionCurrency": "usd",
        "transactionAmount": "10",
        "countryCode": "KH",
        "merchantName": "xx Roth",
        "merchantCity": "Phnom Penh",
        "timestamp": "00131736836325291",
        "crc": "A581"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Scan KHQR

POST {baseUrl}/api/mch/v2/gateway requires authentication

Sequence diagram

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.payKhqr",
    "sign_type": "MD5",
    "remark": "xx",
    "qrcode": "xx",
    "currency": "USD",
    "seller_code": "CU2501-101139033689723677",
    "out_trade_no": "TR-1234567890",
    "amount": "2",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.payKhqr",
        "sign_type": "MD5",
        "remark": "xx",
        "qrcode": "xx",
        "currency": "USD",
        "seller_code": "CU2501-101139033689723677",
        "out_trade_no" : "TR-1234567890",
        "amount": "2",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "transaction_ref": "TR2502-101237442664727769",
        "receiver_info": {
            "receiver_name": "Roth",
            "receiver_bank": "xxx Innovation Plc",
            "receiver_bakong_id": "khqr@kess",
            "receiver_acc_info": "000024924"
        },
        "status": "SUCCEEDED",
        "currency": "USD",
        "amount": "2",
        "created_at" : "Datetime|Yes|2025-01-21 00:00:00"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Virtual Card API Gateway

Use a single endpoint to access every available service based on its service’s name and dynamical parameters.

Create Virtual Card

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.createVirtualCard",
    "seller_code": "{SELLER CODE}",
    "cumulative_limit": 3,
    "daily_max_trans": 0,
    "holder_name": "xxxx",
    "daily_trans_limit_amount": 1,
    "sign_type": "MD5",
    "single_trans_limit": 0.01,
    "currency": "USD",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.createVirtualCard",
        "seller_code": "{SELLER CODE}",
        "cumulative_limit":3,
        "daily_max_trans" : 0,
        "holder_name" : "xxxx",
        "daily_trans_limit_amount": 1,
        "sign_type": "MD5",
        "single_trans_limit" : 0.01,
        "currency" : "USD",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "purchaseRequestId": "24831209",
        "velocityControl": [{
            "maxTrans": 10,
            "period" : "C",
            "cumulativeLimit": 1,
            "availableBalance": 100
        }],
        "transactionLimitControl": {
            "amount": 100
        },
        "vcnInformation": {
            "pan": "5364588625436475",
            "expiry": "2602",
            "avv": "267",
            "is_frozen" : true,
            "holder_name" : "xxx"
        }
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

List Virtual Card

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.getVirtualCards",
    "seller_code": "{SELLER CODE}",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.getVirtualCards",
        "seller_code": "{SELLER CODE}",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": [
        {
            "purchase_req_id": "24808839",
            "pan": "5364588647578601",
            "expiry": "2602",
            "avv": "272",
            "currency": "USD",
            "status": 1,
            "holder_name" : "xxx"
        },
        {
            "purchase_req_id": "24831209",
            "pan": "5364588625436475",
            "expiry": "2602",
            "avv": "267",
            "currency": "USD",
            "status": 1,
            "holder_name" : "xxx"
        }
    ],
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Get Virtual Card Balance

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.getVirtualCardBalance",
    "seller_code": "{SELLER CODE}",
    "purchase_req_id": "24831209",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.getVirtualCardBalance",
        "seller_code": "{SELLER CODE}",
        "purchase_req_id" : "24831209",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "purchaseRequestId": "24808839",
        "availableBalance": 1
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Get Virtual Card Detail

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.getVirtualCardDetail",
    "seller_code": "{SELLER CODE}",
    "purchase_req_id": "24831209",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.getVirtualCardDetail",
        "seller_code": "{SELLER CODE}",
        "purchase_req_id" : "24831209",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "purchaseRequestId": "24831209",
        "velocityControl": [{
            "maxTrans": 10,
            "period" : "C",
            "availableBalance": 1,
            "cumulativeLimit": 100
        }],
        "transactionLimitControl": {
            "amount": 100
        },
        "vcnInformation": {
            "pan": "5364588625436475",
            "expiry": "2602",
            "avv": "267",
            "is_frozen" : true,
            "holder_name" : "xxx"
        }
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

List Virtual Card Report

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.getVirtualCardReport",
    "seller_code": "{SELLER CODE}",
    "purchase_req_id": "24831209",
    "start_date": "2024-12-25",
    "end_date": "2024-12-25",
    "from": 0,
    "take": 10,
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.getVirtualCardReport",
        "seller_code": "{SELLER CODE}",
        "purchase_req_id" : "24831209",
        "start_date" : "2024-12-25",
        "end_date"   : "2024-12-25",
        "from" : 0,
        "take" : 10,
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "reportStatus": "Completed",
        "from": 0,
        "take": 100,
        "hasMore": false,
        "transactions": [
            {
                "id": 92,
                "credit_fund_amount": 1,
                "credit_fund_currency": "USD",
                "credit_currency_description": "U.S. DOLLAR",
                "debit_fund_amount": 0,
                "debit_fund_currency": "USD",
                "debit_currency_description": "U.S. DOLLAR",
                "orig_amount": 0,
                "orig_currency": "USD",
                "orig_currency_description":"U.S. DOLLAR",
                "type": "topup",
                "is_success": 1,
                "is_settled": 0,
                "trans_date": "2025-04-03 07:11:06",
                "sub_type": null,
                "txn_type": "Authorization",
                "merchant_name": null,
                "issuer_response": null,
                "ref" : "xxxx"
            }
        ]
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

TopUp Balance

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.cardTopUpBalance",
    "seller_code": "{SELLER CODE}",
    "topup_amount": 3,
    "sign_type": "MD5",
    "purchase_req_id": "xxxx",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.cardTopUpBalance",
        "seller_code": "{SELLER CODE}",
        "topup_amount":3,
        "sign_type": "MD5",
        "purchase_req_id" : "xxxx",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "transRef" : "String|Yes|24831209",
        "purchaseRequestId": "24824411",
        "availableBalance": 19
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Change Velocity Limit

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.changeVelocityLimit",
    "seller_code": "{SELLER CODE}",
    "max_trans": 3,
    "cumulative_limit": 3,
    "sign_type": "MD5",
    "period": "D",
    "purchase_req_id": "xxxx",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.changeVelocityLimit",
        "seller_code": "{SELLER CODE}",
        "max_trans":3,
        "cumulative_limit":3,
        "sign_type": "MD5",
        "period" : "D",
        "purchase_req_id" : "xxxx",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "purchaseRequestId": "24824411",
        "velocityControl": [{
            "maxTrans": 10,
            "availableBalance": 19,
            "period": "C",
            "cumulativeLimit" : 104
        }],
        "transactionLimitControl": {
            "amount": 18
        }
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Freeze Card

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.freezeCard",
    "seller_code": "{SELLER CODE}",
    "sign_type": "MD5",
    "purchase_req_id": "xxxx",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.freezeCard",
        "seller_code": "{SELLER CODE}",
        "sign_type": "MD5",
        "purchase_req_id" : "xxxx",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "purchaseRequestId": "24824411"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Unfreeze Card

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.unfreezeCard",
    "seller_code": "{SELLER CODE}",
    "sign_type": "MD5",
    "purchase_req_id": "xxxx",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.unfreezeCard",
        "seller_code": "{SELLER CODE}",
        "sign_type": "MD5",
        "purchase_req_id" : "xxxx",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "purchaseRequestId": "24824411"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Terminate Card

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.terminatedCard",
    "seller_code": "{SELLER CODE}",
    "purchase_req_id": "24831209",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.terminatedCard",
        "seller_code": "{SELLER CODE}",
        "purchase_req_id" : "24831209",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "purchaseRequestId": "24831209"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Tap To Phone API Gateway

Use a single endpoint to access every available service based on its service’s name and dynamical parameters.

Create Order

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.kioskCreateOrder",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "seller_code": "{SELLER CODE}",
    "out_trade_no": "TEST-1234567891",
    "body": "iPhone 13 pro Case",
    "total_amount": 10,
    "currency": "USD",
    "notify_url": "https:\/\/sample.com\/notifyme"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.kioskCreateOrder",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "seller_code": "{SELLER CODE}",
        "out_trade_no": "TEST-1234567891",
        "body": "iPhone 13 pro Case",
        "total_amount": 10,
        "currency": "USD",
        "notify_url": "https://sample.com/notifyme"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "amount": 5,
        "fee": 0,
        "total_amount": 5,
        "order_ref": "000000000936",
        "pre_order_id": "5d7481203376937f82d55942",
        "order_info": {
            "token": "5d7481203376937f82d55942",
            "out_trade_no": "1gbwzExpeN2tsfvruHlfiBCCk",
            "transaction_id": null,
            "body": "test",
            "total_amount": 5,
            "currency": "USD",
            "notify_url": null,
            "version": "4",
            "meta": {
                "customer_fees": {
                    "WECHAT": {
                        "fee": 0,
                        "currency": "USD"
                    },
                    "ALIPAY": {
                        "fee": 0,
                        "currency": "USD"
                    }
                },
                "additional": [],
                "iframe_static_card": null,
                "merchant_info": []
            },
            "status": "WAITING",
            "paid_at": null,
            "settled_at": null,
            "settlement_date": null,
            "expired_at": "2025-02-05T11:02:04.000000Z",
            "created_at": "2025-02-03T09:02:05.000000Z",
            "detail": [],
            "seller": {
                "code": "CU2206-27710032233644359",
                "display_name": "LM",
                "motp_mch_id": "111702",
                "m_id": null
            },
            "tip": null,
            "bank_ref": null,
            "bank_info": [],
            "refund_histories": [],
            "payment_detail": null,
            "error_logs": [],
            "card_info": {
                "BIN": null,
                "scheme": null,
                "card_token": null,
                "swift_code": null,
                "card_hashed": null,
                "holder_name": null,
                "account_logo": null,
                "account_name": null,
                "account_number": null
            },
            "wechat_alipay_info": {
                "openid": null,
                "service": null,
                "currency": null,
                "total_amount": null,
                "total_amount_cny": null
            }
        }
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Confirm Order

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.confirmKioskOrder",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "pre_order_id": "5d7481203376937f82d55942"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.confirmKioskOrder",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "pre_order_id": "5d7481203376937f82d55942"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
            "token": "5d7481203376937f82d55942",
            "out_trade_no": "1gbwzExpeN2tsfvruHlfiBCCk",
            "transaction_id": null,
            "body": "test",
            "total_amount": 5,
            "currency": "USD",
            "notify_url": null,
            "version": "4",
            "meta": {
                "customer_fees": {
                    "WECHAT": {
                        "fee": 0,
                        "currency": "USD"
                    },
                    "ALIPAY": {
                        "fee": 0,
                        "currency": "USD"
                    }
                },
                "additional": [],
                "iframe_static_card": null,
                "merchant_info": []
            },
            "status": "WAITING",
            "paid_at": null,
            "settled_at": null,
            "settlement_date": null,
            "expired_at": "2025-02-05T11:02:04.000000Z",
            "created_at": "2025-02-03T09:02:05.000000Z",
            "detail": [],
            "seller": {
                "code": "CU2206-27710032233644359",
                "display_name": "LM",
                "motp_mch_id": "111702",
                "m_id": null
            },
            "tip": null,
            "bank_ref": null,
            "bank_info": [],
            "refund_histories": [],
            "payment_detail": null,
            "error_logs": [],
            "card_info": {
                "BIN": null,
                "scheme": null,
                "card_token": null,
                "swift_code": null,
                "card_hashed": null,
                "holder_name": null,
                "account_logo": null,
                "account_name": null,
                "account_number": null
            },
            "wechat_alipay_info": {
                "openid": null,
                "service": null,
                "currency": null,
                "total_amount": null,
                "total_amount_cny": null
            }
        },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

SDK Document

Please contact KESS team

Mobile Top Up API Gateway

Use a single endpoint to access every available service based on its service’s name and dynamical parameters.

List Mobile Top Up

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.listMobileTopUp",
    "sign_type": "MD5",
    "seller_code": "{SELLER CODE}",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.listMobileTopUp",
        "sign_type": "MD5",
        "seller_code": "{SELLER CODE}",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": [
        {
            "provider_name": "Smart Axiata",
            "service_name": "smart",
            "logo": "telecoms/February2025/Q0MdFNxvtPQa4D48lood.webp",
            "prefix": "010,015,016,069,070,081,086,087,093,096,098",
            "active": 1,
            "is_under_maintenance": 0,
            "maintenance_description": null,
            "pinless": 1,
            "pinbase": 0
        },
        {
            "provider_name": "Viettel",
            "service_name": "metfone",
            "logo": "telecoms/February2025/PbGVyeBEAvNj4an9y51b.png",
            "prefix": "023,031,060,066,067,068,071,088,090,097",
            "active": 1,
            "is_under_maintenance": 0,
            "maintenance_description": null,
            "pinless": 1,
            "pinbase": 0
        }
    ],
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Mobile Top Up

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw 'null'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>{
        "service": "webpay.acquire.mobileTopUp",
        "sign_type": "MD5",
        "seller_code": "{SELLER CODE}",
        "provider" : "smart",
        "amount" : 1,
        "phone_number" : "010xxxxxx"
        "sign": "{SIGNATURE}"
    },
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "is_ok": true,
        "instance_id": "7a052f574199493523b55d90",
        "correlation_id": "101237442664742519"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

List Mobile Topup Subscription

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.listMobileTopupSubscription",
    "sign_type": "MD5",
    "seller_code": "{SELLER CODE}",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.listMobileTopupSubscription",
        "sign_type": "MD5",
        "seller_code": "{SELLER CODE}",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
       "current_page": 1,
       "data": [
           {
               "ref": "ST2504-101323211819450382",
               "topup_option": "direct",
               "provider": "Metfone",
               "credit_amount": 94,
               "credit_ccy": "USD"
           }
       ],
       "from": 1,
       "last_page": 1,
       "per_page": 50,
       "to": 1,
       "total": 1
   }
,
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

API Gateway

Use a single endpoint to access every available service based on its service’s name and dynamical parameters. We have provided two common services “initiate transaction” and “query” for our merchants to interact with our customers over a web application (WebPay) to process the payment with dynamic amounts and currency.

List payment methods

Pull available payment methods under merchant account.

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.getpaymentmethods",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.getpaymentmethods",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": [
    {
        "id": 12,
        "title": "ABA PAY",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/January2021\/zNSxh2tYwT9KaNnoQb67.png",
        "bic": "ABAAKHPP",
        "storelink": {
            "ios": "itms-apps:\/\/apple.com\/app\/968860649",
            "android": "https:\/\/play.google.com\/store\/apps\/details?id=com.paygo24.ibank&hl=en&gl=US"
        }
    },
    {
        "id": 13,
        "title": "ACLEDA Pay",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/January2021\/hByq9E5xKTA9n6En12V2.png",
        "bic": "ACLBKHPP",
        "storelink": {
            "ios": null,
            "android": "http:\/\/play.google.com\/store\/apps\/details?id=com.domain.acledabankqr&hl=en"
        }
    },
    {
        "id": 16,
        "title": "AliPay",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/June2025\/SSrHii26d0cout0TroiQ.png",
        "bic": "ALIPAY",
        "storelink": {
            "ios": "itms-apps:\/\/apple.com\/app\/333206289",
            "android": "https:\/\/play.google.com\/store\/apps\/details?id=com.eg.android.AlipayGphone"
        }
    },
    {
        "id": 157,
        "title": "BAKONG",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/May2025\/NmLqIAyh1VW0vrZ4WB7D.png",
        "bic": "BAKONG",
        "storelink": {
            "ios": null,
            "android": null
        }
    },
    {
        "id": 21,
        "title": "Bakong KHQR",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/June2022\/AI6o4p5koHpwdKkmFtLU.png",
        "bic": "KHQR",
        "storelink": {
            "ios": null,
            "android": null
        }
    },
    {
        "id": 27,
        "title": "Canadia Bank Plc.",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/September2023\/ZeSnimPKvM1RmphltTmZ.jpg",
        "bic": "CADIKHPP",
        "storelink": {
            "ios": null,
            "android": null
        }
    },
    {
        "id": 29,
        "title": "Chip Mong Bank",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/May2024\/XBrHaUjpqYcCSR4Re1Ob.jpg",
        "bic": "CHNOKHPP",
        "storelink": {
            "ios": "https:\/\/apps.apple.com\/kh\/app\/chip-mong-bank\/id1453457373",
            "android": "market:\/\/details?id=com.chipmongbank.mobileappproduction&hl=en"
        }
    },
    {
        "id": 17,
        "title": "eMoney",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/June2021\/oLIH0G2nZcd5liB5usUs.png",
        "bic": "EMONEY",
        "storelink": {
            "ios": null,
            "android": null
        }
    },
    {
        "id": 30,
        "title": "FTB  Bank",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/September2024\/Utcp75YBeb2Q1c3QSdKQ.jpg",
        "bic": "FTCCKHPP",
        "storelink": {
            "ios": null,
            "android": null
        }
    },
    {
        "id": 28,
        "title": "HATTHA Bank",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/February2025\/A0qsvnEa37hUs4w3IaOH.png",
        "bic": "HATHKHPP",
        "storelink": {
            "ios": "https:\/\/apps.apple.com\/us\/app\/hattha-mobile\/id1493188010",
            "android": "market:\/\/details?id=com.kh.hkl.mobilebanking"
        }
    },
    {
        "id": 26,
        "title": "iBank",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/August2025\/AjiuLiUdaC1UjOdTEghx.png",
        "bic": "BIOBKHPP",
        "storelink": {
            "ios": null,
            "android": null
        }
    },
    {
        "id": 11,
        "title": "KESS PAY",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/June2022\/sUGkSOt9bwpLUP80Rdst.png",
        "bic": "KESSKH",
        "storelink": {
            "ios": "itms-apps:\/\/apple.com\/app\/1518521952",
            "android": "https:\/\/play.google.com\/store\/apps\/details?id=io.kessinnovation.kesschat"
        }
    },
    {
        "id": 24,
        "title": "KHQR",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/October2025\/maFIf3hsMtN91YUJLJYE.jpg",
        "bic": "KESSKHQR",
        "storelink": {
            "ios": null,
            "android": null
        }
    },
    {
        "id": 158,
        "title": "Oriental Bank",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/June2025\/bcjgsApLnKtHYGmTN895.jpg",
        "bic": "ORENKHPP",
        "storelink": {
            "ios": null,
            "android": null
        }
    },
    {
        "id": 37,
        "title": "Phillip Bank Plc",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/February2025\/5vcvXcDIQ7wwzmLBJkuw.jpg",
        "bic": "HDSBKHPP",
        "storelink": {
            "ios": null,
            "android": null
        }
    },
    {
        "id": 25,
        "title": "PPCBank",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/August2023\/rIMxZ5jHbeoAveCFrfIp.jpg",
        "bic": "PPCBKHPP",
        "storelink": {
            "ios": "https:\/\/apps.apple.com\/kh\/app\/ppcbank-mobile-banking\/id1499620876",
            "android": "market:\/\/details?id=kh.com.ppcbank.mbanking2p"
        }
    },
    {
        "id": 14,
        "title": "Sathapana",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/January2021\/upXnfv34dpBz9UMNeVGm.png",
        "bic": "SBPLKHPP",
        "storelink": {
            "ios": "https:\/\/apps.apple.com\/kh\/app\/sathapana-mobile\/id1358225801",
            "android": "https:\/\/play.google.com\/store\/apps\/details?id=kh.com.sathapana.consumer"
        }
    },
    {
        "id": 19,
        "title": "TrueMoney",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/June2022\/MBBLsHM6EJeZ3ZejFvkO.png",
        "bic": "TRUEMONEY",
        "storelink": {
            "ios": "https:\/\/apps.apple.com\/kh\/app\/truemoney-cambodia\/id1162466939",
            "android": "https:\/\/play.google.com\/store\/apps\/details?id=th.co.truemoney.wallet&hl=en&gl=US"
        }
    },
    {
        "id": 32,
        "title": "UnionPay",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/February2025\/tqrrQ2NJDfkRg7eFvuC9.png",
        "bic": "UNIONPAY",
        "storelink": {
            "ios": null,
            "android": null
        }
    },
    {
        "id": 20,
        "title": "Vattanac Bank",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/August2023\/aHW2liozM453Zqr2xPCz.png",
        "bic": "VBLCKHPP",
        "storelink": {
            "ios": "itms-apps:\/\/apple.com\/app\/1494415503",
            "android": "https:\/\/play.google.com\/store\/apps\/details?id=com.vattanacbank.mobile"
        }
    },
    {
        "id": 9,
        "title": "Visa\/Master Card",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/July2024\/RHgYIV6UYZGSRIKtqbUP.png",
        "bic": "VISA_MASTER",
        "storelink": {
            "ios": null,
            "android": null
        }
    },
    {
        "id": 15,
        "title": "WeChat Pay",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/June2025\/NhMU4Dr0OuYLX14ypFan.png",
        "bic": "WECHAT",
        "storelink": {
            "ios": "itms-apps:\/\/apple.com\/app\/414478124",
            "android": "https:\/\/play.google.com\/store\/apps\/details?id=com.tencent.mm"
        }
    },
    {
        "id": 18,
        "title": "Wing Bank",
        "img_url": "https:\/\/kess-web-cdn-dev.sgp1.digitaloceanspaces.com\/WEBPAY\/logos\/payment-methods\/July2022\/Q44YlfkgxgXoCwJixuX5.png",
        "bic": "WING",
        "storelink": {
            "ios": null,
            "android": null
        }
    }
],
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Generate Payment Link

Send or open payment link to procceed payment.

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.createorder",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "seller_code": "{SELLER CODE}",
    "out_trade_no": "TEST-1234567891",
    "body": "iPhone 13 pro Case",
    "total_amount": 10,
    "currency": "USD",
    "notify_url": "https:\/\/sample.com\/notifyme",
    "login_type": "ANONYMOUS"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.createorder",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "seller_code": "{SELLER CODE}",
        "out_trade_no": "TEST-1234567891",
        "body": "iPhone 13 pro Case",
        "total_amount": 10,
        "currency": "USD",
        "notify_url": "https://sample.com/notifyme",
        "login_type": "ANONYMOUS"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "token": "111612f019b6836bf1255554",
        "out_trade_no": "TEST-1234567891",
        "transaction_id": null,
        "body": "iPhone 13 pro Case",
        "total_amount": 10,
        "currency": "USD",
        "status": "WAITING",
        "paid_at": null,
        "settled_at": null,
        "settlement_date": null,
        "expired_at": "2022-07-18T10:44:53.000000Z",
        "created_at": "2022-07-18T07:44:54.000000Z",
        "detail": [],
        "seller": {
            "code": "{SELLER CODE}",
            "display_name": "ABCD"
        },
        "payment_detail": null,
        "queue_number": "0001",
        "payment_link": "{baseUrl}/pay/{token}"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Native Pay

Generate dynamic QR code or deeplink.

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.nativePay",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "seller_code": "{SELLER CODE}",
    "out_trade_no": "TEST-1234567891",
    "body": "iPhone 13 pro Case",
    "total_amount": 10,
    "currency": "USD",
    "notify_url": "https:\/\/sample.com\/notifyme",
    "service_code": "KESSKH"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.nativePay",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "seller_code": "{SELLER CODE}",
        "out_trade_no": "TEST-1234567891",
        "body": "iPhone 13 pro Case",
        "total_amount": 10,
        "currency": "USD",
        "notify_url": "https://sample.com/notifyme",
        "service_code": "KESSKH"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "qrcode": "00020101021230100006KESSKH5204000053038405402105802KH5919KESS INNOVATION PLC6010Phnom Penh6236012444816b39953515cd6262b1870304test630448F7",
        "deeplink": null,
        "expires_in": 10799,
        "brand_logo": "https://devwebpayment.kesspay.io/storage/payment-methods/June2022/sUGkSOt9bwpLUP80Rdst.png",
        "app_name": "KESSCHAT",
        "service_code": "KESSKH",
        "order_info": {
            "token": "44816b39953515cd6262b187",
            "out_trade_no": "TEST-1234567892",
            "transaction_id": null,
            "body": "iPhone 13 pro Case",
            "total_amount": 10,
            "currency": "USD",
            "status": "WAITING",
            "paid_at": null,
            "settled_at": null,
            "settlement_date": null,
            "expired_at": "2022-07-19T09:18:55.000000Z",
            "created_at": "2022-07-19T06:18:56.000000Z",
            "detail": [],
            "seller": {
                "code": "{SELLER CODE}",
                "display_name": "Merchant Name"
            },
            "payment_detail": null,
            "error_logs": []
        }
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Quick Pay

    
curl --location --request POST 'https://devwebpayment.kesspay.io/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
--data-raw '{
    "service": "webpay.acquire.quickpay",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "seller_code": "{SELLER CODE}",
    "out_trade_no": "TEST-1234567891",
    "body": "iPhone 13 pro Case",
    "total_amount": 10,
    "currency": "USD",
    "notify_url": "https://sample.com/notifyme",
    "service_code": "KESSKH"
}'
    

    
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://devwebpayment.kesspay.io/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.quickpay",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "seller_code": "{SELLER CODE}",
        "out_trade_no": "TEST-1234567891",
        "auth_code" : 123453,
        "body": "iPhone 13 pro Case",
        "total_amount": 10,
        "currency": "USD",
        "notify_url": "https://sample.com/notifyme",
        "service_code": "WECHAT"
    }',
    CURLOPT_HTTPHEADER => array(
        'Content-Type: application/json',
        'Authorization: Bearer {ACCESS TOKEN}'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
    

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.quickpay",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "seller_code": "{SELLER CODE}",
    "out_trade_no": "TEST-1234567891",
    "body": "iPhone 13 pro Case",
    "total_amount": 10,
    "currency": "USD",
    "notify_url": "https:\/\/sample.com\/notifyme",
    "login_type": "ANONYMOUS",
    "service_code": "WECHAT",
    "auth_code": 1234567
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.quickpay",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "seller_code": "{SELLER CODE}",
        "out_trade_no": "TEST-1234567891",
        "body": "iPhone 13 pro Case",
        "total_amount": 10,
        "currency": "USD",
        "notify_url": "https://sample.com/notifyme",
        "login_type": "ANONYMOUS",
        "service_code" : "WECHAT",
        "auth_code": 1234567
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "token": "111612f019b6836bf1255554",
        "out_trade_no": "TEST-1234567891",
        "transaction_id": null,
        "body": "iPhone 13 pro Case",
        "total_amount": 10,
        "currency": "USD",
        "status": "WAITING",
        "paid_at": null,
        "settled_at": null,
        "settlement_date": null,
        "expired_at": "2022-07-18T10:44:53.000000Z",
        "created_at": "2022-07-18T07:44:54.000000Z",
        "detail": [],
        "seller": {
            "code": "{SELLER CODE}",
            "display_name": "Merchant Name"
        },
        "payment_detail": null,
        "queue_number": "0001",
        "card_info" : {
            "BIN": null,
            "scheme": null,
            "card_token": null,
            "swift_code": null,
            "card_hashed": null,
            "holder_name": null,
            "account_logo": null,
            "account_name": null,
            "account_number": null
        },
        "wechat_alipay_info" : {
            "openid": "2088632596656451",
            "service": "Alipay or Wechat",
            "currency": "USD",
            "total_amount": "0.01",
            "total_amount_cny": "0.07"
        },
        "refund_histories" : [
            {
                "amount": 1,
                "currency": "USD",
                "status": "PARTIAL_REFUNDED",
                "reason": "Vgph5a74fsoQr1fgrSinpe9bh",
                "transaction_id": "TR-123",
                "rejected_reason": null,
                "out_trade_no" : "TR-345",
                "merchant_reference" : "xxx"
            }    
        ]
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Direct Pay

Initiate Credit/Debit card transaction directly from merchant server.

Sequence diagram

API specification

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.directPay",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "seller_code": "{SELLER CODE}",
    "out_trade_no": "TEST-1234567891",
    "body": "iPhone 13 pro Case",
    "total_amount": 10,
    "currency": "USD",
    "notify_url": "https:\/\/sample.com\/notifyme",
    "redirect_url": "https:\/\/sample.com\/redirectme",
    "card": "{ENCRYPTED CARD INFORMATION}",
    "ip_address": "127.0.0.1"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.directPay",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "seller_code": "{SELLER CODE}",
        "out_trade_no": "TEST-1234567891",
        "body": "iPhone 13 pro Case",
        "total_amount": 10,
        "currency": "USD",
        "notify_url": "https://sample.com/notifyme",
        "redirect_url": "https://sample.com/redirectme",
        "card": "{ENCRYPTED CARD INFORMATION}",
        "ip_address" : "127.0.0.1"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "required_3ds": true,
        "pre_card_input": true,
        "html_confirm_payment": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\"><html lang=\"en\" xml:lang=\"en\"><head><title>Process Secure Payment</title><meta http-equiv=\"content-type\" content=\"text/html;charset=UTF-8\"><meta name=\"description\" content=\"Process Secure Payment\"><meta name=\"robots\" content=\"noindex\"><style type=\"text/css\">body {font-family:\"Trebuchet MS\",sans-serif; background-color: #FFFFFF; }#msg {border:5px solid #666; background-color:#fff; margin:20px; padding:25px; max-width:40em; -webkit-border-radius: 10px; -khtml-border-radius: 10px; -moz-border-radius: 10px; border-radius: 10px;}#submitButton { text-align: center ; }#footnote {font-size:0.8em;}</style></head><body onload=\"return window.document.echoForm.submit()\"><form name=\"echoForm\" method=\"POST\" action=\"https://mtf.gateway.mastercard.com/acs/MastercardACS/a1ea9661-2440-4f41-82f2-8f5cf81bb808\" accept-charset=\"UTF-8\"><input type=\"hidden\" name=\"PaReq\" value=\"eAFVUdtugkAUfDfxHwjpa9kLomiOa6yXSEzRVG36SmArpLLogre/71mvLU/M7J7ZOTPQO+Ub6yB1mRWqazOH2pZUcZFkat21V8vxq2/3RL0Gy1RLOVzIeK+lgHdZltFaWlmCMxQ/5lOP03bTFjDvf8idgJumQEmHA7lDHNVxGqlKQBTv3oJQeKzJuQvkBiGXOhgKxl2KeksgVwwqyqWYjhaLIAxnn/1lMAuBXEiIi72q9Fkw1gRyB7DXG5FW1bZDyPF4dH7QcqZUcYgqXNWJixyIuQLk6Wi+N95KXPCUJWKQkBEPdPo9jGnpHc5fGfcn2zFpTxtdIOYGJFElBaec0xZrW4x2qN9xcZcLD1FujInVYmi9MOpQikteKdial/pXYAIE8pcBTFljDWfhN/DogUCetoWSqImJPv6BPH0PJibXuMIEvUbL9bCZpqkHCzIJXw6MSoZxcY9eZQwAYkbJrTzM5FIwMv+Kr9d+AQfRs6A=\"><input type=\"hidden\" name=\"TermUrl\" value=\"https://clientdev.kesspay.io/api/3DSecureId/3dsT710032233656121?secureKey=FBDSHJF345FBDNVFD@G5499\"><input type=\"hidden\" name=\"MD\" value=\"\"><noscript><div id=\"msg\"><div id=\"submitButton\"><input type=\"submit\" value=\"Click here to continue\" class=\"button\"></div></div></noscript></form></body></html>\n",
        "order_info": {
            "token": "746173280aeb862720557599",
            "out_trade_no": "1234567893",
            "transaction_id": null,
            "body": "iPhone 13 pro Case",
            "total_amount": 10,
            "currency": "USD",
            "meta": null,
            "status": "WAITING",
            "paid_at": null,
            "settled_at": null,
            "settlement_date": null,
            "expired_at": "2022-07-19T13:08:27.000000Z",
            "created_at": "2022-07-19T10:08:28.000000Z",
            "detail": [],
            "seller": {
                "code": "{SELLER CODE}",
                "display_name": "Merchant Name"
            },
            "payment_detail": null
        }
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Close Order

Update transaction status to CLOSED.

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.closeorder",
    "sign_type": "HMAC-SHA256",
    "sign": "4d9ec129143a8f1953b51b1e09f5e632d68f253d4c9458887f0494921922bfb5",
    "out_trade_no": "TEST-1234567891"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.closeorder",
        "sign_type": "HMAC-SHA256",
        "sign": "4d9ec129143a8f1953b51b1e09f5e632d68f253d4c9458887f0494921922bfb5",
        "out_trade_no": "TEST-1234567891"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "token": "111612f019b6836bf1255554",
        "out_trade_no": "TEST-1234567891",
        "transaction_id": null,
        "body": "Repay",
        "total_amount": 10,
        "currency": "USD",
        "status": "CLOSED",
        "paid_at": null,
        "settled_at": null,
        "settlement_date": null,
        "expired_at": "2022-07-18T10:44:53.000000Z",
        "created_at": "2022-07-18T07:44:54.000000Z",
        "detail": [],
        "seller": {
            "code": "{SELLER CODE}",
            "display_name": "Merchant Name"
        },
        "payment_detail": null,
        "error_logs": []
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Query Order

Transaction inquiry.

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.queryOrder",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "out_trade_no": "TEST-1234567891"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.queryOrder",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "out_trade_no": "TEST-1234567891"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "token": "111612f019b6836bf1255554",
        "out_trade_no": "TEST-1234567891",
        "transaction_id": null,
        "body": "iPhone 13 pro Case",
        "total_amount": 10,
        "currency": "USD",
        "status": "WAITING",
        "paid_at": null,
        "settled_at": null,
        "settlement_date": null,
        "expired_at": "2022-07-18T10:44:53.000000Z",
        "created_at": "2022-07-18T07:44:54.000000Z",
        "detail": [],
        "error_logs" : [],
        "seller": {
            "code": "{SELLER CODE}",
            "display_name": "Merchant Name"
        },
        "payment_detail": null,
        "queue_number": "0001",
        "card_info" : {
            "BIN": null,
            "scheme": null,
            "card_token": null,
            "swift_code": null,
            "card_hashed": null,
            "holder_name": null,
            "account_logo": null,
            "account_name": null,
            "account_number": null
        },
        "wechat_alipay_info" : {
            "openid": "2088632596656451",
            "service": "Alipay or Wechat",
            "currency": "USD",
            "total_amount": "0.01",
            "total_amount_cny": "0.07"
        },
        "refund_histories" : [
            {
                "amount": 1,
                "currency": "USD",
                "status": "PARTIAL_REFUNDED",
                "reason": "Vgph5a74fsoQr1fgrSinpe9bh",
                "transaction_id": "TR-123",
                "rejected_reason": null,
                "out_trade_no" : "TR-345",
                "merchant_reference" : "xxx"
            }    
        ]
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Query Refund

Transaction inquiry.

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw 'null'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>{
        "service": "webpay.acquire.queryRefund",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "out_trade_no": "TEST-1234567891",
    },
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "amount": 1,
        "currency": "USD",
        "status": "PARTIAL_REFUNDED",
        "reason": "Vgph5a74fsoQr1fgrSinpe9bh",
        "transaction_id": "TEST-1234567891",
        "rejected_reason": null,
        "out_trade_no" : "TR-345",
        "merchant_reference" : "xxx"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Query Order By Date Range

Transaction inquiry.

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.queryorderbydaterange",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "start_date": "2022-01-15",
    "end_date": "2022-01-16",
    "per_page": 50,
    "page": 1
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.queryorderbydaterange",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "start_date": "2022-01-15",
        "end_date": "2022-01-16",
        "per_page" : 50,
        "page" : 1
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "items": [
            {
                "token": "111612f019b6836bf1255554",
                "out_trade_no": "TEST-1234567891",
                "transaction_id": null,
                "body": "iPhone 13 pro Case",
                "total_amount": 10,
                "currency": "USD",
                "status": "WAITING",
                "paid_at": null,
                "settled_at": null,
                "settlement_date": null,
                "expired_at": "2022-07-18T10:44:53.000000Z",
                "created_at": "2022-07-18T07:44:54.000000Z",
                "detail": [],
                "seller": {
                    "code": "{SELLER CODE}",
                    "display_name": "Merchant Name"
                },
                "payment_detail": null,
                "queue_number": "0001"
            }
        ],
        "current_page": 1,
        "last_page": 1,
        "total": 1,
        "per_page": 50
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Refund

Available for VISA_MASTER ,Wing Bank, ACLEDA Bank, WeChat and Alipay only.
For refund, Visa Card,Wing Bank,ACLEDA Bank processing time is up to 15 days.

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.v2Refund",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "out_trade_no": "TEST-1234567891",
    "reason": "test"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.v2Refund",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "out_trade_no": "TEST-1234567891",
        "reason" : "test"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "amount": 1,
        "currency": "USD",
        "status": "PARTIAL_REFUNDED",
        "reason": "Vgph5a74fsoQr1fgrSinpe9bh",
        "transaction_id": "TR-1234",
        "rejected_reason": null,
        "out_trade_no" : "TR-345",
        "merchant_reference" : "xxx"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Tokenize

Tokenize Card

    
curl --location --request POST 'https://devwebpayment.kesspay.io/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
--data-raw '{
    "service": "webpay.acquire.saveCard",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "seller_code": "{SELLER CODE}",
    "notify_url": "https://sample.com/notifyme"
}'
    

    
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://devwebpayment.kesspay.io/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.saveCard",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "seller_code": "{SELLER CODE}",
        "notify_url": "https://sample.com/notifyme"
    }',
    CURLOPT_HTTPHEADER => array(
        'Content-Type: application/json',
        'Authorization: Bearer {ACCESS TOKEN}'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
    

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.saveCard",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "seller_code": "{SELLER CODE}",
    "notify_url": "https:\/\/sample.com\/notifyme"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.saveCard",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "seller_code": "{SELLER CODE}",
        "notify_url": "https://sample.com/notifyme"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data":  {
        "link": "https://devwebpayment.kesspay.io/spa/inti-card?token=9109e714384c001482515129"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Subscription

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.subscription",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "pre_order_token": "TEST-1234567891",
    "seller_code": "test",
    "holder_name": "test",
    "card": "{ENCRYPTED CARD INFORMATION}",
    "interval": "monthly"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.subscription",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "pre_order_token": "TEST-1234567891",
        "seller_code" : "test",
        "holder_name" : "test",
        "card" : "{ENCRYPTED CARD INFORMATION}",
        "interval" : "monthly"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "code": "SUB2502-101238649986744586",
        "status": "created",
        "html_confirm_payment": "<div id=\"redirectTo3ds1AcsSimple\"></div>"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Pre Authorisation

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.preAuthorisation",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "out_trade_no": "TR2505-1234567891",
    "total_amount": 1,
    "currency": "USD",
    "seller_code": "test",
    "holder_name": "test",
    "notify_url": "https:\/\/test.io\/notify_url",
    "card": "{ENCRYPTED CARD INFORMATION}",
    "customer": "{ENCRYPTED Customer INFORMATION}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.preAuthorisation",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "out_trade_no": "TR2505-1234567891",
        "total_amount" : 1,
        "currency" : "USD",
        "seller_code" : "test",
        "holder_name" : "test",
        "notify_url" : "https://test.io/notify_url",
        "card" : "{ENCRYPTED CARD INFORMATION}",
        "customer" : "{ENCRYPTED Customer INFORMATION}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "total_amount": 1,
        "currency": "USD",
        "confirm_payment_url": "http://127.0.0.1:8000/mch-load-3ds/157f79c9e76b771043047148"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Generate Pre Authorisation Link

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.generatePreAuthorisationLink",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "out_trade_no": "TR2505-1234567891",
    "total_amount": 1,
    "currency": "USD",
    "seller_code": "test",
    "notify_url": "https:\/\/test.io\/notify_url"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.generatePreAuthorisationLink",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "out_trade_no": "TR2505-1234567891",
        "total_amount" : 1,
        "currency" : "USD",
        "seller_code" : "test",
        "notify_url" : "https://test.io/notify_url"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "total_amount": 1,
        "currency": "USD",
        "link": "http://127.0.0.1:8000/spa/pre-authorisation-link?token=e6256824f07353e05576719a"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Pay Pre Authorisation

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.payPreAuthorisation",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "out_trade_no": "TR2505-1234567891",
    "total_amount": 1,
    "currency": "USD",
    "seller_code": "test",
    "notify_url": "https:\/\/test.io\/notify_url",
    "ref": "xxxx"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.payPreAuthorisation",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "out_trade_no": "TR2505-1234567891",
        "total_amount" : 1,
        "currency" : "USD",
        "seller_code" : "test",
        "notify_url" : "https://test.io/notify_url",
        "ref" : "xxxx"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "token": "111612f019b6836bf1255554",
        "out_trade_no": "TEST-1234567891",
        "transaction_id": null,
        "body": "iPhone 13 pro Case",
        "total_amount": 10,
        "currency": "USD",
        "status": "WAITING",
        "paid_at": null,
        "settled_at": null,
        "settlement_date": null,
        "expired_at": "2022-07-18T10:44:53.000000Z",
        "created_at": "2022-07-18T07:44:54.000000Z",
        "detail": [],
        "error_logs" : [],
        "seller": {
            "code": "{SELLER CODE}",
            "display_name": "Merchant Name"
        },
        "payment_detail": null,
        "queue_number": "0001",
        "card_info" : {
            "BIN": null,
            "scheme": null,
            "card_token": null,
            "swift_code": null,
            "card_hashed": null,
            "holder_name": null,
            "account_logo": null,
            "account_name": null,
            "account_number": null
        },
        "wechat_alipay_info" : {
            "openid": "2088632596656451",
            "service": "Alipay or Wechat",
            "currency": "USD",
            "total_amount": "0.01",
            "total_amount_cny": "0.07"
        },
        "refund_histories" : []
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Reversal

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.payPreAuthorisation",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "seller_code": "test",
    "ref": "xxxx"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.payPreAuthorisation",
        "sign_type": "MD5",
        "sign": "{SIGNATURE}",
        "seller_code" : "test",
        "ref" : "xxxx"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "ref": "111612f019b6836bf1255554",
        "amount": 10,
        "currency": "USD"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Withdraw (Cash-out)

To withdraw (cash-out) please follow these guidelines:

1. Verify bank account
2. Tokenize bank account
3. Initiate withdrawal transaction

Verify Bank Account

Verify bank account number and pull bank number holder name (use to display to sender).

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.verifybankaccount",
    "sign": "00afabe1d95f8f671becc626b4785c39",
    "sign_type": "MD5",
    "seller_code": "{SELLER CODE}",
    "bank_account_number": "123456789",
    "bic": "ABAAKHPP"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.verifybankaccount",
        "sign": "00afabe1d95f8f671becc626b4785c39",
        "sign_type": "MD5",
        "seller_code": "{SELLER CODE}",
        "bank_account_number": "123456789",
        "bic": "ABAAKHPP"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "owner_name": "TESTING-ABA-KESS",
        "currency": "USD",
        "account_number": "123456789"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Tokenize Bank Account

Store bank account numbers with customer information in the KESS system for future usage.

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.tokenizebankaccount",
    "sign": "79e69e298da1c85cf09366c35e366917",
    "sign_type": "MD5",
    "bank_account_number": "123456789",
    "bic": "ABAAKHPP",
    "seller_code": "{SELLER CODE}",
    "customer": "{ENCRYPTED CUSTOMER DATA}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.tokenizebankaccount",
        "sign": "79e69e298da1c85cf09366c35e366917",
        "sign_type": "MD5",
        "bank_account_number": "123456789",
        "bic": "ABAAKHPP",
        "seller_code": "{SELLER CODE}",
        "customer": "{ENCRYPTED CUSTOMER DATA}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "token": "02246c07832b03d22a81551c7e962129c5628301324a0c90a",
        "holder_name": "TESTING-ABA-KESS",
        "account_number": "12****789",
        "bank_bic": "ABAAKHPP",
        "currency": "USD"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Withdraw

Withdraw from merchant wallet to bank account (tokenized bank account).

Sequence diagram

API specification

POST {baseUrl}/api/mch/v2/gateway requires authentication

• Sample request
• Sample response

                    
curl --location --request POST '{baseUrl}/api/mch/v2/gateway' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
    --data-raw '{
    "service": "webpay.acquire.withdraw",
    "sign": "79e69e298da1c85cf09366c35e366917",
    "sign_type": "MD5",
    "seller_code": "{SELLER CODE}",
    "bank_account_token": "02246c07832d03d22a81551c7e962129c5628301324a0c90d",
    "out_trade_no": "WD-00000TEST0002",
    "total_amount": 10,
    "currency": "USD",
    "expires_in": 300,
    "customer": "{ENCRYPTED CUSTOMER DATA}"
}'

                    
                

                    
$curl = curl_init();


curl_setopt_array($curl, array(
    CURLOPT_URL => '{baseUrl}/api/mch/v2/gateway',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "service": "webpay.acquire.withdraw",
        "sign": "79e69e298da1c85cf09366c35e366917",
        "sign_type": "MD5",
        "seller_code": "{SELLER CODE}",
        "bank_account_token": "02246c07832d03d22a81551c7e962129c5628301324a0c90d",
        "out_trade_no": "WD-00000TEST0002",
        "total_amount": 10,
        "currency": "USD",
        "expires_in": 300,
        "customer": "{ENCRYPTED CUSTOMER DATA}"
    }',
    CURLOPT_HTTPHEADER => array(
         'Content-Type: application/json' ,
        'Authorization: Bearer {ACCESS TOKEN}' 
    )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;
                    
                

                    
{
    "success": true,
    "data": {
        "token": "UHlHRHk2Nzg462df82a70a8bc",
        "out_trade_no": "WD-00000TEST0002",
        "transaction_id": null,
        "body": "Fund transfer",
        "total_amount": -10,
        "currency": "USD",
        "status": "WAITING",
        "paid_at": null,
        "settled_at": null,
        "settlement_date": null,
        "expired_at": "2022-07-26T06:04:03.000000Z",
        "created_at": "2022-07-26T05:59:03.000000Z",
        "detail": [],
        "seller": {
            "code": "{SELLER CODE}",
            "display_name": "Merchant Name"
        },
        "payment_detail": {
            "id": 8949,
            "payer_id": 793,
            "method_id": 12,
            "tokenize_id": 944,
            "method_desc": "Transfer to customer bank (From Merchant wallet)",
            "holder_name": "airport.taxi",
            "card_info": null,
            "bank_info": null,
            "created_at": "2022-07-26T05:59:03.000000Z",
            "payment_method_bic": "ABAAKHPP",
            "payment_method": {
                "id": 12,
                "title": "ABA PAY",
                "instruction_text": null,
                "type": "tokenize_bank_account",
                "img": "payment-methods/January2021/zNSxh2tYwT9KaNnoQb67.png",
                "app_name": "ABA Mobile",
                "app_logo": null,
                "brand_logo": "payment-methods/August2021/DIoFm9KEvnrnNf6w5Cm4.png",
                "swift_code": "ABAAKHPP",
                "payment_type": "offline",
                "sort_level": "1",
                "emv_enabled": 0,
                "native_pay_enabled": 1,
                "ios_deeplink": "itms-apps://apple.com/app/968860649",
                "android_deeplink": "https://play.google.com/store/apps/details?id=com.paygo24.ibank&hl=en&gl=US",
                "activated": 1,
                "created_at": null,
                "updated_at": "2022-07-01T08:20:05.000000Z",
                "deleted_at": null
            }
        },
        "receiver_name": "Sok Dara",
        "is_required_otp": true,
        "verify_otp_url": "{URL}"
    },
    "sign": "{SIGNATURE}",
    "sign_type": "MD5"
}      
              
                    
                

Signature

Signature algorithm

Sample ...

    
function makeSign(array $param, $key)
{
    $signType = $param['sign_type'];

    $string = toUrlParams($param);
    $string = $string . "&key=".$key;

    if ($signType == "MD5")
        $string = md5($string);
    else if ($signType == "HMAC-SHA256")
        $string = hash_hmac("sha256", $string, $key);

    return $string;
}

function toUrlParams(array $values)
{

    $values = array_filter($values, function ($var) {
        return !is_null($var);
    });

    ksort($values);

    $buff = "";

    foreach ($values as $k => $v)
    {
        if($k != "sign" && $v !== "" && !is_array($v) && !is_object($v)){
            $buff .= $k . "=" . $v . "&";
        }
    }

    $buff = trim($buff, "&");

    return $buff;
}

// Request parameters
$params = json_decode('
{
    "service": "webpay.acquire.directPay",
    "sign_type": "MD5",
    "sign": "{SIGNATURE}",
    "seller_code": "{SELLER CODE}",
    "out_trade_no": "TEST-1234567891",
    "body": "iPhone 13 pro Case",
    "total_amount": 10,
    "currency": "USD",
    "notify_url": "https://sample.com/notifyme",
    "redirect_url": "https://sample.com/redirectme",
    "card": "{ENCRYPTED CARD INFORMATION}"
}
', true);

echo makeSign($params, '{API SECRET KEY}');
    

Objects

Common objects that used in the API Gateway.

setting

customer

    
$rawText = json_encode([
    "phone_number" => "12345678"
    "email" => "sample@sample.com",
    "first_name" => "Sok",
    "last_name" => "Dara",
    "phone_code" => "855"
]);

$publicKey = '-----BEGIN PUBLIC KEY-----
...
-----END PUBLIC KEY-----
';

openssl_public_encrypt($rawText, $encrypted, $publicKey);

$encrypted_hex = bin2hex($encrypted);

echo $encrypted_hex;
    

transaction

order_info

payment_detail

card

    
$rawText = json_encode([
    "number" => "5473500160001018",
    "securityCode" => "123",
    "expiry" => [
        "month" => "12",
        "year"  => "35"
    ]
]);

$publicKey = '-----BEGIN PUBLIC KEY-----
...
-----END PUBLIC KEY-----
';

openssl_public_encrypt($rawText, $encrypted, $publicKey);

$encrypted_hex = bin2hex($encrypted);

echo $encrypted_hex;
    

{
    "month": "12",
    "year": "35"
}

payment_method

{
    "ios": "itms-apps://apple.com/app/1518521952",
    "android": "https://play.google.com/store/apps/details?id=io.kessinnovation.kesschat"
}

bank_info

card_info

user_info