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

Get Masterpass Remote Installment Selection Page context

Returns the available installment options for the Masterpass REST flow when a remote installment service is configured for the active POS. Installments are fetched from the external installment service using the card BIN and the current basket amount, then filtered by the active installment filter rules.

Preconditions:

  • Basket must not be empty

  • Payment option must be of Masterpass REST type

Page Context:

  • installments: List of installment options returned by the remote installment service. Each entry contains id, label, bin_number, installment_count, interest_rate, interest_amount, final_price_with_interest, monthly_price_with_interest, and is_active.

  • installment_messages: List of informational strings returned by the installment filter service.

Step Completion: This page is considered already completed when both of the following are true:

  • The remote installment selection has been saved, and

  • The selected payment option is of Masterpass REST type.

available_for_post_order: true

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

Masterpass remote installment selection page context retrieved

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

Masterpass remote installment selection page context retrieved

{
  "context_list": [
    {
      "page_name": "MasterpassRemoteInstallmentPage",
      "page_slug": "masterpassremoteinstallmentpage",
      "page_context": {
        "installments": [
          {
            "id": "remote-inst-001",
            "label": "Single Payment",
            "bin_number": 542119,
            "installment_count": 1,
            "interest_rate": "0.000",
            "interest_amount": "0.00",
            "final_price_with_interest": "159.99",
            "monthly_price_with_interest": "159.99",
            "is_active": true
          },
          {
            "id": "remote-inst-003",
            "label": "3 Installments",
            "bin_number": 542119,
            "installment_count": 3,
            "interest_rate": "0.035",
            "interest_amount": "5.60",
            "final_price_with_interest": "165.59",
            "monthly_price_with_interest": "55.20",
            "is_active": true
          }
        ],
        "installment_messages": []
      }
    }
  ],
  "pre_order": {
    "payment_option": {
      "pk": 7,
      "slug": "masterpass-rest",
      "payment_type": "masterpass_rest"
    },
    "card_info": {
      "bin_number": "542119",
      "card": {
        "pk": 1,
        "name": "Master"
      }
    }
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Last updated

Was this helpful?