?trackid=xxxx&result=xxxx&refid=&errormessage=&Hash=xxxx
```
### **Call Back Response Parameters**
| **Parameters** | Data Type | Description |
| --------------- | --------- | --------------------------------------------------------------------------------------- |
| `trackid` | string | Reference ID passed in the request. |
| `result` | string | Payment result.
Example: CAPTURED, NOT CAPTURED, DECLINED, REJECTED, BLOCKED.
|
| `refid` | string | Payment Reference Number. |
| `error message` | string | If result is other than CAPTURED, then it gives you the actual reason. |
| `hash` | string | Use this for integrity of the data explained in response integrity section |
### How to identify parameters that are tampered?
If you want to check whether the parameters tamper or not, convert below parameters into a hash and compare with your hash which you got as a response in a query string.
Use the below method to identify parameter tempering.
```
String outParams = $"trackid={trackid}&result={result}&refid={refid}";
String outhashValue = GetHashValue(outParams,_key);
if (Hash != outhashValue)
{
//This means it is tampered
// Your code
}
else{
}
```
# 4. Compute HASH
### Hashing Methods
The parameter tampering attack is based on the manipulation of parameters exchanged between client and server in order to modify application data, such as user credentials, amount and quantity of products, etc.
{% tabs %}
{% tab title="C#" %}
```csharp
public string ComputeHash(Request _req)
{
string _key= { Secret Key Provided by OG}
string datatocomputeHash = $"{_req.amount}{_req.authKey}{_req.currency}{_req.merchantCode}{_req.pc}{_req.referenceID}{_req.sourceCurrency}{_req.timeStamp}{_req.tunnel}{_req.userReference}";
return GetHashValue(datatocomputeHash, _key);
}
public string GetHashValue(String datatocomputeHash, String HashKey)
{
HMACSHA256 hmac = new HMACSHA256(System.Text.Encoding.UTF8.GetBytes(HashKey));
string computedHash = convertToHex(hmac.ComputeHash(System.Text.UTF8Encoding.Default.GetBytes(datatocomputeHash)));
return computedHash;
}
private string convertToHex(byte[] data)
{
System.Text.StringBuilder sb = new System.Text.StringBuilder(data.Length);
foreach (byte b in data)
sb.AppendFormat("{0:X2}", (int)b);
return sb.ToString();
}
```
{% endtab %}
{% tab title="VB.Net" %}
```aspnet
Private Function ComputeHash(ByVal _req As Request) As String
Dim _key As Strig={ Secret Key Provided by OG}
Dim datatocomputeHash As String = $"{_req.amount}{_req.authKey}{_req.currency}{_req.merchantCode}{_req.pc}{_req.referenceID}{_req.sourceCurrency}{_req.timeStamp}{_req.tunnel}{_req.userReference}"
Return GetHashValue(datatoHash, _key)
End Function
Public Function GetHashValue(ByVal datatocomputeHash As String, ByVal HashKey As String) As String
Dim hmac As HMACSHA256 = New HMACSHA256(System.Text.Encoding.UTF8.GetBytes(HashKey))
Dim computedHash As String = convertToHex(hmac.ComputeHash(System.Text.UTF8Encoding.[Default].GetBytes(datatocomputeHash)))
Return computedHash
End Function
Private Function convertToHex(ByVal data As Byte()) As String
Dim sb As System.Text.StringBuilder = New System.Text.StringBuilder(data.Length)
For Each b As Byte In data
sb.AppendFormat("{0:X2}", CInt(b))
Next
Return sb.ToString()
End Function
```
{% endtab %}
{% tab title="PHP" %}
```php
private function ComputeHash(Request $req)
{
$_key= {Secret Key Provided by OG}
$datatocomputeHash = $_req.amount.$_req.authKey.$_req.currency.$_req.merchantCode.$_req.pc.$_req.referenceID.$_req.sourceCurrency.$_req.timeStamp.$_req.tunnel.$_req.userReference;
return GetHashValue($datatocomputeHash, $_key);
}
public function GetHashValue($datatocomputeHash,$HashKey)
{
$computedHash = strtoupper(hash_hmac("sha256", $datatocomputeHash,$HashKey));
return $computedHash
}
```
{% endtab %}
{% tab title="TypeScript" %}
```
private ComputeHash(_req: Request): string {
let _key={ Secret Key Provided by OG}
let datatocomputeHash: string = "{_req.amount}{_req.authKey}{_req.currency}{_req.merchantCode}{_req.pc}{_req.referenceID}{_req.sourceCurrency}{_req.timeStamp}{_req.tunnel}{_req.userReference}";
return GetHashValue(datatocomputeHash, _key);
}
public GetHashValue(datatocomputeHash: String, HashKey: String): string {
let hmac: HMACSHA256 = new HMACSHA256(System.Text.Encoding.UTF8.GetBytes(HashKey));
let computedHash: string = convertToHex(hmac.ComputeHash(System.Text.UTF8Encoding.Default.GetBytes(datatocomputeHash)));
return computedHash;
}
pagecode:` private string convertToHex(byte[] data)
{
System.Text.StringBuilder sb = new System.Text.StringBuilder(data.Length);
foreach (byte b in data)
sb.AppendFormat("{0:X2}", (int)b);
return sb.ToString();
}`;
```
{% endtab %}
{% endtabs %}
###
# 5. Refund Request
API to request the refund for the paid transactions.
### API Endpoints
{% tabs %}
{% tab title="Production" %}
```
Production Base URL /api/GenToken/Refund
```
{% endtab %}
{% tab title="Sandbox" %}
```
Sandbox Base URL /api/GenToken/Refund
```
{% endtab %}
{% endtabs %}
### **Sample Request & Response**
{% tabs %}
{% tab title="Sample Request" %}
```coffeescript
{
"merchantCode":"xxxxx",
"authKey":"xxxxxxxxx",
"ReferenceID":"(15 digit number passing during the payment creation)",
"hash":"ComputedHash(To be calculated as described below)",
"Amount":1,
"Description":"optional",
"RequestedBy":"optional"
}
```
{% endtab %}
{% tab title="Sample Response" %}
```
{
"errorCode": 0 is Success 1 is Failed,
"errorMessgae": "Message",
"Result":
{
"IsRefunded":"1 is refunded | 2 is under process | 0 is rejected"
}
}
```
{% endtab %}
{% endtabs %}
### Hash Creation
Use the below string format to generate an hash value using Hashing Key.
Amount + AuthenticationKey + MerchantCode + ReferenceID
### **Response Parameters**
| Parameters | Data Type | Description |
| -------------------- | --------- | ------------------------------------------------------------- |
| errorCode | Integer | 0 is success 1 is failed and 2 is initiated for manual refund |
| `errorMessage` | String | |
| result -> IsRefunded | Integer | 1 is refunded \| 2 is under process \| 0 is rejected |
Merchant will receive an email from Og regarding the updates (under process, cancelled and refunded) of refund.
**Sample Code to post data**
{% tabs %}
{% tab title="C#" %}
```
public async Task> RefundPayment(RefundPaymentRequest obj)
{
Output dto = new Output();
var url = {Provided End Point};
var client = new HttpClient();
client.BaseAddress = new Uri(url);
try
{
obj.hash = ComputeHash(obj);
var resultser = JsonConvert.SerializeObject(obj);
client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json; charset=utf-8");
var response = client.PostAsJsonAsync(url, obj).Result;
if (response.IsSuccessStatusCode)
{
var ss = response.Content.ReadAsStringAsync();
var result = JsonConvert.DeserializeObject>(ss.Result);
dto = result;
}
else
{
var ss = response.Content.ReadAsStringAsync();
var resps = ss.Result.ToString();
}
}
catch (HttpRequestException ex)
{
}
return dto;
}
```
{% endtab %}
{% tab title="VB.Net" %}
```
Class SurroundingClass
Public Task As async
Private Sub New(ByVal obj As RefundPaymentRequest )
Dim dto As Output = New Output()
Dim url = {Provided End Point};
Dim client = New HttpClient()
client.BaseAddress = New Uri(url)
Try
obj.hash = ComputeHash(obj)
Dim resultser = JsonConvert.SerializeObject(obj)
client.DefaultRequestHeaders.Accept.Add(New System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"))
client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json; charset=utf-8")
Dim response = client.PostAsJsonAsync(url, obj).Result
If response.IsSuccessStatusCode Then
Dim ss = response.Content.ReadAsStringAsync()
Dim result = JsonConvert.DeserializeObject > (ss.Result)
dto = result
Else
Dim ss = response.Content.ReadAsStringAsync()
Dim resps = ss.Result
Dim resultse = JsonConvert.SerializeObject(resps.ToString())
End If
Catch ex As HttpRequestException
End Try
Return dto
End Sub
End Class
```
{% endtab %}
{% tab title="PHP" %}
```
$merchantID,
'authKey' => $authKey,
'hash' => $hash
'amount' => ( float )$amount,
'description' => $description,
'RequestedBy' => $RequestedBy,
);
$request = json_encode( $data, true );
if ( !$endpoint ) {
$curl = curl_init( 'Provided End Point' );
} else {
$curl = curl_init( $endpoint );
}
curl_setopt( $curl, CURLOPT_POST, true );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $request );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_HTTPHEADER, array( 'Content-Type:application/json' ) );
$ch = curl_exec( $curl );
curl_close( $curl );
$response = json_decode( $ch, true );
?>
```
{% endtab %}
{% tab title="TypeScript" %}
```
pagecode:` public async Task> RefundRequest(RefundPaymentRequest obj)
{
Output dto = new Output();
var url = {Provided End Point};
var client = new HttpClient();
client.BaseAddress = new Uri(url);
try
{
obj.hash = ComputeHash(obj);
var resultser = JsonConvert.SerializeObject(obj);
client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json; charset=utf-8");
var response = client.PostAsJsonAsync(url, obj).Result;
if (response.IsSuccessStatusCode)
{
var ss = response.Content.ReadAsStringAsync();
var result = JsonConvert.DeserializeObject>(ss.Result);
dto = result;
}
else
{
var ss = response.Content.ReadAsStringAsync();
var resps = ss.Result;
var resultse = JsonConvert.SerializeObject(resps.ToString());
}
}
catch (HttpRequestException ex)
{
}
return dto;
}`;
```
{% endtab %}
{% endtabs %}
# 6. Payment Status
API to get the status of a payment
### API Endpoint
{% tabs %}
{% tab title="Production" %}
```
Production Base URL /api/GenToken/GetStatus
```
{% endtab %}
{% tab title="Sandbo" %}
```
Sandbox Base URL /api/GenToken/GetStatus
```
{% endtab %}
{% endtabs %}
### **Sample Request & Response**
{% tabs %}
{% tab title="Sample Request" %}
```postman_json
{
"merchantCode":"xxxxx",
"authKey":"xxxxx",
"ReferenceID":"(15 digit number passing during the payment creation)"
}
```
{% endtab %}
{% tab title="Sample Response for Captured" %}
```json
{
"errorCode": 0,
"errorMessgae": "",
"result": {
"tranDate": 260125,
"referenceID": 479865896769733,
"amount": 10,
"charges": 0.25,
"paidAmount": 10,
"countryCode": "KW",
"currencyCode": "KWD",
"paymentChannelCode": "KWKNETDCCORE",
"tunnel": "kibtest",
"authCode": "B30286",
"transactionID": "502610000474188",
"refID": "502610000300",
"paymentID": "100502610000004439",
"result": "CAPTURED",
"status": 1,
"merchantRef": null,
"transactionDate": "2025-01-26T12:01:55.4101568",
"processedDate": "2025-01-26T12:02:36.7615293",
"mobile": "0",
"email": null,
"response": "REFUNDED",
"info1": "USA",
"info2": null,
"info3": null,
"settlementDate": null,
"settledDate": null,
"settledBy": null,
"isRefunded": true,
"refundAmount": 10,
"refundedOn": "2025-01-26T12:03:38.637",
"refundRefrence": null,
"commissionAmnt": null,
"serviceAmount": null,
"merchantName": null,
"originalAmount": null,
"commissionDetails": null,
"vat": null,
"vatAmount": null,
"finalCommission": null
}
}
```
{% endtab %}
{% tab title="Sample Response for NotCaptured" %}
```
{
"errorCode": 0,
"errorMessgae": "",
"result": {
"tranDate": 260125,
"referenceID": 762532132798579,
"amount": 0.01,
"charges": 0,
"paidAmount": 0.01,
"countryCode": "KW",
"currencyCode": "KWD",
"paymentChannelCode": "KWKFHMPGSCCKWD",
"tunnel": "nbklocal",
"authCode": null,
"transactionID": null,
"refID": null,
"paymentID": "b394481c3e4c4254",
"result": "NOT CAPTURED",
"status": 2,
"merchantRef": "SESSION0002044905074I70319456L0",
"transactionDate": "2025-01-26T12:08:14.0891371",
"processedDate": "2025-01-26T13:54:22.0071249+03:00",
"mobile": "0",
"email": null,
"response": "INVALID_REQUEST||Unable+to+find+order+762532132798579+for+merchant+900484001",
"info1": "en_US",
"info2": null,
"info3": "////",
"settlementDate": null,
"settledDate": null,
"settledBy": null,
"isRefunded": null,
"refundAmount": null,
"refundedOn": null,
"refundRefrence": null,
"commissionAmnt": null,
"serviceAmount": null,
"merchantName": null,
"originalAmount": null,
"commissionDetails": null,
"vat": null,
"vatAmount": null,
"finalCommission": null
}
}
```
{% endtab %}
{% tab title="Sample Response For Exception" %}
```
{
"errorCode": 1,
"errorMessgae": "Transaction not found at OG.",
"result": {
"tranDate": null,
"referenceID": null,
"amount": null,
"charges": null,
"paidAmount": null,
"countryCode": null,
"currencyCode": null,
"paymentChannelCode": null,
"tunnel": null,
"authCode": null,
"transactionID": null,
"refID": null,
"paymentID": null,
"result": null,
"status": null,
"merchantRef": null,
"transactionDate": null,
"processedDate": null,
"mobile": null,
"email": null,
"response": null,
"info1": null,
"info2": null,
"info3": null,
"settlementDate": null,
"settledDate": null,
"settledBy": null,
"isRefunded": null,
"refundAmount": null,
"refundedOn": null,
"refundRefrence": null,
"commissionAmnt": null,
"serviceAmount": null,
"merchantName": null,
"originalAmount": null,
"commissionDetails": null,
"vat": null,
"vatAmount": null,
"finalCommission": null
}
}
```
{% endtab %}
{% endtabs %}
#### Response Explanation
If errorCode is not "0" then check errorMessage for more details.
If errorCode is "0" then only check for Result object.
### Response Parameters
| Parameters | Datatype | Description |
| ----------- | ------------- | ---------------------------------------------------------- |
| referenceID | String | 15 digit unique transaction number |
| amount | decimal | Amount of transaction |
| tranDate | Integer | Date of the transaction(DDMMYY) |
| result | string | Shows the result of the transaction (CANCELED or CAPTURED) |
| isRefunded | Bool(nulable) | True if refunded |
### Sample code to post data
{% tabs %}
{% tab title="C#" %}
```
public async Task> CheckPaymentStatus(PaymentStatus obj)
{
Output dto = new Output();
var url = {Provided End Point};
var client = new HttpClient();
client.BaseAddress = new Uri(url);
try
{
var resultser = JsonConvert.SerializeObject(obj);
client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json; charset=utf-8");
var response = client.PostAsJsonAsync(url, obj).Result;
if (response.IsSuccessStatusCode)
{
var ss = response.Content.ReadAsStringAsync();
var result = JsonConvert.DeserializeObject>(ss.Result);
dto = result;
}
else
{
var ss = response.Content.ReadAsStringAsync();
var resps = ss.Result.ToString();
}
}
catch (HttpRequestException ex)
{
}
return dto;
}
```
{% endtab %}
{% tab title="VB.Net" %}
```
Class SurroundingClass
Public Task As async
Private Sub New(ByVal obj As PaymentStatus )
Dim dto As Output = New Output()
Dim url = {Provided End Point};
Dim client = New HttpClient()
client.BaseAddress = New Uri(url)
Try
Dim resultser = JsonConvert.SerializeObject(obj)
client.DefaultRequestHeaders.Accept.Add(New System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"))
client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json; charset=utf-8")
Dim response = client.PostAsJsonAsync(url, obj).Result
If response.IsSuccessStatusCode Then
Dim ss = response.Content.ReadAsStringAsync()
Dim result = JsonConvert.DeserializeObject > (ss.Result)
dto = result
Else
Dim ss = response.Content.ReadAsStringAsync()
Dim resps = ss.Result
Dim resultse = JsonConvert.SerializeObject(resps.ToString())
End If
Catch ex As HttpRequestException
End Try
Return dto
End Sub
End Class
```
{% endtab %}
{% tab title="PHP" %}
```
$merchantID,
'authKey' => $authKey,
'referenceID' => $referenceID,
);
$request = json_encode( $data, true );
if ( !$endpoint ) {
$curl = curl_init( 'Provided End Point' );
} else {
$curl = curl_init( $endpoint );
}
curl_setopt( $curl, CURLOPT_POST, true );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $request );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_HTTPHEADER, array( 'Content-Type:application/json' ) );
$ch = curl_exec( $curl );
curl_close( $curl );
$response = json_decode( $ch, true );
?>
```
{% endtab %}
{% tab title="TypeScript" %}
```
pagecode:` public async Task> PaymentStatus(PaymentStatus obj)
{
Output dto = new Output();
var url = {Provided End Point};
var client = new HttpClient();
client.BaseAddress = new Uri(url);
try
{
var resultser = JsonConvert.SerializeObject(obj);
client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json; charset=utf-8");
var response = client.PostAsJsonAsync(url, obj).Result;
if (response.IsSuccessStatusCode)
{
var ss = response.Content.ReadAsStringAsync();
var result = JsonConvert.DeserializeObject>(ss.Result);
dto = result;
}
else
{
var ss = response.Content.ReadAsStringAsync();
var resps = ss.Result;
var resultse = JsonConvert.SerializeObject(resps.ToString());
}
}
catch (HttpRequestException ex)
{
}
return dto;
}`;
```
{% endtab %}
{% endtabs %}
# Parameters & Description
### Parameters
| Parameters Name | Data Types | Required | Description |
| -------------------- | ---------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`merchantCode`** | `string` | Yes | Provided by Platform Payments
Ex: KW23281
|
| **`authKey`** | `string` | Yes | Provided by Platform Payments
Ex: eaOZH3MnSslWexl
|
| **`currency`** | `string` | Yes | Refer "[Payment Channels](/payment-methods)" Table.`( KWD, BHD, USD, EGP, SAR, GBP, EUR, etc.)` |
| **`pc`** | `string` | Yes | a) For specific payment method, pass that particular payment method code.
Ex: KWKNETDC for KNET
BHBENEFITDC for Benefit
EGUPGCC for Meeza
b) To show all payment methods use the code "all".
Ex: all
c) For specific country payment methods, use the code "currency"
and the pass desired country's standard three letter currency code in currency parameter.
Ex: currency
|
| **`tunnel`** | `string` | Optional | Provided by OG if requires. |
| **`amount`** | `double` | Yes | Your customer transaction amount. `Ex: 1.000` |
| **`doConvert`** | `string` | Yes | When the amount needs to be converted to other currency, then the value should be **"Y"**, else **"N"**. |
| **`sourceCurrency`** | `string` | Conditional | When the amount needs to be converted the other currency, then pass standard three letter currency code. ( KWD, BHD, USD, EGP, SAR, GBP, EUR, etc.)
Ex: If Amount to be converted from USD to KWD, then doConvert=Y and sourceCurrency=USD
|
| **`description`** | `string` | Optional | Your product/item name or description. |
| **`referenceID`** | `long` | Yes | Must be 15 digits unique number.
Ex: 123456789012345
|
| **`timeStamp`** | `string` | Yes | Current Date & Time when the payment's URL generating.
Ex: 202101241619123
|
| **`language`** | `string` | Optional | English (en) / Arabic (ar) |
| **`callbackURL`** | `string` | Yes | Once the transaction is completed, the customer will be redirected to the given response URL.
Ex:
|
| **`userreference`** | long | Conditional | Your customer's mobile number or any unique number (minimum 8 digits and maximum 15 digits) for Quick Pay service.
Example: KFAST for KNET
Which the customer can save their card(s) details, enabling them to carry out any future transactions with the same merchant, in a speedy manner, by only having to enter their PIN when prompted.
Note: Quick Pay service should be enabled for the merchant by OG, in order to use this service.
Ex: 12345678
|
| **`hash`** | `string` | Yes | Please refer here.
Ex: B400HJKHKJ00000JKHJKHKJJK032321JKHFJKHF
|
| **`BillingDetails`** | | | |
| **`fName`** | `string` | Optional | Your customer's First Name. |
| **`lName`** | `string` | Optional | Your customer's Last Name. |
| **`mobile`** | `string` | Optional | You customer's Mobile Number. |
| **`email`** | `string` | Optional | Your customer's Email. |
| **`city`** | `string` | Optional | Your customer's Shipping City. |
| **`pincode`** | `string` | Optional | Your customer's Postal/Zip Code. |
| **`state`** | `string` | Optional | Your customer's Billing State. |
| **`address1`** | `string` | Optional | Your customer's Billing Address. |
| **`address2`** | `string` | Optional | Your customer's Billing Address. |
###
| |
| - |
# Payment Methods
| Country | Country Code | Payment Channels | Payment Code | Currency Code |
| ----------- | ------------ | -------------------------------------------------------- | --------------------------------------------------- | ------------------------------ |
| **Kuwait** | `KW` | KNET
VISA/MasterCard
American Express
| KWKNETDC
KWKFHMPGSCCKWD
KWAMEXCC
| KWD
KWD
KWD
|
| **Egypt** | `EG` | VISA/MasterCard( Misr Bank)
Meeza
| EGMISRMPGS
EGUPGCC
| EGP
EGP
|
| **Bahrain** | `BH` | Benefit Debit Card
VISA/MasterCard
| BHBENEFITDC
BHKFHMPGSCC
| BHD
BHD
|
| **USA** | `US` | VISA/MasterCard | KWKFHMPGSCCUSD | USD |
# Test Cards
Test your integration
Please use the following test card number to simulate the charging process as your customer.
### Card Details
| Card Name | Card Number | Expiry Date (mm/yy) | CVV/PIN |
| --------------------------- | -------------------------------------------------------- | ------------------------------------------------------ | ----------------- |
| **Master** | 5123450000000008
2223000000000007
| 01 / 39
01 / 39
| 100
100
|
| **VISA** | 4508750015741019
4012000033330026
| 01 / 39
01 / 39
| 100
100
|
| **KNET** | 8888880000000001
8888880000000009 (KFAST)
| 09 / 25
Any Other value for "NOT CAPTUED"
| 1234 |
| **Benefit** | 4600410123456789 | 05/29 | 1234 |
| **American Express (Amex)** | 345678901234564 | 01 / 39 | 1000 |
### Expiry Dates
Please use the following expiry dates to simulate the different Transaction responses for Credit Cards only.
| **Expiry Date** | **Transaction Response Gateway Code** |
| --------------- | ------------------------------------- |
| 01 / 39 | APPROVED |
| 05 / 22 | DECLINED |
| 04 / 27 | EXPIRED\_CARD |
| 08 / 28 | TIMED\_OUT |
| 01 / 37 | ACQUIRER\_SYSTEM\_ERROR |
| 02 / 37 | UNSPECIFIED\_FAILURE |
| 05 / 37 | UNKNOWN |
### CSC/CVV
| CSC/CVV Response Gateway Code | Status |
| ------------------------------ | -------------- |
| 100 | MATCH |
| 101 | NOT\_PROCESSED |
| 102 | NO\_MATCH |
| **For American Express Cards** | |
| 1000 | MATCH |
| 1010 | NOT\_PROCESSED |
| 1020 | NO\_MATCH |
# Download Plugins/SDK
{% hint style="info" %}
Please check out this page to download all Plugins/Apps/SDKs
{% endhint %}
# Direct Pay
# 1. Generate Merchant Keys
For direct pay integration merchant should have RSA public key. this endpoint to be used to generate the RSA key.
API Endpoints
{% tabs %}
{% tab title="Production Endpoint" %}
```
Production Base URL /api/GenToken/GenerateMerchantKey
```
{% endtab %}
{% tab title="Sandbox Endpoint" %}
```
SandboxBase URL /api/GenToken/GenrateMerchentKey
```
{% endtab %}
{% endtabs %}
#### **Sample Request & Response**
Use the below parameters to get merchant keys.
{% tabs %}
{% tab title="Sample Request" %}
```
{
"merchantCode":"xxxxx",
"authKey":"xxxxxxxxxx"
}
```
{% endtab %}
{% tab title="Sample Response" %}
```postman_json
{
"errorCode": 0,
"errorMessgae": "string",
"result": {
"publicKey": "string"
}
}
```
{% endtab %}
{% endtabs %}
MerchantCode and Auth key will be provided by Og.
#### Sample code to post data
{% tabs %}
{% tab title="C#" %}
```
public async Task> GenrateKeys(GenrateKeysRequest obj)
{
Output dto = new Output();
var url = {Provided End Point};
var client = new HttpClient();
client.BaseAddress = new Uri(url);
try
{
var resultser = JsonConvert.SerializeObject(obj);
client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json; charset=utf-8");
var response = client.PostAsJsonAsync(url, obj).Result;
if (response.IsSuccessStatusCode)
{
var ss = response.Content.ReadAsStringAsync();
var result = JsonConvert.DeserializeObject>(ss.Result);
dto = result;
}
else
{
var ss = response.Content.ReadAsStringAsync();
var resps = ss.Result.ToString();
}
}
catch (HttpRequestException ex)
{
}
return dto;
}
```
{% endtab %}
{% tab title="VB.NET" %}
```
Class SurroundingClass
Public Task As async
Private Sub New(ByVal obj As ValidatePaymentRequest)
Dim dto As Output = New Output()
Dim url = {Provided End Point};
Dim client = New HttpClient()
client.BaseAddress = New Uri(url)
Try
obj.hash = ComputeHash(obj)
Dim resultser = JsonConvert.SerializeObject(obj)
client.DefaultRequestHeaders.Accept.Add(New System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"))
client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json; charset=utf-8")
Dim response = client.PostAsJsonAsync(url, obj).Result
If response.IsSuccessStatusCode Then
Dim ss = response.Content.ReadAsStringAsync()
Dim result = JsonConvert.DeserializeObject > (ss.Result)
dto = result
Else
Dim ss = response.Content.ReadAsStringAsync()
Dim resps = ss.Result
Dim resultse = JsonConvert.SerializeObject(resps.ToString())
End If
Catch ex As HttpRequestException
End Try
Return dto
End Sub
End Class
```
{% endtab %}
{% tab title="PHP" %}
```
$merchantCode,
'authKey' => $authKey,
);
$request = json_encode( $data, true );
if ( !$endpoint ) {
$curl = curl_init( { Provided Url } );
} else {
$curl = curl_init( $endpoint );
}
curl_setopt( $curl, CURLOPT_POST, true );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $request );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_HTTPHEADER, array( 'Content-Type:application/json' ) );
$ch = curl_exec( $curl );
curl_close( $curl );
$response = json_decode( $ch, true );
?>
```
{% endtab %}
{% tab title="TypeScript" %}
```
pagecode:` public async Task> GenrateKeys(GenrateKeysRequest obj)
{
Output dto = new Output();
var url = {Provided End Point};
var client = new HttpClient();
client.BaseAddress = new Uri(url);
try
{
var resultser = JsonConvert.SerializeObject(obj);
client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json; charset=utf-8");
var response = client.PostAsJsonAsync(url, obj).Result;
if (response.IsSuccessStatusCode)
{
var ss = response.Content.ReadAsStringAsync();
var result = JsonConvert.DeserializeObject>(ss.Result);
dto = result;
}
else
{
var ss = response.Content.ReadAsStringAsync();
var resps = ss.Result;
var resultse = JsonConvert.SerializeObject(resps.ToString());
}
}
catch (HttpRequestException ex)
{
}
return dto;
}`;
```
{% endtab %}
{% endtabs %}
**Note:** Merchant keys are valid for 24 hours. Users must regenerate a new merchant key every 24 hours.
If the merchant uses an invalid RSA public key, subsequent calls will result in the following error.
{"ErrorMessage":"Unable to decrypt card data "}
# 2. Validate Request
### API Endpoints
{% tabs %}
{% tab title="Production Endpoint" %}
```
Production Base URL /api/GenToken/Validate
```
{% endtab %}
{% tab title="Sandbox Endpoint" %}
```
Sandbox Base URL /api/GenToken/Validate
```
{% endtab %}
{% endtabs %}
#### **Sample Request & Response**
Use the below parameters and hashing function for order creation. The request should contain the following inputs to make sure inputs should be encrypted using our hashing function show in the following example to prevent exposure. For parameters description please refer [here](/parameters-and-description)
{% tabs %}
{% tab title="Sample Request" %}
```
"ValidateRequest" : {
"merchantCode": "xxxxx"
"authKey": "xxxxxxxxx",
"currency": "KWD",
"pc": "DIRECTPAY",
"tunnel": "",
"amount": 1 ,
"doConvert": "N",
"sourceCurrency":"conditional",
"description": "optional",
"referenceID": "(15 digit random number)",
"timeStamp": "yyyy/MM/dd HH:mm:ss tt",
"language": "en",
"callbackURL": "Your website URL",
"hash": "ComputedHash",
"userReference": 0,
"billingDetails":
{
"fName": "First Name",
"lName": "last Name",
"mobile": "mobile",
"email": "email",
"city": "city",
"pincode": "pincode",
"state": "state",
"address1": "address1",
"address2": "address2"
}
}
```
{% endtab %}
{% tab title="Sample Response" %}
```
"errorCode": 0,
"errorMessgae": "string",
"result":
{
"redirectURL": "string",
"tokenID": "string",
"orderAmount": 0,
"paidAmount": 0,
"serviceAmount": 0,
"commissionAmount": 0,
"originalAmount": "string"
}
}
```
{% endtab %}
{% endtabs %}
Upon receiving the response, the merchant must verify the errorCode. If the errorCode is 0, the merchant should parse the result object and proceed to invoke the InitiatePay API, as detailed in the subsequent step.
# 3. Initiate Pay
After validating the merchant request, This API is used to process payment requests securely by encrypting card data using AES and RSA encryption.
#### API Endpoints
{% tabs %}
{% tab title="Production Endpoint" %}
```
Direct Pay Production Base URL /InitiatePay
```
{% endtab %}
{% tab title="Sandbox Endpoint" %}
```
Direct Pay Sandbox Base URL /InitiatePay
```
{% endtab %}
{% endtabs %}
#### **Sample Request & Response**
The request body should include the following fields:
{% tabs %}
{% tab title="Sample Request" %}
```
"Initiate pay request{
"ReferenceId" : "xxxxxxxxx",//15-digit reference id received in the validate requet response
"MerchantId": xxxxxx, //merchant code
"ECardData" = "encryptedCard", //card data encrypted using AES Encryption
"ECardKey" = "encryptedKey", // Encrypt the 32 digit AES key using the public key
"ACS_CallbackURL"= "call back url for 3DS"+ReferenceId //optional
}
};
```
{% endtab %}
{% tab title="Sample Response" %}
```
{
"errorCode": 0,
"errorMessgae": "SUCCESS",
"result": {
"authentication": {
"the3Ds1": null,
"the3Ds2": null,
"acceptVersions": null,
"channel": null,
"purpose": null,
"redirect": {
"customized": null,
"domainName": "ap.gateway.mastercard.com",
"html": "
"
},
"redirectHtml": null,
"version": "3DS2",
"the3Ds": null,
"method": "OUT_OF_BAND",
"payerInteraction": null
}
}
}
```
{% endtab %}
{% endtabs %}
| Field Name | Type | Description |
|---|
| ReferenceId | string | 15-digit reference id received in the validate requet response |
| MerchantId | string | Merchant code |
| ECardData | string | The encrypted card data encrypted using AES encryption with a 32-bit key. Explained below |
| ECardKey | string | The AES encryption key, encrypted using an RSA public key generated at here |
| ACS_CallbackURL | string | Explained here |
### Explanation of the `ECardData` Encryption Object
The `ECardData` field in the request is an encrypted representation of the sensitive card details. The following explains the object that is encrypted using AES encryption before being included in the API request:
```
{
"CardNumber": "xxxxxxxxxxxxxxxx",//16-digit card number
"CardName": "John Doe", //Name mentioned on card
"CardExpiry": "mm/yy", //month/year format
"CardCVV": "xxx" //3 decimal number
}
```
### ACS\_CallbackURL
* If empty, the 3D Secure callback will be handled by the provider, and the user will be redirected to call back url provided in the step 1. For more info about redirection refer [here](/sample-code/3.-callback-merchant-portal).
* If provided, the 3D Secure callback will be sent to the merchant's specified URL, and the merchant must call the API at [here](/direct-pay/4.-process-payment) for further processing.
### Response Explaination
Upon receiving the response from the InitiatePay API, the merchant must verify the errorCode to determine the next steps. If the errorCode is 0, indicating a successful initiation, the merchant should parse the result object and render the HTML content provided in ***result.redirect.html*** to proceed with the 3DS authentication process.
# 4. Process Payment
The ProcessPayment request is used to initiate a payment process for a given ReferenceId.
Upon completing the 3DS authentication process, the user is redirected to the endpoint specified in the Acs\_CallbackUrl parameter of the InitiatePay request. The merchant receives a response containing a form object at this endpoint. The merchant must verify that **form.result** equals "SUCCESS" and **form.response.gatewayRecommendation** equals "PROCEED" to determine whether to proceed with the payment process. If both conditions are satisfied, the merchant should call the ProcessPayment API with the specified parameters.
{% tabs %}
{% tab title="Production Endpoint" %}
```
Direct pay Production Base URL /ProcessPayment
```
{% endtab %}
{% tab title="Sandbox Endpoint" %}
```
Direct Pay SandboxBase URL /ProcessPayment
```
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Sample Request" %}
```
{
"ReferenceId": "xxxxxxxxxxxx", // 15-digit reference id used in the validate request
"MerchantId": "KW23821", // Merchant code
"Result": "success", // result received in the form.result object
"GatewayRecommendation": "PROCEED" // Gateway recommendation received in the form.result.gatewayrecommandation
}
```
{% endtab %}
{% tab title="Sample Response" %}
```
{
"errorCode": 0,
"errorMessgae": "SUCCESS",
"result": {
"error": null,
"gatewayEntryPoint": "WEB_SERVICES_API",
"merchant": "",
"order": {
"amount": 10,
"certainty": null,
"creationTime": "2025-04-23T10:27:26.416Z",
"currency": "USD",
"id": "543839849919125",
"status": "CAPTURED",
"totalAuthorizedAmount": 10,
"totalCapturedAmount": 10,
"totalRefundedAmount": 0,
"authenticationStatus": "AUTHENTICATION_SUCCESSFUL",
"lastUpdatedTime": "2025-04-23T10:27:41.733+00:00",
"merchantCategoryCode": "5399",
"valueTransfer": null
},
"response": {
"the3DSecure": null,
"acquirerCode": "00",
"acquirerMessage": "Approved",
"gatewayCode": "APPROVED",
"gatewayRecommendation": "NO_ACTION"
},
"result": "SUCCESS",
"sourceOfFunds": {
"provided": {
"card": {
"brand": "MASTERCARD",
"number": "512345xxxxxx0008",
"securityCode": null,
"expiry": {
"month": "1",
"year": "39"
}
}
},
"type": "CARD"
},
"timeOfRecord": "2025-04-23T13:27:41.529+03:00",
"transaction": {
"acquirer": {
"batch": 20250423,
"date": "0423",
"id": "NBK_S2I",
"merchantId": "900459840",
"settlementDate": "2025-04-23T00:00:00",
"timeZone": "+0300",
"tra": "..."
}
}
}
}
```
{% endtab %}
{% endtabs %}
Upon receiving the response from the ProcessPayment API, the merchant must verify the errorCode to determine the next steps. If the errorCode is 0, indicating a successful API call, the merchant should parse the result object and verify that result.result equals "SUCCESS" and result.response.acquirerMessage equals "APPROVED". These conditions confirm a successful payment transaction.
# WooCommerce
Integrating your WooCommerce store with Platform Payments services allows you to accept payments on your WooCommerce store with simple installation. You can accept payments via Debit & Credit Card, & ATM Cards. The plugin offers seamless integration, allowing the customer to pay on your website with a high secure PCI compliance hosted environment and work across all browsers and ensures compatibility with the below versions of WooCommerce
### **Compatibilities and Dependencies**
* WordPress v3.9.2 (or) higher
* WooCommerce v3.0 (or) higher
{% hint style="warning" %}
Note: The plugin has been tested up to WooCommerce v3.6.
{% endhint %}
### Installation
There are two methods to install the Platform Payments WooCommerce plugin
1. Install via WordPress plugin Installer
2. Install Plugins Manually through FTP
{% hint style="danger" %}
Caution: Always keep backup of your existing WooCommerce installation including Mysql Database, before installing a new module.
{% endhint %}
### Method 1: Install via WordPress plugin Installer
1. Log in to WordPress Admin panel
2. Go to Add a new plugin.
3. Click on the upload plugin.
4. Choose the downloaded zip "platformpayments.zip" (Download Plugin) and click Install Now.
.jpg?alt=media\&token=85341016-580c-4b49-b069-4054bbd8d2ae)
### Method 2: Install Plugins Manually through FTP
1\. Unzip and copy ‘PlatformPayments’ folder from downloaded platformpayments**.zip** file and upload to your`/wp-content/plugins` folder.
.jpg?alt=media\&token=fc30229a-0579-4de1-8aa0-547318a5af11)
### **Plugin Activation**
1. Login to WP admin.
2. Go to Plugin
3. Choose Platform Payments and Activate Plugin.
.jpg?alt=media\&token=6f1ad322-6dcd-475f-83fc-bddb51d3dcc4)
**Configure Keys:**
Step 1: Go to Plugin Setting
Step 2: Tick to enable the module and configure your keys & credentials.
.jpg?alt=media\&token=c35b1e7e-35c9-4d88-9558-b4fb39d0c17d)
### Support
If you have any questions that are beyond the scope of this help file, please feel free email us at
# Drupal Commerce
Integrating your Drupal Commerce store with Platform Payments services allows you to accept payments on your Drupal Commerce store with simple installation. You can accept payments via Debit & Credit Card, & ATM Cards. The plugin offers seamless integration, allowing the customer to pay on your website with a high secure PCI compliance hosted environment and work across all browsers and ensures compatibility with the below versions of Drupal.
### **Compatibilities and Dependencies**
* Drupal 8.9.x (or) higher
* Drupal Commerce v2.19 (or) higher
{% hint style="warning" %}
**Note:** Drupal 7 module works on only v7.5 to v.7.72 of Drupal 7.
{% endhint %}
### Installation
There are two methods to install the Platform Payments Payment Module
1. [Install via Drupal module installer](/plugins-setup-guide/drupal#1-installation-via-drupal-module-installer)
2. [Install via manually through FTP](/plugins-setup-guide/drupal#2-installation-via-manually-through-ftp-and-follow-the-process-from-above-step-2)
{% hint style="danger" %}
**Caution:** Always keep backup of your website including databases, before installing a new module.
{% endhint %}
### 1. Installation via Drupal module installer
**Step 1**: Go to Modules Section from Administration
1.1 Click on "Install new module"
1.2 Upload Platform Payments Module from the downloaded zip file.
.jpg?alt=media\&token=9b6384b0-c4ec-4b66-b098-e72c1f3a6de4)
**Step 2:** Go to **Site settings >> Modules** and switch on "**Commerce PlatformPayments**
.jpg?alt=media\&token=c14a272e-b4dc-49f4-80c6-2781bfd7c8e5)
**Step 2:** Go to **Store settings >> Payment methods >>** Enable **Platform Payments** Module
.jpg?alt=media\&token=6fa60dce-04ab-4bb8-88b8-b078528658de)
**Step 4:** Edit Platform Payments Module
**Step 5:** Configure Your Keys & Credentials
### 2. Installation via manually through FTP & Follow the process from above **Step 2**.
### Support
If you have any questions that are beyond the scope of this help doc, please feel free email us at
# OpenCart
Integrating your OpenCart store with Platform Payments services allows you to accept payments on your OpenCart store with simple installation. You can accept payments via Debit & Credit Card, & ATM Cards. The plugin offers seamless integration, allowing the customer to pay on your website with a high secure PCI compliance hosted environment and work across all browsers. and ensures compatibility with the below versions of OpenCart.
### **Compatibilities and Dependencies**
* Opencart 3.0.2.0 (or) higher
{% hint style="warning" %}
**Note:** This module works on only 3x versions of OpenCart.
{% endhint %}
### Installation
{% hint style="danger" %}
**Caution:** Always keep backup of your website including databases, before installing a new module.
{% endhint %}
**Step 1:** Go to Extensions > Extension Installer in admin panel and upload Platform Payments extension.
Make sure it should be installed successfully without any errors.
**Step 2:** Go to Extensions & Select Payment from the Extensions list, you will find the Platform Payments in the payment modules and click on Edit button.
**Step 3:** Enable Platform Payments from the status option.
**Step 4:** Configure Your Keys & Credentials.
{% hint style="danger" %}
Due to FTP permissions in OpenCart stores some versions may I.e., OpenCart v2.1x, v2.0x could not override the module files through the installer method in admin so please use manual installation via FTP upload in order to override files.
{% endhint %}
### Manual Installation method via FTP
### Support
If you have any questions that are beyond the scope of this help doc, please feel free email us at
# Magento 1
Integrating your Magento1 store with Platform Payments services allows you to accept payments on your Magento1 store with simple installation. You can accept payments via Debit & Credit Card, & ATM Cards. The plugin offers seamless integration, allowing the customer to pay on your website with a high secure PCI compliance hosted environment and work across all browsers and ensures compatibility with the below versions of Magento1.
### **Compatibilities and Dependencies**
* Compatibility with Open Source Community Edition: 1.9.x.
{% hint style="warning" %}
**Note:** This module works on only 1x versions of Magento.
{% endhint %}
### Installation Method 1
#### Installation through Admin Panel**:**
{% hint style="danger" %}
**Caution:** Always keep backup of your website including databases, before installing a new module.
{% endhint %}
1. Login to Admin Panel. Go to "**System >> Manage connect >> Magento Connect Manager**".
2. Re-login using your Admin login details.
3\. Go to **"Direct Package file upload"** section, click on **"Browse Button"**, Select the package received to you, and finally click on **"Upload"** button.
4\. Once package installed, click on **"Return to Admin"** link located on the top right second last link.
5\. Go to **System >> Cache Management**. Flush Magento Cache.
6\. Go to **System >> Configuration >> Sales >> Payment Method** enabled Platform Payments and configure Your Keys & Credentials and add payment methods.
### Installation **Method 2**
#### Manual Installation via FTP.
1. Extract the module zip archive.
2. Login to web server via FTP client and go to your magento directory.
3. Upload extracted file in `magento_root`
4. **Go to Stores >> Configuration >> Sales >> Payment Methods** enabled Platform Payments and Configure Your Keys & Credentials and add payment methods.
### Support
If you have any questions that are beyond the scope of this help doc, please feel free email us at
# Magento 2
Integrating your Magento2 store with Platform Payments services allows you to accept payments on your Magento2 store with simple installation. You can accept payments via Debit & Credit Card, & ATM Cards. The plugin offers seamless integration, allowing the customer to pay on your website with a high secure PCI compliance hosted environment and work across all browsers and ensures compatibility with the below versions of Magento2.
### **Compatibilities and Dependencies**
* Compatibility with Open Source Community Edition : 2.0.x, 2.1.x, 2.2.x, 2.3.x, 2.4.x.
{% hint style="warning" %}
**Note:** This module works on only 2x versions of Magento.
{% endhint %}
### Installation
{% hint style="danger" %}
**Caution:** Always keep backup of your website including databases, before installing a new module.
{% endhint %}
**Step 1:** Uploading files to the server
1. Extract the module zip archive.
2. Login to web server via FTP client and go to your magento directory.
3. Upload extracted file in `magento_root/app/code`
{% hint style="warning" %}
Note: If you have already a code folder in your magento directory you can skip the above point 3.
{% endhint %}
**Step 2:** Enable extension
1. Login to the server via ssh client
2. Go to magento root directory
3. Run the following commands:
{% tabs %}
{% tab title="Commands" %}
```
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy (If it does not work please try "php bin/magento setup:static-content:deploy -f")
php bin/magento cache:flush
```
{% endtab %}
{% tab title="Description" %}
```
To install the extension
To compile the code
To deploy static view files
To flush cache
```
{% endtab %}
{% endtabs %}
**Step 3:** Go to Stores >> Configuration >> Sales >> Payment Methods and enabled Platform Payments
**Step 4:** Configure Your Keys & Credentials and add payment methods.
{% hint style="warning" %}
Please note: In some cases require to flush cache at the store backend by Navigate to the **Admin Panel**> **System**> **Cache Management**:
{% endhint %}
### Support
If you have any questions that are beyond the scope of this help doc, please feel free email us at
# PrestaShop
Integrating your PrestaShop store with Platform Payments services allows you to accept payments on your PrestaShop store with simple installation. You can accept payments via Debit & Credit Card, & ATM Cards. The plugin offers seamless integration, allowing the customer to pay on your website with a high secure PCI compliance hosted environment and work across all browsers. and ensures compatibility with the below versions of PrestaShop.
### **Compatibilities and Dependencies**
* PrestaShop 1.6.1x and 1.7.0.x
### Installation
{% hint style="danger" %}
**Caution:** Always keep backup of your website including databases, before installing a new module.
{% endhint %}
**Step 1:** Go to Modules and Services > Add a new module
**Step 2:** Upload Platform Payments module
**Step 3:** Install Platform Payments Module
**Step 4**: Configure Your Keys & Credentials and add payment methods.
### Support
If you have any questions that are beyond the scope of this help doc, please feel free email us at
# Joomla
Integrating your Joomla VirtueMart store with Platform Payments services allows you to accept payments on your Joomla VirtueMart store with simple installation. You can accept payments via Debit & Credit Card, & ATM Cards. The plugin offers seamless integration, allowing the customer to pay on your website with a high secure PCI compliance hosted environment and work across all browsers and ensures compatibility with the below versions of Joomla VirtueMart.
### **Compatibilities and Dependencies**
* Joomla v3x with VirtueMart v3x
### Installation
{% hint style="danger" %}
**Caution:** Always keep backup of your website including databases, before installing a new module.
{% endhint %}
**Step 1**
1. Login to Joomla admin
2. Go to **Extension -> Manage -> Install**
3. Select **Upload Package File** section tab.
4. Upload Platform Payments plugin zip file
5. Make sure the plugin installed successfully without any errors.
**Step 2**
1. Go to **VirtueMart -> Payment Methods**
2. Create a **New** Payment Method
3. Fille **Payment Method** input fields and make sure it selected **PlatformPayments** in Payment Method & Save as shown in below the second screenshot.
**Step 3**
1. Go to **Configuration** tab section and fill your Keys & Credentials.
### Support
If you have any questions that are beyond the scope of this help doc, please feel free email us at
# WHMCS
Integrating your WHMCS store with Platform Payments services allows you to accept payments on your WHMCS store with simple installation. You can accept payments via Debit & Credit Card, & ATM Cards. The plugin offers seamless integration, allowing the customer to pay on your website with a high secure PCI compliance hosted environment and work across all browsers. and ensures compatibility with the below versions of WHMCS.
### **Compatibilities and Dependencies**
* WHMCS 7x
### Installation
{% hint style="danger" %}
**Caution:** Always keep backup of your website including databases, before installing a new module.
{% endhint %}
**Step 1:**
1. Extract the module zip archive.
2. Login to web server via FTP client and go to your WHMCS directory.
3. Upload extracted file
**Step 2**
1. Login to WHMCS admin
2. Go to **Setup -> Payments -> Payment Gateways -> All Payment gateways** and
3. Activate Platform Payments and Configure your Keys & Credentials.
**Step 3:**
1. Go to **Setup -> Addon Modules -> Platform Payments ->** Click on Activate and Configure to assign the permission of addon to user.
**Step 4:**
1. Go to **Setup -> Addon Modules -> Platform Payments ->** Configure Your Payment Methods.
### Support
If you have any questions that are beyond the scope of this help doc, please feel free email us at