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

Finalise wallet payment order

Finalises the wallet payment. For the checkout_flow gateway, the oid parameter (Checkout.com payment ID) must be supplied and success must be true. For all other gateways no input is required.

Required Fields (checkout.com gateway only):

  • success: Must be true.

  • oid: Checkout.com payment identifier.

  • cko_payment_id (optional): Checkout.com payment reference.

Next Page:

  • ThankYouPage

available_for_post_order: true

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

Input for WalletCompletePage. Required only when the active payment gateway is checkout_flow (Checkout.com); for all other wallet gateways the page accepts an empty submission.

successboolean · enumOptional

Must be true for checkout.com gateway. Indicates the payment was authorised on the provider side.

Possible values:
oidstring · max: 64Optional

Checkout.com payment identifier. Required for the checkout_flow gateway.

Example: pay_abc123def456
cko_payment_idstringOptional

Optional Checkout.com payment reference returned by the provider.

Example: pay_abc123def456
Responses
200

Wallet order finalised — routes to ThankYouPage

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

"success=true&oid='pay_abc123def456'"
200

Wallet order finalised — routes to ThankYouPage

{
  "context_list": [
    {
      "page_name": "ThankYouPage",
      "page_slug": "thankyoupage",
      "page_context": {
        "redirect_url": "/orders/checkout/success/abc123/",
        "order_id": 456,
        "order_number": "ORD-456",
        "new_user": false,
        "token": null,
        "campaigns": []
      }
    }
  ],
  "errors": [],
  "template_name": "orders/checkout.html"
}

Last updated

Was this helpful?