Sessions

Create Session

Creates a new session unattached to a MerchantCustomer.

Sessions are used as a secure way for merchants to reference a specific browser session before presenting a LiftForward hosted credit application.

This feature is not supported for all programs.

post/sessions

Request

  • Base URL
    https://api.liftforward.com
  • Auth
    API key in header Api-Key

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": "as6hk7r7hnanqgahwmmg2wmqbgm",
    "status": "applying",
    "reservation_status": "waiting",
    "credit_application_url": "https://www.liftforward.com/en-us/program-abc/credit_application/q5eyes5vsmh6a4xezk5zpyct2nx",
    "merchant_customer_id": "mwyh3abhnbgf85xrc6b4c49k66e",
    "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"
          ]
        }
      ]
    },
    "approval": {
      "approval_token": "bd630ded-b714-4ba2-9759-424c3a643814",
      "expires_at": "2026-11-03T22:19:28Z",
      "status": "active",
      "credit_amount": 299.99,
      "currency": "USD",
      "order_id": "ctyqbrmryskz7gqfks4rqrr8hvr",
      "payment_method_id": "kcxwtawv9keka9sxrqmy7t4ta4j",
      "session_id": "0ff2b948-41d4-4c4d-9c88-980f5ae81c34",
      "cart_id": "2qfg2jtag54xmybtp3jqg2h595n",
      "offers": [
        {
          "offer_id": "trfhbdh7eza2687pbm6556ncd73",
          "credit_amount": 2500,
          "currency": "USD",
          "apr": 0.0999,
          "installment_count": 36
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.