Get Gift Card Page context

Returns the list of active gift card providers and the currently applied gift card reservations. This is the entry point of the gift card sub-flow and is an independent step — submitting it does not reset other checkout steps.

Preconditions:

• None beyond the standard basket and session checks

Skip Conditions:

• None — this page is never auto-skipped; it is reached on demand

Configuration:

• GIFT_CARD_CONFIG.multi_card_enabled: Controls whether a second card may be added while one is already applied.

Next Pages (determined after POST, not GET):

• GiftCardOtpPage — when the gateway requires OTP verification for the card

• GiftCardApplyPage — when the gateway does not require OTP

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

Gift Card Page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=GiftCardPage

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

200

Gift Card Page context retrieved

{
  "context_list": [
    {
      "page_name": "GiftCardPage",
      "page_slug": "giftcardpage",
      "page_context": {
        "providers": [
          {
            "slug": "provider-a",
            "name": "Provider A"
          }
        ],
        "applied_cards": []
      }
    }
  ],
  "pre_order": {
    "user_email": "[e-mail]",
    "total_amount": "250.00",
    "unpaid_amount": "250.00"
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}