Marketplace

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	Number
		currency	String
risk_assessment			Object	Required	Risk assessment information from the merchant side
	is_premium_customer		Boolean	Required	Any subscription package/ VIP segmentation of customers (if available)
	account_creation_date		String	Required	Date when the customer registered their account at merchant (format: dd-mm-yyyy)
	total_order_count		Integer	Required	No. of successful orders of customer on merchant. The cumulative number of successfully completed orders by the customer on marketplace merchants
	risk_score		Integer	Required	Aggregated transaction/ customer risk score by merchant (if available) - aggregated transaction risk score generated by marketplace merchants's internal risk engine
sub_merchant_id			String	Required	The unique id of the sub-merchant
sub_merchant_category			String	Required	The business category of the sub-merchant
sub_merchant_name			String	Required	The name of the sub-merchant
sub_merchant_tier			String	Required	The segregated risk tier of the sub-merchant
sub_merchant_joining_date			String	Required	The date when the sub-merchant/supplier registered and became active on the marketplace merchant's platform
consumer			Object	Required	The customer's identifying details
	email		String	Optional	The email address associated with the customer's marketplace merchants account. Limited to 128 characters.
	phone_number		String	Required	The phone number associated with the customer's marketplace merchants account. 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	Required	The type of the product e.g., physical, digital, etc.
	name		String	Required	The name of the product. Limited to 255 characters.
	sku		String	Required	The SKU of the product from the merchant side. Limited to 128 characters.
	quantity		Integer	Required	The number of units of the product
	item_url		URL	Optional
	image_url		URL	Optional
	unit_price		Object	Optional
		amount	Number
		currency	String
	tax_amount		Object	Optional
		amount	Number
		currency	String
	discount_amount		Object	Optional
		amount	Number
		currency	String
	total_amount		Object	Required	The total amount of the product
		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	Required	Optional, if not available for digital services
	city		String	Required
	country_code		String	Required
	first_name		String	Required
	last_name		String	Required
	line1		String	Required
	line2		String	Required
	phone_number		String	Required
	region		String	Required
locale			String	Required	Recommended to be passed for optimum customer experience
platform			String	Required	The platform where the Tamara order is being initiated from, for 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	Optional	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,
        "sub_merchant_id": 61817,
        "sub_merchant_category": "Professional Services",
        "sub_merchant_name": "DUMMY LLC",
        "sub_merchant_tier": "p1",
        "sub_merchant_joining_date": "2025-03-19"
    },
    "consumer": {
        "phone_number": "502223333",
        "first_name": "Mona",
        "last_name": "Lisa",
        "email": "[email protected]"
    },
    "items": [
        {
            "total_amount": {
                "amount": 41.65,
                "currency": "SAR"
            },
            "reference_id": "123456",
            "type": "Digital",
            "name": "Lego City 8601",
            "sku": "SA-12436",
            "quantity": 1,
            "tax_amount": {
                "amount": 7.35,
                "currency": "SAR"
            }
        }
    ],
    "country_code": "SA",
    "description": "Test Order",
    "merchant_url": {
        "cancel": "http://example.com/#/cancel",
        "failure": "http://example.com/#/fail",
        "success": "http://example.com/#/success"
    },
    "shipping_address": {
        "country_code": "SA",
        "first_name": "Mona",
        "last_name": "Lisa",
        "line1": "3764 Al Urubah Rd",
        "line2": "string",
        "region": "As Sulimaniyah",
        "postal_code": "12345",
        "city": "Riyadh",
        "phone_number": "502223333"
    },
    "locale": "ar_SA",
    "platform": "platform name here",
    "is_mobile": false
}