{
"payment": {
"amount": "100", // required. Up to 2 decimals for UAE and KSA, e.g. 100.00
"currency": "AED", // required. Use the ISO 4217 standard for defining currencies
"description": "test payload",
"buyer": {
"name": "John Doe", // required. Customer's full name
"email": "[email protected]", //required. Customer's email address
"phone": "500000001", //required. Customer's phone number
"dob": "2000-01-20"
},
"shipping_address": {
"city": "Dubai", // required. Name of city, municipality, or village
"address": "Dubai", // required. Building name, apartment number
"zip": "1111" // required. Postal code
},
"order": {
"reference_id": "1001", // required. Merchant-assigned order number.
"updated_at": "2023-11-07T05:31:56Z",
"tax_amount": "0.00",
"shipping_amount": "0.00",
"discount_amount": "0.00",
"items": [
{
"reference_id": "SKU123",
"title": "Name of the product", // required. Name of the product.
"description": "Description of the product",
"quantity": 1, // required. Quantity of the product ordered. Should be >= 1
"unit_price": "0.00", // required. Price per unit of the product. Should be positive or zero.
"discount_amount": "0.00",
"image_url": "https://example.com/",
"product_url": "https://example.com/",
"gender": "Kids",
"category": "Clothes", // required. Name of high-level category (Clothes, Electronics,etc.)
"color": "white",
"product_material": "cotton",
"size_type": "EU",
"size": "M",
"brand": "Name of the Brand",
"is_refundable": true,
"barcode": "12345678",
"ppn": "MNXT2ZM/A",
"seller": "Name of the Seller"
}
]
},
"buyer_history": {
"registered_since": "2023-11-07T05:31:56Z", // required. Date and time the customer got registred with you
"loyalty_level": 0, // required. Customer's loyalty level within your store
"wishlist_count": 0,
"is_social_networks_connected": true,
"is_phone_number_verified": true,
"is_email_verified": true
},
"order_history": [
{
"purchased_at": "2023-11-07T05:31:56Z", // required. Date and time the order was placed
"amount": "100", // required. Up to 2 decimals for UAE and KSA, e.g. 100.00
"payment_method": "card",
"status": "new", // required. Status of the order
"buyer": {
"name": "John Doe", // required. Customer's full name
"email": "[email protected]", //required. Customer's email address
"phone": "500000001", //required. Customer's phone number
"dob": "2000-01-20"
},
"shipping_address": {
"city": "Dubai", // required. Name of city, municipality, or village
"address": "Dubai", // required. Building name, apartment number
"zip": "1111" // required. Postal code
},
"items": [
{
"reference_id": "SKU123",
"title": "Name of the product",
"description": "Description of the product",
"quantity": 1,
"unit_price": "0.00",
"discount_amount": "0.00",
"image_url": "https://example.com/",
"product_url": "https://example.com/",
"gender": "Kids",
"category": "Clothes",
"color": "white",
"product_material": "cotton",
"size_type": "EU",
"size": "M",
"brand": "Name of the Brand",
"is_refundable": true,
"barcode": "12345678",
"ppn": "MNXT2ZM/A",
"seller": "Name of the Seller"
}
]
}
],
"meta": {
"customer": "#customer-id",
"order_id": "#1234"
},
"attachment": {
"body": "{\"flight_reservation_details\": {\"pnr\": \"TR9088999\",\"itinerary\": [...],\"insurance\": [...],\"passengers\": [...],\"affiliate_name\": \"some affiliate\"}}",
"content_type": "application/vnd.tabby.v1+json"
}
},
"lang": "en", // required. Session language
"merchant_code": "code provided to you from Tabby side", // required. Merchant's branch code
"merchant_urls": {
"success": "https://your-store/success",
"cancel": "https://your-store/cancel",
"failure": "https://your-store/failure"
},
"token": null
}'
Checkout
Session creation payload model
The payload example for a session creation request with all required fields for a direct API custom integration can be found here: