Educational Services

List of Parameters

Field			Data Type	Required	Description
total_amount			Object	Required	Total amount to be charged to customer, not including any discount amount(item amount + tax amount + shipping amount - discount amount)
	amount		Number	Required	The exact format depends on the currency. By default we support 2 decimals, for BHD and KWD we support 3 decimals
	currency		String	Required	The three-letter ISO currency code e.g SAR
shipping_amount			Object	Required
	amount		Number	Required
	currency		String	Required
tax_amount			Object	Required
	amount		Number	Required
	currency		String	Required
order_reference_id			String	Required	The unique order id from the merchant side, this will be used with the settlement and reports
order_number			String	Optional	The order number from the merchant side, this will be used for communication with the customer. If not passed, it will take the order_reference_id value
discount			Object	Optional	Required only if you allow your customers to use a promo/coupon code on your checkout page
	name		String
	amount		Object
		amount
		currency
risk_assessment			Object	Required	Risk assessment information from the merchant side
	account_creation_date		Date	Required	Student registration date (date when the student first enrolled at the institution)
	total_order_count		Integer	Required	No. of successful payment orders of student for this service
	is_premium_customer		Boolean	Required	Any subscription package/ VIP segmentation of customers (optional if not part of the customer journey)
consumer			Object	Required	The customer's identifying details.
	email		String	Required	Limited to 128 characters.
	phone_number		String	Required	Limited to 32 characters.
	first_name		String	Required
	last_name		String	Required
items			Array of Objects	Required	Item-specific details from the order
	reference_id		String	Required	The unique id of the product from the merchant side
	type		String	Required	The type of the product e.g., subscription, 1 time fee, etc. alongside digital or onsite course details. Possible values: One Time - Digital One Time - On site Subscription - Digital Subscription - On site
	name		String	Required	The name of the service, i.e., Fees duration of the term for which the fees is being charged, e.g., 3 months, 6 months, 9 months, one-time, etc.Name mandatory, Duration optional.Limited to 255 characters.
	sku		String	Required	If applicable, otherwise hardcoded value can be passed. Limited to 128 characters.
	quantity		Integer	Required	Should be set to 1
	item_url		Url
	image_url		Url
	unit_price		Object	Required
	tax_amount		Object	Required
		amount	Number	Required
		currency	String	Required
	discount_amount		Object	Required
		amount	Number	Required
		currency	String	Required
	total_amount		Object	Required
		amount	Number	Required
		currency	String	Required
country_code			String	Required
description			String	Required
merchant_url			Object	Required
	cancel		Url	Required
	failure		Url	Required
	success		Url	Required
billing_address			Object	Required (if available)
	city		String
	country_code		String
	first_name		String
	last_name		String
	line1		String
	line2		String
	phone_number		String
	region		String
shipping_address			Object	Optional
	city		String
	country_code		String
	first_name		String
	last_name		String
	line1		String
	line2		String
	phone_number		String
	region		String
locale			String	Required	(Recommended to be passed for optimum customer experience)
platform			String	Required	The platform where the Tamara order is being initiated from e.g., web, mobile, etc.
is_mobile			Boolean	Required	Whether the order is being initiated from a mobile device or not
payment_type			String	Required only if single checkout is disabled
instalments			Integer	Required only if single checkout is disabled
expire_in_minutes			Integer	Required only if custom	Order expiry time in minutes
additional_data			Object		Any additional order data information from the merchant side

Request Payload Sample

{
   "total_amount": {
       "amount": 50.00,
       "currency": "SAR"
   },
   "shipping_amount": {
       "amount": 1,
       "currency": "SAR"
   },
   "tax_amount": {
       "amount": 7.35,
       "currency": "SAR"
   },
   "order_reference_id": "abd12331-a123-1234-4567-473fkid5",
   "risk_assessment": {
       "account_creation_date": "31-01-2019",
       "is_premium_customer": false,
       "total_order_count": 2
   },
   "consumer": {
       "phone_number": "502223333",
       "first_name": "Mona",
       "last_name": "Lisa",
       "email": "[email protected]"
   },
   "items": [
       {
           "sku": "1234-677879",
           "name": "Python_course_3_months",
           "type": "Subscription - Digital",
           "item_url": "",
           "quantity": 1,
           "image_url": "",
           "tax_amount": {
               "amount": 0.0,
               "currency": "AED"
           },
           "unit_price": {
               "amount": 0.0,
               "currency": "AED"
           },
           "reference_id": "3198",
           "total_amount": {
               "amount": 4720.49,
               "currency": "AED"
           },
           "discount_amount": {
               "amount": 0.0,
               "currency": "AED"
           }
       }
   ],
   "country_code": "SA",
   "description": "Test Order",
   "merchant_url": {
       "cancel": "http://example.com/#/cancel",
       "failure": "http://example.com/#/fail",
       "success": "http://example.com/#/success"
   },
   "locale": "ar_SA",
   "platform": "platform name here",
   "is_mobile": false
}