Get Loyalty Money Page context

Returns the context for the Loyalty Money Page, which presents a terms and conditions agreement to the user before finalizing a loyalty money payment. This page is reached when the loyalty money payment option has been selected and the loyalty balance fully covers the order total (no unpaid amount remains).

Preconditions:

• The selected payment option must be of loyalty money type

• The LOYALTY_MONEY_ENABLED dynamic setting must be true

• The loyalty money balance must cover the full order amount (unpaid amount must be zero)

Skip Conditions:

• Page is skipped if the loyalty money payment option is selected and the order has already been finalized

Configuration:

• LOYALTY_MONEY_ENABLED: Controls whether the loyalty money payment method is available during checkout. Defaults to false.

available_for_post_order: true

Next Pages (determined dynamically):

• ThankYouPage — after the order is placed

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

Loyalty Money Page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=LoyaltyMoneyPage

GET /orders/checkout/?page=LoyaltyMoneyPage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Accept: */*

200

Loyalty Money Page context retrieved

{
  "context_list": [
    {
      "page_name": "LoyaltyMoneyPage",
      "page_slug": "loyaltymoneypage",
      "page_context": {}
    }
  ],
  "pre_order": {
    "user_email": "[e-mail]",
    "payment_option": {
      "pk": 7,
      "name": "Loyalty Money",
      "slug": "loyalty-money",
      "payment_type": "loyalty_money",
      "payment_type_label": "Loyalty Money"
    },
    "total_amount": "150.00",
    "unpaid_amount": "0.00"
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}