Introduction
This section describes the xCash payment gateway API.
xCash API is easy to implement in your business software. Our API is well formatted URLs, accepts cURL requests, returns JSON responses.
You can use the API in test mode, which does not affect your live data. The API key is use to authenticate the request and determines the request is valid payment or not. For test mode just use the sandbox URL and In case of live mode use the live URL from section Initiate Payment .
Supported Currencies
This section describes the currencies supported by xCash
xCash allows to make transaction with below currencies. Any new currency may update in future.
| Currency Name | Currency Symbol | Currency Code |
|---|---|---|
| Usd | usd | USD |
Get The Api Key
This section describes how you can get your api key.
Login to your xCash merchant account. If you don't have any ? Click Here
Next step is to find the Api Key menu in your dashboard sidebar. Click the menu.
The api keys can be found there which is Public key and Secret key. Use these keys to initiate the API request. Every time you can generate new API key by clicking Generate Api Key button. Remember do not share these keys with anyone.
Initiate Payment
This section describes the process of initaiing the payment.
To initiate the payment follow the example code and be careful with the perameters. You will need to make request with these following API end points.
Live End Point: https://duyus.com/payment/initiate
Test End Point: https://duyus.com/sandbox/payment/initiate
Test Mode Mail: test_mode@mail.com
Test Mode Verification Code: 222666
Request Method: POST
Request to the end point with the following parameters below.
| Param Name | Param Type | Description |
|---|---|---|
| public_key | string (50) | Required Your Public API key |
| identifier | string (20) | Required Identifier is basically for identify payment at your end |
| currency | string (4) | Required Currency Code, Must be in Upper Case. e.g. USD,EUR |
| amount | decimal | Required Payment amount. |
| details | string (100) | Required Details of your payment or transaction. |
| ipn_url | string | Required The url of instant payment notification. |
| success_url | string | Required Payment success redirect url. |
| cancel_url | string | Required Payment cancel redirect url. |
| site_logo | string/url | Required Your business site logo. |
| checkout_theme | string | Optional Checkout form theme dark/light. Default theme is light |
| customer_name | string (30) | Required Customer name. |
| customer_email | string (30) | Required Customer valid email. |
<?php
$parameters = [
'identifier' => 'DFU80XZIKS',
'currency' => 'USD',
'amount' => 100.00,
'details' => 'Purchase T-shirt',
'ipn_url' => 'http://example.com/ipn_url.php',
'cancel_url' => 'http://example.com/cancel_url.php',
'success_url' => 'http://example.com/success_url.php',
'public_key' => 'your_public_key',
'site_logo' => 'https://duyus.com/assets/images/logoIcon/logo.png',
'checkout_theme' => 'dark',
'customer_name' => 'John Doe',
'customer_email' => 'john@mail.com',
];
//live end point
$url = "https://duyus.com/payment/initiate";
//test end point
$url = "https://duyus.com/sandbox/payment/initiate";
$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS, $parameters);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
//$result contains the response back.
?>//Error Response.
{
"error": "true",
"message": "Invalid api key"
}
//Success Response.
{
"success": "ok",
"message": "Payment Initiated. Redirect to url.",
"url":"http://example.com/initiate/payment/checkout?payment_id=eJSAASDxdrt4DASDASVNASJA7893232432cvmdsamnvASF"
}
Validate The Payment and IPN
This section describes the process to get your instant payment notification.
To initiate the payment follow the example code and be careful with the perameters. You will need to make request with these following API end points.
End Point: Your business application ipn url.
Request Method: POST
You will get following parameters below.
| Param Name | Description |
|---|---|
| status | Payment success status. |
| identifier | Identifier is basically for identify payment at your end. |
| signature | A hash signature to verify your payment at your end. |
| data | Data contains some basic information with charges, amount, currency, payment transaction id etc. |
<?php
//Receive the response parameter
$status = $_POST['status'];
$signature = $_POST['signature'];
$identifier = $_POST['identifier'];
$data = $_POST['data'];
// Generate your signature
$customKey = $data['amount'].$identifier;
$secret = 'YOUR_SECRET_KEY';
$mySignature = strtoupper(hash_hmac('sha256', $customKey , $secret));
$myIdentifier = 'YOUR_GIVEN_IDENTIFIER';
if($status == "success" && $signature == $mySignature && $identifier == $myIdentifier){
//your operation logic
}
?>