Educational Institutions

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
	is_premium_customer		Boolean	Required	Any subscription package/ VIP segmentation of customers
	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 with this institution
	risk_score		Integer	Optional	Aggregated transaction/ customer risk score by merchant(if available)
	date_first_paid		String	Required	*Date of first successful order. Will be null* if first order (format: dd-mm-yyyy)**
	date_last_paid		String	Required	*Date of last successful order. Will be null* if first order (format: dd-mm-yyyy)**
	order_count_last_24h		Integer	Optional	No. of successful orders of customer on merchant, in the last 24 hours
	account_security		Object	Optional	Security and identity signals.
		is_email_verified	Boolean	Optional	true if email is verified by merchant.
		is_phone_verified	Boolean	Optional	true if email is verified by merchant.
		password_last_changed	String	Optional	Date of last password reset (format: dd-mm-yyyy).
		last_login_date	String	Optional	Date of last login (format: dd-mm-yyyy).
		last_verification_method	String	Optional	Method used for last authentication, for e.g., OTP, Biometric, etc..
		device_id	String	Optional	Unique device fingerprint/ID from merchant. Any Hash (#) device ID
		devices_linked	Integer	Optional	Number of active devices linked to the account.
	education		Object	Required
		education_type	String	Required	Type of educational service or course, for e.g., course, workshop, tutoring.
		start_date	String	Required	The start date of the service or course. (format: dd-mm-yyyy).
		end_date	String	Required	The end date of the service or course. (format: dd-mm-yyyy).
		event_location	String	Required	Whether the service/course is online or offline.
		purchase_type	String	Required	Whether it is a subscription-based or one-time purchase.
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	Comprehensive details about the items in the order
	reference_id		String	Required	The unique id of the product from the merchant side
	type		String	Optional	The type of the product e.g., tuition fees, registration fees, extracurricular fees, etc.
	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.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	Optional
	image_url		Url	Optional
	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	The two-character ISO 3166-1 country code
description			String	Required	Brief details about the order
merchant_url			Object	Required	This object includes all the redirect URLs that the customer will be redirected to from the Tamara checkout page in different cases.
	cancel		Url	Required	When the user manually cancels the checkout session
	failure		Url	Required	When the checkout session fails due to a network error or the user is declined
	success		Url	Required	When the checkout session is successful
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": {
        "is_premium_customer": true,
        "account_creation_date": "31-01-2019",
        "total_order_count": 12,
        "risk_score": 5,
        "date_first_paid": "31-01-2019",
        "date_last_paid": "31-01-2026",
        "order_count_last_24h": 0,
        "account_security": {
            "is_email_verified": true,
            "is_phone_verified": true,
            "password_last_changed": "31-01-2026",
            "last_login_date": "31-01-2026",
            "last_verification_method": "OTP",
            "device_id": "#123",
            "devices_linked": "2"
        },
            "education": {
                "education_type": "School fees",
                "start_date": "01-03-2026",
                "end_date": "01-04-2027",
                "event_location": "Offline",
                "purchase_type": "Subscription"
            }
        },
        "consumer": {
            "phone_number": "502223333",
            "first_name": "Mona",
            "last_name": "Lisa",
            "email": "[email protected]"
        },
        "items": [
            {
                "sku": "1234-677879",
                "name": "Fees_3_months",
                "type": "Tuition_fees",
                "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
    }