Get Checkout Provider Index Page context

Entry point for the hosted checkout provider flow. This page appears when the basket is eligible for a checkout provider (e.g. Akifast). It has no visible context data; its purpose is to confirm that at least one checkout provider is available before the customer proceeds to select one.

Preconditions:

• At least one checkout provider must be available for the current pre-order

Skip Conditions:

• Page is skipped if checkout_provider_process_started is already true in the pre-order data

Page Context: (empty)

Previous Page: (none — independent start page)

Next Page: CheckoutProviderSelectionPage

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

Checkout Provider Index Page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=CheckoutProviderIndexPage

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

200

Checkout Provider Index Page context retrieved

{
  "context_list": [
    {
      "page_name": "CheckoutProviderIndexPage",
      "page_slug": "checkoutproviderindexpage",
      "page_context": {}
    }
  ],
  "pre_order": {
    "user_email": "[e-mail]",
    "basket": {
      "total_amount": "250.00"
    }
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}