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

Get Redirection Payment Completion Page context

Returns the payment gateway redirect URL and iframe display settings for completing a redirection-based payment flow.

This page is reached after the payment provider has accepted the transaction initiation (RedirectionPaymentSelectedPage). It provides the URL of the provider's hosted payment page where the customer authorises the transaction, along with a flag that controls whether that page is rendered inline or as a full redirect.

Preconditions:

  • A redirection-based payment option (payment_type: redirection) must be selected on the pre-order

  • The redirect flow must have been started (the payment provider accepted the transaction start and issued a redirect URL)

  • The pre-order must have an assigned order number

Page Context:

  • redirect_url — The full URL of the payment provider's hosted payment page

  • is_iframe — Whether the provider's page should be embedded in an inline frame rather than navigating away from the checkout

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

Redirection payment completion page context retrieved

application/json
errorsone of · nullableOptional
or
string[]Optional
template_namestringOptional
get/orders/checkout/?page=RedirectionPageCompletePage
GET /orders/checkout/?page=RedirectionPageCompletePage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Accept: */*
{
  "context_list": [
    {
      "page_name": "RedirectionPageCompletePage",
      "page_slug": "redirectionpagecompletepage",
      "page_context": {
        "redirect_url": "https://payment.provider.com/pay?token=abc123",
        "is_iframe": true
      }
    }
  ],
  "pre_order": {
    "number": "ORD-20240101-00001",
    "payment_option": {
      "pk": 5,
      "name": "Online Payment",
      "slug": "online-payment",
      "payment_type": "redirection"
    },
    "total_amount": "150.00",
    "is_guest": false,
    "is_post_order": false
  },
  "errors": null,
  "template_name": ""
}

Last updated

Was this helpful?