For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Installment Selection Page context

Returns available installment options for the card. Displays installment options with interest rates and monthly payments.

Preconditions:

  • Card info must be entered (check_card_info_entered)

  • Basket must not be empty

Installment Calculation:

  • Installment options are retrieved from the card's installment configuration

  • Each installment includes:

    • Installment count (1, 3, 6, 9, 12, etc.)

    • Interest rate percentage

    • Total amount with interest

    • Monthly payment amount

  • Installment count of 1 means no installment (single payment)

Installment Filtering:

  • Installments are filtered through INSTALLMENT_FILTERS dynamic setting

  • Filters can restrict options based on:

    • Basket amount thresholds

    • User segmentation

    • Campaign eligibility

    • Currency requirements

  • Filter messages are returned to inform users of restrictions

Installment Messages:

  • Gateway-specific promotional messages

  • Installment availability notices

  • Special campaign information from payment gateway

get
Header parameters
x-requested-withstring · enumRequired

Required header for AJAX requests. Must be set to XMLHttpRequest for all checkout requests.

Default: XMLHttpRequestPossible values:
CookiestringOptional

Session cookie header (e.g. sessionid=abc123 or osessionid=<session_id>)

Responses
200

Installment selection page context retrieved

application/json
errorsone of · nullableOptional
or
string[]Optional
template_namestringOptional
get/orders/checkout/?page=InstallmentSelectionPage
GET /orders/checkout/?page=InstallmentSelectionPage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Accept: */*
200

Installment selection page context retrieved

{
  "context_list": [
    {
      "page_name": "InstallmentSelectionPage",
      "page_slug": "installmentselectionpage",
      "page_context": {
        "installments": [
          {
            "pk": 1,
            "installment_count": 1,
            "label": "Single Payment",
            "price_with_accrued_interest": "159.99",
            "monthly_price_with_accrued_interest": "159.99"
          },
          {
            "pk": 2,
            "installment_count": 3,
            "label": "3 Installments",
            "price_with_accrued_interest": "165.59",
            "monthly_price_with_accrued_interest": "55.20"
          },
          {
            "pk": 3,
            "installment_count": 6,
            "label": "6 Installments",
            "price_with_accrued_interest": "171.19",
            "monthly_price_with_accrued_interest": "28.53"
          },
          {
            "pk": 4,
            "installment_count": 9,
            "label": "9 Installments",
            "price_with_accrued_interest": "176.79",
            "monthly_price_with_accrued_interest": "19.64"
          }
        ],
        "card_type": {
          "pk": 1,
          "name": "Visa",
          "slug": "visa",
          "logo": "https://cdn.akinon.com/logos/visa.png"
        },
        "installment_messages": [
          "Special campaign: 0% interest on 3 installments",
          "Maximum installment for this card type: 9"
        ]
      }
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "shipping_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe"
    },
    "billing_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe"
    },
    "payment_option": {
      "pk": 1,
      "name": "Credit Card",
      "slug": "credit-card",
      "payment_type": "credit_card",
      "payment_type_label": "Credit Card"
    },
    "card_info": {
      "bin_number": "542119",
      "card": {
        "pk": 1,
        "name": "Visa"
      }
    },
    "installment": null,
    "total_amount": "159.99",
    "unpaid_amount": "159.99",
    "currency_type_label": "USD"
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Last updated

Was this helpful?