Initiate Order

Initiate Order

📘

in case you sent a duplicated order for your merchant which you have sent to us in a previous create order request you will get an error, check it in API response

Body Params
string
required
Defaults to M-900001

Add a your merchant order id unique order id ex. 900XXX

string
Defaults to en

Default is set to English if not passed, supported languages en for English or ar for Arabic

float
required
Defaults to 2

basket amount three decimals format.

float
required
Defaults to 2.5

Total amount to be charged to the customer, including the discounts & taxes & delivery fees three decimals format.

string
required
Defaults to KWD

The three-letter ISO currency code e.g KWD or SAR

float
required
Defaults to 0

if the there is discount applied on the order three decimals format.

float
required
Defaults to 0

you can pass it as "0" if the taxes are not applied in your country.

float
required
Defaults to 0.5

you can pass it as "0" if there are no delivery fees, otherwise pass it as 3 decimals

string
required
Defaults to home delivery

home delivery or pickup

float
Defaults to 0

if there is any other fees applied on the order (3 decimals) if not then no need to pass it

string
required
Defaults to https://yourmerchant.com/checkout/

Your merchant redirection URL will be used to redirect the user to your website along with the status of the order, "Confirmed" if the order is placed successfully, "Cancel" if the customer cancelled the order, "Rejected" if the payment got failed.

string
Defaults to https://yourmerchant.com/yourWebwebhookEndpoint/

Your webhook endpoint URL

string
Defaults to https://www.adidas.com/on/demandware.static/Sites-adidas-MLT-Site/-/default/dwe6fed0d0/images/adidas_logo.svg

URL of the sub-merchant logo (max 256 characters) logo dimension must be 250px x 250px

string
required
Defaults to Magento

for direct integration through our APIs then the platform will be website for the plugins send the plugin name e.g WooCommerce - Shopify - Magento ...etc (max 64 characters)

PSP
object

Conditional mandatory for PSP only (Data type: string): will be provided by the payment aggregator which saved in their database

customerDetails
object
deliveryAddress
object
orderItems
array of objects
required
orderItems*
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json