# Parameters & Description

### Parameters

| Parameters Name      | Data Types | Required    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| -------------------- | ---------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`merchantCode`**   | `string`   | Yes         | <p>Provided by OCasheer</p><p><code>Ex: KW23281</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| **`authKey`**        | `string`   | Yes         | <p>Provided by Casheer</p><p><code>Ex: eaOZH3MnSslWexl</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| **`currency`**       | `string`   | Yes         | Refer "[Payment Channels](https://bhpaydocs.casheer.com/payment-methods)" Table.`( KWD, BHD, USD, EGP, SAR, GBP, EUR, etc.)`                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **`pc`**             | `string`   | Yes         | <p>a) For specific payment method, pass that particular payment method <a href="payment-methods">code</a>.</p><p><code>Ex: KWKNETDC for KNET</code></p><p>    <code>BHBENEFITDC for Benefit</code></p><p>    <code>EGUPGCC for Meeza</code></p><p>b) To show all payment methods use the code <code>"all".</code></p><p><code>Ex: all</code></p><p>c) For specific country payment methods, use the code <code>"currency"</code> </p><p>and the pass desired country's standard three letter currency code in <strong>currency parameter.</strong></p><p><code>Ex: currency</code></p><p></p> |
| **`tunnel`**         | `string`   | Optional    | Provided by Casheer  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 | <p>When the amount needs to be converted the other currency, then pass standard three letter currency code. <code>( KWD, BHD, USD, EGP, SAR, GBP, EUR, etc.)</code> </p><p><code>Ex: If Amount to be converted from USD to KWD, then doConvert=Y and sourceCurrency=USD</code></p>                                                                                                                                                                                                                                                                                                            |
| **`description`**    | `string`   | Optional    | Your product/item name or description.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| **`referenceID`**    | `long`     | Yes         | <p>Must be 15 digits unique number. </p><p><code>Ex: 123456789012345</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| **`timeStamp`**      | `string`   | Yes         | <p>Current Date & Time when the payment's URL generating. </p><p><code>Ex: 202101241619123</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| **`language`**       | `string`   | Optional    | English (en) / Arabic (ar)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| **`callbackURL`**    | `string`   | Yes         | <p>Once the transaction is completed, the customer will be redirected to the given response URL. </p><p><code>Ex: <https://yourdomain.com/Calback></code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| **`userreference`**  | long       | Conditional | <p>Your customer's mobile number or any unique number (minimum 8 digits and maximum 15 digits) for <strong>Quick Pay</strong> service. </p><p>Example: KFAST for KNET</p><p>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. </p><p>Note: <strong>Quick Pay</strong> service should be enabled for the merchant by Casheer, in order to use this service. </p><p><code>Ex: 12345678</code></p>                                              |
| **`hash`**           | `string`   | Yes         | <p>Please refer <a href="sample-code/4.-compute-hash">here</a>. </p><p><code>Ex: B400HJKHKJ00000JKHJKHKJJK032321JKHFJKHF</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| **`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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |

###

|   |
| - |
