Get Gift Card Apply Page context

Returns the card's masked number, available balance, and the maximum amount that can be applied given the current unpaid total and the global per-order cap. Reached after a successful balance check (no OTP) or after OTP verification.

Preconditions:

• A pending gift card must be fully verified: balance is known and OTP has been confirmed if the gateway required it

Skip Conditions:

• Page is skipped if the current candidate has already been consumed (converted to a reservation) and at least one reservation exists

Configuration:

• GIFT_CARD_CONFIG.max_amount_per_order: Sets the global cap on cumulative gift card amounts. The max_applicable_amount returned in the context already reflects this cap and the remaining unpaid total.

Next Pages (after POST):

• EmptyPage — the sub-flow is complete; the checkout state determines the next main-flow page

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 Apply Page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=GiftCardApplyPage

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

200

Gift Card Apply Page context retrieved

{
  "context_list": [
    {
      "page_name": "GiftCardApplyPage",
      "page_slug": "giftcardapplypage",
      "page_context": {
        "card_number_masked": "****-****-****-3456",
        "available_balance": "100.00",
        "max_applicable_amount": "100.00"
      }
    }
  ],
  "pre_order": {
    "user_email": "[e-mail]",
    "total_amount": "250.00",
    "unpaid_amount": "250.00"
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}