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

Remove an applied gift card reservation

Removes the reservation identified by card_number_hash. No gateway call is made. After removal, the previously selected payment method is reset so the payment step is re-evaluated with the updated totals.

Required Fields:

  • card_number_hash: The hash of the card number to remove (max 255 characters)

Note: If the hash does not match any existing reservation, the request succeeds silently — the result is an unchanged (or already-empty) list.

Next Pages:

  • GiftCardPage

post
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>)

Body
card_number_hashstring · max: 255Required

Hash of the gift card number that identifies the reservation to remove. Obtained from card_number_hash in the applied cards list returned by the Gift Card Page. If the hash does not match any reservation the request succeeds silently.

Example: abc123hash
Responses
200

Gift card reservation removed

application/json
errorsone of · nullableOptional
or
string[]Optional
template_namestringOptional
post/orders/checkout/?page=GiftCardRemovePage
POST /orders/checkout/?page=GiftCardRemovePage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 33

"card_number_hash='abc123hash'"
200

Gift card reservation removed

{
  "context_list": [
    {
      "page_name": "GiftCardPage",
      "page_slug": "giftcardpage",
      "page_context": {
        "providers": [
          {
            "slug": "provider-a",
            "name": "Provider A"
          }
        ],
        "applied_cards": []
      }
    }
  ],
  "pre_order": {
    "user_email": "user@akinon.com",
    "payment_option": null,
    "unpaid_amount": "250.00"
  },
  "errors": {},
  "template_name": "orders/checkout.html"
}

Last updated

Was this helpful?