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

Get Wallet Payment Page context

Returns any supplementary payment context required by the wallet gateway after the agreement step. For Apple Pay this includes the session context_data from the gateway; for all other wallet methods the context is an empty object.

Preconditions:

  • Basket must not be empty.

  • The selected payment option must be of wallet type.

  • Agreement must have been confirmed (agreement_confirmed in session).

Page Context:

  • Apple Pay (WalletPaymentPageContext): context_data — gateway session data required by the browser Payment Sheet.

  • All other wallet providers: empty object {}.

Step Completion: This page is considered already completed when payment_started is stored in the checkout session.

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

Wallet payment page context retrieved

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

Wallet payment page context retrieved

{
  "context_list": [
    {
      "page_name": "WalletPaymentPage",
      "page_slug": "walletpaymentpage",
      "page_context": {
        "context_data": {
          "merchantSession": "eyJhbGciOiJSUzI1NiJ9..."
        }
      }
    }
  ],
  "errors": [],
  "template_name": "orders/checkout.html"
}

Last updated

Was this helpful?