Parameters & Description

Parameters

Parameters Name

Data Types

Required

Description

merchantCode

string

Yes

Provided by Og Checkout

Ex: KW23281

authKey

string

Yes

Provided by Og Checkout

Ex: eaOZH3MnSslWexl

currency

string

Yes

Refer "Payment Channels" 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: https://yourdomain.com/Calback

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.