Merchant Customer Sessions
Create MerchantCustomer Session
Creates a new MerchantCustomer Session for the provided merchant_customer_id.
MerchantCustomer Sessions are used as a secure way for merchants to pass customer details to LiftForward before redirecting the customer to a LiftForward hosted credit application.
This feature is not supported for all programs.
post/merchant_customers/{merchant_customer_id}/session
Request
- Base URLhttps://api.liftforward.com
- AuthAPI key in header Api-Key
Path parameters
merchant_customer_idstring required
Request body
Example request
{
"session": {
"program_code": "program-abc",
"merchant_approval_url": "https://www.merchant.com/approved",
"merchant_decline_url": "https://www.merchant.com/declined",
"merchant_cancel_url": "https://www.merchant.com/canceled",
"merchant_pending_url": "https://www.merchant.com/pending",
"language": "en",
"payment": {
"processor": "2c2p",
"token": "8429234238.1"
},
"simulate_outcome": "checkout",
"customer": {
"personal_details": {
"first_name": "Elliot",
"middle_name": "Lee",
"last_name": "Alderson",
"email": "elliot.alderson@gmail.com",
"mobile_phone_number": "8403240590",
"home_phone_number": "8403240590",
"date_of_birth": "1986-09-17",
"tax_id": "840324059",
"annual_income": 130000
},
"billing_address": {
"address_line_1": "123 Main St",
"address_line_2": "Apt 4B",
"city": "New York",
"state_code": "NY",
"postal_code": "10001",
"country_code": "US"
}
},
"order": {
"currency": "USD",
"plan_code": "plan-123",
"merchant_order_id": "8429234238273948723947",
"shipping_fee": 15.99,
"merchant": {
"source_channel_id": "ONLINE_SHIP_TO_HOME",
"store_id": "store-123",
"employee_id": "emp-456",
"tender_type": "credit_card",
"merchant_metadata": {
"custom_key_1": "custom_value_1",
"custom_key_2": "custom_value_2"
}
},
"shipping_address": {
"first_name": "Elliot",
"last_name": "Alderson",
"address_line_1": "217 East Broadway",
"address_line_2": "Apt. 4E",
"city": "New York",
"state_code": "NY",
"postal_code": "10002",
"country_code": "US"
},
"merchant_items": [
{
"sku": "SKU-001",
"description": "Laptop 15-inch display, 16GB RAM",
"image_url": "https://www.merchant.com/images/laptop.png",
"unit_sale_price": 999.99,
"unit_retail_price": 1199.99,
"quantity": 1,
"merchant_order_item_id": "order_item_123",
"parent_merchant_order_item_id": "order_item_100",
"unit_total_price": 1049.99,
"shipping_fee": 5.99,
"subscription_plan_id": "plan-abc-24",
"service_term_length": 24,
"sales_tax_rates": [
{
"rate": 0.08,
"amount": 8
}
]
}
]
}
}
}Response
success
Example response
{
"session": {
"session_id": "7x8mz4bhx2vgkxngshcdxpxx9pa",
"status": "applying",
"reservation_status": "waiting",
"credit_application_url": "https://www.liftforward.com/en-us/program-abc/credit_application/npsbqvc6wk9ksnzctrnmn83rk6r",
"account_url": "https://www.liftforward.com/en-us/program-abc/account?accesToken=qyq6pm4dq7hq2j8dwa43hh6w68e",
"cart_url": "https://www.liftforward.com/en-us/program-abc/cart?accesToken=c6jyfads2vjwfxd372hhxsgskeb",
"cart_id": "e2y3wt9tbkg4x8t3sbfy2kac7qq",
"merchant_customer_id": "gjpxwyfb4yqwvvehraqbrcwcyxr",
"program_code": "program-abc",
"language": "en",
"merchant_approval_url": "https://www.merchant.com/approved",
"merchant_decline_url": "https://www.merchant.com/declined",
"merchant_cancel_url": "https://www.merchant.com/canceled",
"merchant_pending_url": "https://www.merchant.com/pending",
"order": {
"merchant": {
"source_channel_id": "ONLINE_SHIP_TO_HOME",
"store_id": "3028478594",
"employee_id": "39383473893939",
"merchant_metadata": {
"custom_key_1": "custom_value_1",
"custom_key_2": "custom_value_2"
}
},
"merchant_order_id": "8429234238273948723947",
"plan_code": "program-abc-24",
"currency": "USD",
"shipping_fee": 15.99,
"shipping_address": {
"address_line_1": "217 East Broadway",
"address_line_2": "Apt. 4E",
"city": "New York",
"state_code": "NY",
"postal_code": "10002",
"country_code": "US",
"first_name": "Elliot",
"last_name": "Alderson"
},
"merchant_items": [
{
"sku": "30-X9383-94",
"description": "Product 123",
"merchant_order_item_id": "order_item_123",
"quantity": 1,
"unit_retail_price": 299.99,
"unit_sale_price": 299.99,
"unit_balloon_payment": 50,
"unit_total_price": 356.63,
"shipping_fee": 25.39,
"sales_tax": 26.25,
"sales_tax_rates": [
{
"sales_tax_rate_code": "VAT",
"rate": 0.0875,
"amount": 26.25
}
],
"misc_fees": 5,
"apr": 0.0999,
"installment_count": 36,
"unit_installment_payment": 9.91,
"unit_total_interest": 50,
"parent_merchant_order_item_id": "order_item_123",
"image_url": "https://placekitten.com/500/500",
"description_list": [
"Product has feature 1",
"Product has feature 2"
]
}
]
}
}
}Changes
No recorded changes to this operation across all 8 revisions of this API.