Payment Method Selection

Checkout Payment Method Selection

Present available payment methods to the customer and route them into the appropriate payment flow. This section also covers the entry points for cash on delivery, bank transfer (funds transfer), pay later, and external checkout provider shipping confirmation.

Request Format

Include the following header in all checkout requests:

• x-requested-with: XMLHttpRequest

Authentication

A valid session cookie is required. The checkout URL token mechanism is also supported for external redirect flows.

Dynamic Settings

CHECKOUT_WITH_TOKEN_ALLOW_ANONYMOUS

Controls whether anonymous users may access checkout via token-based URLs. When disabled, only authenticated users can use token checkout links.

Get Payment Option Selection Page context

get

Returns available payment options for the order. Payment options are filtered based on configured rules and user context.

Preconditions:

• Shipping option must be selected (check_shipping_option_selected)

• Basket must not be empty

Payment Option Availability:

• Each payment option has associated rules that determine availability

• Rules can check basket contents, user status, order amount, and more

• Unavailable options are returned separately with error codes and messages

Checkout URLs:

• checkout_url: URL for checkout with token (used for external payment flows)

• status_url: URL to check checkout status (used for polling payment status)

• Generated by CheckoutWithTokenService

Payment Types: Payment options can have different types that determine the next page flow:

• credit_card: Routes to BinNumberPage

• funds_transfer: Routes to FundsTransferChoicePage

• bkm_express: Routes to BexSelectionPage

• loyalty_money: Routes to LoyaltyMoneyPage

• cash_register: Routes to CashRegisterPage

• gpay: Routes to GPaySelectionPage

• redirection: Routes to RedirectionPaymentSelectedPage

• stored_card: Routes to MobilExpressSelectionPage

• masterpass: Routes to MasterpassBinNumberPage

• masterpass_rest: Routes to MasterpassRestBinNumberPage

• credit_payment: Routes to CreditPaymentSelectionPage

• pay_later: Routes to PayLaterCompletePage

• saved_card: Routes to SavedCardSelectionPage

• confirmation: Routes to ConfirmationPaymentAgreementCheckPage

• b2b: Routes to B2BPage

• wallet: Routes to WalletSelectionPage

• pay_on_delivery: Routes to PayOnDeliveryPaymentChoicePage or PayOnDeliveryPage

• gift_card: Routes to GiftCardPaymentPage

Gift Card Payment Option: The gift_card payment option appears in the available options list only when all of the following are true:

• At least one gift card reservation exists on the order

• The remaining unpaid amount is exactly zero (gift cards fully cover the order)

When gift cards only partially cover the order total, the gift_card payment option is not shown. In this case the user selects a regular payment option (e.g. credit card). During order placement the applied gift card amounts are charged first; the remaining balance is then charged to the selected payment method.

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

Payment option selection page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=PaymentOptionSelectionPage

HTTPcURLJavaScriptPython

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

200

Payment option selection page context retrieved

{
  "context_list": [
    {
      "page_name": "PaymentOptionSelectionPage",
      "page_slug": "paymentoptionselectionpage",
      "page_context": {
        "checkout_url": "https://sandbox.akinon.com/orders/checkout/?token=abc123def456",
        "status_url": "https://sandbox.akinon.com/orders/checkout/status/?token=abc123def456",
        "payment_options": [
          {
            "pk": 1,
            "name": "Credit Card",
            "slug": "credit-card",
            "payment_type": "credit_card",
            "payment_type_label": "Credit Card"
          },
          {
            "pk": 2,
            "name": "Pay on Delivery",
            "slug": "pay-on-delivery",
            "payment_type": "pay_on_delivery",
            "payment_type_label": "Pay on Delivery"
          },
          {
            "pk": 3,
            "name": "Bank Transfer",
            "slug": "bank-transfer",
            "payment_type": "funds_transfer",
            "payment_type_label": "Bank Transfer"
          }
        ],
        "unavailable_options": [
          {
            "name": "Loyalty Points",
            "slug": "loyalty-points",
            "payment_type": "loyalty_money",
            "payment_type_label": "Loyalty Points",
            "error_code": "insufficient_balance",
            "error_message": "Insufficient loyalty points balance"
          }
        ]
      }
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "shipping_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe",
      "email": "[e-mail]",
      "phone_number": "[phone]",
      "line": "123 Main St",
      "country": {
        "pk": 1,
        "code": "US",
        "name": "United States"
      },
      "city": {
        "pk": 1,
        "name": "New York"
      },
      "township": {
        "pk": 1,
        "name": "Manhattan"
      }
    },
    "billing_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe"
    },
    "billing_and_shipping_same": true,
    "delivery_option": {
      "pk": 1,
      "name": "Home Delivery",
      "slug": "home-delivery",
      "delivery_option_type": "customer",
      "sort_order": 1
    },
    "shipping_option": {
      "pk": 1,
      "name": "Standard Shipping",
      "slug": "standard-shipping",
      "logo": "https://cdn.akinon.com/logos/standard.png",
      "shipping_amount": "9.99",
      "description": "Delivery in 3-5 business days",
      "kwargs": {}
    },
    "shipping_amount": "9.99",
    "payment_option": null,
    "notifications": [],
    "total_amount": "159.99",
    "unpaid_amount": "159.99",
    "loyalty_money": null,
    "currency_type_label": "USD",
    "installment": null,
    "redirect_to_three_d": null,
    "retail_store": null,
    "payment_choice": null,
    "user_email": "[e-mail]",
    "phone_number": "[phone]",
    "user_phone_number": "[phone]",
    "gift_box": null,
    "delivery_range": null,
    "total_amount_with_interest": "159.99",
    "is_guest": false,
    "is_post_order": false,
    "data_source_shipping_options": null,
    "attribute_based_shipping_options": null
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Select Payment Option

post

Sets the selected payment option for the order.

Validation:

• The selected payment option must be active

• The selected payment option must pass its availability rules

Payment Option Processing:

• If payment option is pay-on-delivery type, installment and card_info are cleared

• Previous MobilExpress data (keys starting with me_) is cleared

• Payment choice is reset

Next Pages: Based on the selected payment option type, the user is routed to the appropriate page:

• credit_card: BinNumberPage (enter card bin number)

• funds_transfer: FundsTransferChoicePage (select bank account)

• bkm_express: BexSelectionPage (BKM Express flow)

• loyalty_money: LoyaltyMoneyPage (use loyalty points)

• cash_register: CashRegisterPage (cash register payment)

• gpay: GPaySelectionPage (Google Pay flow)

• redirection: RedirectionPaymentSelectedPage (redirect to payment provider)

• stored_card: MobilExpressSelectionPage (use stored card)

• masterpass: MasterpassBinNumberPage (Masterpass flow)

• masterpass_rest: MasterpassRestBinNumberPage (Masterpass REST API flow)

• credit_payment: CreditPaymentSelectionPage (credit/installment payment)

• pay_later: PayLaterCompletePage (buy now pay later)

• saved_card: SavedCardSelectionPage (use saved card)

• confirmation: ConfirmationPaymentAgreementCheckPage (confirmation required)

• b2b: B2BPage (B2B payment)

• wallet: WalletSelectionPage (digital wallet)

• pay_on_delivery: If multiple payment choices available: PayOnDeliveryPaymentChoicePage, otherwise: PayOnDeliveryPage

• gift_card: GiftCardPaymentPage (complete order fully covered by gift cards)

Partial gift card payment: When gift cards are applied but do not fully cover the order, the user selects a regular payment option here. Selecting a non-gift-card payment type does not remove the applied gift card reservations. During order placement, the gift card amounts are charged first; the remaining balance is charged to the selected payment method.

Cascading Invalidation:

• Selecting a new payment option clears previous payment-related data

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

application/x-www-form-urlencoded

payment_optionintegerRequired

Primary key of the selected payment option. Must be an active payment option that passes availability rules.

Responses

200

Payment option selected successfully

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

post/orders/checkout/?page=PaymentOptionSelectionPage

HTTPcURLJavaScriptPython

POST /orders/checkout/?page=PaymentOptionSelectionPage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 20

"payment_option=1"

Select credit card paymentSelect pay on deliverySelect gift card payment (full coverage)

200

Payment option selected successfully

{
  "context_list": [
    {
      "page_name": "BinNumberPage",
      "page_slug": "binnumberpage",
      "page_context": {}
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "shipping_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe",
      "email": "[e-mail]",
      "phone_number": "[phone]",
      "line": "123 Main St",
      "country": {
        "pk": 1,
        "code": "US",
        "name": "United States"
      },
      "city": {
        "pk": 1,
        "name": "New York"
      },
      "township": {
        "pk": 1,
        "name": "Manhattan"
      }
    },
    "billing_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe"
    },
    "billing_and_shipping_same": true,
    "delivery_option": {
      "pk": 1,
      "name": "Home Delivery",
      "slug": "home-delivery",
      "delivery_option_type": "customer",
      "sort_order": 1
    },
    "shipping_option": {
      "pk": 1,
      "name": "Standard Shipping",
      "slug": "standard-shipping",
      "logo": "https://cdn.akinon.com/logos/standard.png",
      "shipping_amount": "9.99",
      "description": "Delivery in 3-5 business days",
      "kwargs": {}
    },
    "shipping_amount": "9.99",
    "payment_option": {
      "pk": 1,
      "name": "Credit Card",
      "slug": "credit-card",
      "payment_type": "credit_card",
      "payment_type_label": "Credit Card"
    },
    "notifications": [],
    "total_amount": "159.99",
    "unpaid_amount": "159.99",
    "loyalty_money": null,
    "currency_type_label": "USD",
    "installment": null,
    "redirect_to_three_d": null,
    "retail_store": null,
    "payment_choice": null,
    "user_email": "[e-mail]",
    "phone_number": "[phone]",
    "user_phone_number": "[phone]",
    "gift_box": null,
    "delivery_range": null,
    "total_amount_with_interest": "159.99",
    "is_guest": false,
    "is_post_order": false,
    "data_source_shipping_options": null,
    "attribute_based_shipping_options": null
  },
  "errors": {},
  "template_name": "orders/checkout.html"
}

Get Credit Payment Selection Page context

get

Returns the list of available POS (point-of-sale) options for credit payment. This page is reached when the user selects a payment option whose type is credit_payment.

Preconditions:

• Basket must not be empty

• A credit payment option must be selected (check_credit_payment_selected)

Skip Conditions:

• Page is skipped if a POS option has already been selected (i.e., credit_payment_option is set in pre_order.data)

Next Pages:

• CreditPaymentConfirmationPage

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

Credit Payment Selection Page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=CreditPaymentSelectionPage

HTTPcURLJavaScriptPython

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

200

Credit Payment Selection Page context retrieved

{
  "context_list": [
    {
      "page_name": "CreditPaymentSelectionPage",
      "page_slug": "creditpaymentselectionpage",
      "page_context": {
        "credit_payment_options": [
          {
            "pk": 10,
            "name": "Garanti Credit",
            "slug": "garanti-credit"
          },
          {
            "pk": 11,
            "name": "Fiba Credit",
            "slug": "fiba-credit"
          }
        ]
      }
    }
  ],
  "pre_order": {
    "user_email": "[e-mail]",
    "payment_option": {
      "pk": 3,
      "name": "Credit Payment",
      "payment_type": "credit_payment"
    }
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Select a credit POS option

post

Stores the selected POS option in pre_order.data['credit_payment_option']. The submitted PK must belong to one of the available POS options returned in the GET context (payment_option.get_available_poses()).

Required Fields:

• credit_payment_option: Primary key of the selected Pos object.

Validation:

• The POS must be present in the available POS options for the current payment option.

State Update:

• pre_order.data['credit_payment_option'] is set to the selected Pos instance.

Backward Navigation:

• When navigating backward, credit_payment_option is reset to null.

Next Pages:

• CreditPaymentConfirmationPage

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

application/x-www-form-urlencoded

credit_payment_optionintegerRequired

Primary key of the selected Pos object. Must be one of the available POS options returned by payment_option.get_available_poses() for the current credit payment option.

Example: 10

Responses

200

POS option selected or validation error

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

post/orders/checkout/?page=CreditPaymentSelectionPage

HTTPcURLJavaScriptPython

POST /orders/checkout/?page=CreditPaymentSelectionPage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 28

"credit_payment_option=10"

200

POS option selected or validation error

{
  "context_list": [
    {
      "page_name": "CreditPaymentConfirmationPage",
      "page_slug": "creditpaymentconfirmationpage",
      "page_context": {}
    }
  ],
  "pre_order": {
    "user_email": "[e-mail]"
  },
  "errors": {},
  "template_name": "orders/checkout.html"
}

Get Pay on Delivery Page context

get

Returns the confirmation page for a pay-on-delivery order. The user reviews the order and accepts the terms and conditions before the order is created.

Preconditions:

• Basket must not be empty

• Payment option must be pay-on-delivery type

• If the payment option has payment_choices configured, a choice must already have been selected (via PayOnDeliveryPaymentChoicePage)

• If the payment option has sms_verification: true in its configuration, the user must have completed SMS verification (phone number entered, code sent and entered correctly)

Page Context:

• Returns an empty object {}. All order summary information is available in the pre_order field of the response.

Skip Conditions:

• Page is skipped when is_post_order is true (post-order flow)

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

Pay on delivery page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=PayOnDeliveryPage

HTTPcURLJavaScriptPython

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

200

Pay on delivery page context retrieved

{
  "context_list": [
    {
      "page_name": "PayOnDeliveryPage",
      "page_slug": "payondeliverypage",
      "page_context": {}
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "shipping_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe",
      "email": "[e-mail]",
      "phone_number": "[phone]",
      "line": "123 Main St",
      "country": {
        "pk": 1,
        "code": "US",
        "name": "United States"
      },
      "city": {
        "pk": 1,
        "name": "New York"
      },
      "township": {
        "pk": 1,
        "name": "Manhattan"
      }
    },
    "billing_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe"
    },
    "billing_and_shipping_same": true,
    "delivery_option": {
      "pk": 1,
      "name": "Home Delivery",
      "delivery_option_type": "customer"
    },
    "shipping_option": {
      "pk": 2,
      "name": "Standard Shipping",
      "slug": "standard-shipping",
      "shipping_amount": "9.99",
      "logo": null,
      "description": null,
      "kwargs": {}
    },
    "shipping_amount": "9.99",
    "payment_option": {
      "pk": 4,
      "name": "Pay on Delivery",
      "slug": "pay-on-delivery",
      "payment_type": "pay_on_delivery",
      "payment_type_label": "Pay on Delivery"
    },
    "payment_choice": {
      "value": "cash",
      "label": "Cash",
      "price": "0.00"
    },
    "total_amount": "159.99",
    "unpaid_amount": "159.99",
    "total_amount_with_interest": "159.99",
    "currency_type_label": "TRY",
    "installment": null,
    "card_info": null
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Complete Pay on Delivery Order

post

Creates the order for pay-on-delivery after the user accepts the terms and conditions.

Required Fields:

• agreement: Must be true. Submitting false or omitting this field causes a validation error.

Validation:

• Basket amount must be greater than zero

Order Creation:

• Order is created via PaymentPageMixin.process_order

• After creation: basket is submitted, contracts are saved, confirmation email is sent, order completion SMS is sent

• pre_order.card_info is reset to null

• pre_order.installment is reset to null

Order Number:

• The order number is regenerated at this step unless it was already set

Next Pages:

• ThankYouPage

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

application/x-www-form-urlencoded

agreementboolean · enumRequired

User must accept terms and conditions to proceed. Must be true.

Possible values:

Responses

200

Pay on delivery order created successfully

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

post/orders/checkout/?page=PayOnDeliveryPage

HTTPcURLJavaScriptPython

POST /orders/checkout/?page=PayOnDeliveryPage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 18

"agreement=true"

200

Pay on delivery order created successfully

{
  "context_list": [
    {
      "page_name": "ThankYouPage",
      "page_slug": "thankyoupage",
      "page_context": {
        "redirect_url": "/orders/checkout-success/abc123:def456:ghi789/",
        "order_id": 5001,
        "order_number": "ORD-2026-0001",
        "new_user": false,
        "token": null,
        "campaigns": []
      }
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "order": {
      "pk": 5001,
      "number": "ORD-2026-0001",
      "status": "confirmed"
    },
    "payment_option": {
      "pk": 4,
      "name": "Pay on Delivery",
      "slug": "pay-on-delivery",
      "payment_type": "pay_on_delivery",
      "payment_type_label": "Pay on Delivery"
    },
    "total_amount": "159.99",
    "currency_type_label": "TRY",
    "card_info": null,
    "installment": null
  },
  "errors": {},
  "template_name": "orders/checkout.html"
}

Get Pay on Delivery Payment Choice Page context

get

Returns the available payment choices for a pay-on-delivery payment option. This page allows the user to select how they will pay at the point of delivery (e.g., cash, credit card terminal, etc.).

Preconditions:

• Basket must not be empty

• Payment option must be selected and must be of pay-on-delivery type

Skip Conditions:

• Page is skipped when is_post_order is true (post-order flow)

• Page is skipped entirely when the selected payment option's payment_choices list is empty (no choices to present). In this case the flow proceeds directly to PayOnDeliveryPage.

Routing from PaymentOptionSelectionPage:

• Routes here when skip_pod_choices is false and there is at least one choice, or when there is more than one choice regardless of skip_pod_choices.

• When skip_pod_choices is true and exactly one choice exists, the choice is auto-selected and this page is skipped.

Payment Choice Object: Each item in payment_choices contains:

• value: internal identifier string used as the form value

• label: human-readable display name

• price: additional fee charged for this payment method (as decimal string)

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

Pay on delivery payment choice page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=PayOnDeliveryPaymentChoicePage

HTTPcURLJavaScriptPython

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

200

Pay on delivery payment choice page context retrieved

{
  "context_list": [
    {
      "page_name": "PayOnDeliveryPaymentChoicePage",
      "page_slug": "payondeliverypaymentchoicepage",
      "page_context": {
        "payment_choices": [
          {
            "value": "cash",
            "label": "Cash",
            "price": "0.00"
          },
          {
            "value": "credit_card_terminal",
            "label": "Credit Card Terminal",
            "price": "5.00"
          }
        ]
      }
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "payment_option": {
      "pk": 4,
      "name": "Pay on Delivery",
      "slug": "pay-on-delivery",
      "payment_type": "pay_on_delivery",
      "payment_type_label": "Pay on Delivery"
    },
    "payment_choice": null,
    "total_amount": "150.00",
    "currency_type_label": "TRY"
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Select Pay on Delivery Payment Choice

post

Saves the user's selected payment choice for pay-on-delivery.

Required Fields:

• payment_choice: The value string of one of the items returned in payment_choices from the GET context. Submitting a value not present in that list causes a validation error.

Validation:

• Basket amount must be greater than zero

• payment_choice must match one of the valid values returned by the payment option's choices

State Update:

• pre_order.payment_choice is set to the selected PaymentChoice object

Next Pages:

• SendSmsPage — when the payment option's sms_verification configuration is true

• PayOnDeliveryPage — in all other cases

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

application/x-www-form-urlencoded

payment_choicestringRequired

The value string of one of the payment choices returned in the payment_choices list from the GET context of PayOnDeliveryPaymentChoicePage. Submitting a value not present in that list causes a validation error.

Example: cash

Responses

200

Payment choice selected successfully

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

post/orders/checkout/?page=PayOnDeliveryPaymentChoicePage

HTTPcURLJavaScriptPython

POST /orders/checkout/?page=PayOnDeliveryPaymentChoicePage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 25

"payment_choice='cash'"

Select cash paymentSelect credit card terminal

200

Payment choice selected successfully

{
  "context_list": [
    {
      "page_name": "PayOnDeliveryPage",
      "page_slug": "payondeliverypage",
      "page_context": {}
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "payment_option": {
      "pk": 4,
      "name": "Pay on Delivery",
      "slug": "pay-on-delivery",
      "payment_type": "pay_on_delivery",
      "payment_type_label": "Pay on Delivery"
    },
    "payment_choice": {
      "value": "cash",
      "label": "Cash",
      "price": "0.00"
    },
    "total_amount": "150.00",
    "currency_type_label": "TRY"
  },
  "errors": {},
  "template_name": "orders/checkout.html"
}

Get Funds Transfer Page context

get

Returns payment instructions for funds transfer. Displays bank account details and reference code for customer to complete payment.

Preconditions:

• Payment option must be funds transfer type

• Bank account must be selected (funds_transfer_bank)

• Basket must not be empty

Payment Instructions:

• Bank account details (IBAN, account holder, bank name)

• Order number for reference

• Reference code (if gateway supports it)

• Total amount to transfer

• Currency information

Reference Code Context:

• Retrieved from pre_order.data['funds_transfer']

• Displayed prominently for customer to include in transfer

• Used by payment reconciliation system to match transfers

Order Status:

• Order is created in "pending" status

• Waiting for payment confirmation

• Payment team manually confirms transfer receipt

• Order status updated to "confirmed" after verification

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

Funds transfer page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=FundsTransferPage

HTTPcURLJavaScriptPython

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

200

Funds transfer page context retrieved

{
  "context_list": [
    {
      "page_name": "FundsTransferPage",
      "page_slug": "fundstransferpage",
      "page_context": {
        "reference_code": "REF-ORD-2026-0001-ABC123"
      }
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "shipping_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe"
    },
    "billing_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe"
    },
    "payment_option": {
      "pk": 3,
      "name": "Bank Transfer",
      "slug": "bank-transfer",
      "payment_type": "funds_transfer",
      "payment_type_label": "Bank Transfer"
    },
    "funds_transfer_bank": {
      "pk": 1,
      "bank_name": "Example Bank",
      "account_holder": "AKINON TECHNOLOGIES",
      "iban": "TR330006100519786457841326",
      "currency": "TRY"
    },
    "number": "ORD-2026-0001",
    "total_amount": "159.99",
    "unpaid_amount": "159.99",
    "currency_type_label": "USD"
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Complete Funds Transfer Order

post

Completes the order creation for funds transfer payment. Order is created in pending status, awaiting payment confirmation.

Required Fields:

• agreement: User must accept terms and conditions (boolean, must be true)

Validation:

• Basket amount must be greater than or equal to zero

• Bank account must be selected

• Payment option must be funds transfer type

Order Creation:

• Order is created with status "pending_payment" or "awaiting_funds_transfer"

• Order details include:

  • Selected bank account information

  • Reference code (if applicable)

  • Payment instructions

• User receives confirmation email with payment details

• Stock is reserved (depending on configuration)

Order Number:

• Order number is NOT regenerated at this step

• Uses existing pre-order number assigned in previous step

Payment Confirmation Flow:

1. User completes bank transfer using provided details

2. Payment team receives transfer notification

3. Payment team matches transfer using reference code/order number

4. Order status updated to "confirmed"

5. Fulfillment process begins

Next Pages:

• ThankYouPage (order completed, awaiting payment)

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

application/x-www-form-urlencoded

agreementboolean · enumRequired

User must accept terms and conditions to proceed. Must be true.

Possible values:

Responses

200

Funds transfer order completed successfully

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

post/orders/checkout/?page=FundsTransferPage

HTTPcURLJavaScriptPython

POST /orders/checkout/?page=FundsTransferPage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 18

"agreement=true"

200

Funds transfer order completed successfully

{
  "context_list": [
    {
      "page_name": "ThankYouPage",
      "page_slug": "thankyoupage",
      "page_context": {
        "redirect_url": "/orders/checkout-success/abc123:def456:ghi789/",
        "order_id": 5001,
        "order_number": "ORD-2026-0001",
        "new_user": false,
        "token": null,
        "campaigns": []
      }
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "order": {
      "pk": 5001,
      "number": "ORD-2026-0001",
      "status": "awaiting_funds_transfer"
    },
    "funds_transfer_bank": {
      "pk": 1,
      "bank_name": "Example Bank",
      "account_holder": "AKINON TECHNOLOGIES",
      "iban": "TR330006100519786457841326"
    },
    "total_amount": "159.99",
    "currency_type_label": "USD"
  },
  "errors": {},
  "template_name": "orders/checkout.html"
}

Get Funds Transfer Choice Page context

get

Returns available bank accounts for funds transfer (wire transfer/EFT) payment. User selects which bank account to transfer money to.

Preconditions:

• Payment option must be selected and must be funds transfer type (is_funds_transfer())

• Basket must not be empty

Bank Account Selection:

• Lists all active bank accounts configured in the system

• Each bank account includes: bank name, account holder, IBAN, currency

• User selects one bank account for payment instructions

Auto-selection:

• If only one bank account is available and no POS slug configured:

  • Bank account is automatically selected

  • Page is skipped

  • Routes directly to FundsTransferPage

Reference Code Generation:

• Some payment gateways support reference codes for tracking

• If gateway has has_reference_code capability:

  • Reference code is generated when bank account is selected

  • Reference code is stored in pre_order.data['funds_transfer']

  • Used to match customer payment with order

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

Funds transfer choice page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=FundsTransferChoicePage

HTTPcURLJavaScriptPython

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

200

Funds transfer choice page context retrieved

{
  "context_list": [
    {
      "page_name": "FundsTransferChoicePage",
      "page_slug": "fundstransferchoicepage",
      "page_context": {
        "bank_accounts": [
          {
            "pk": 1,
            "bank_name": "Example Bank",
            "account_holder": "AKINON TECHNOLOGIES",
            "iban": "TR330006100519786457841326",
            "currency": "TRY",
            "is_active": true
          },
          {
            "pk": 2,
            "bank_name": "Another Bank",
            "account_holder": "AKINON TECHNOLOGIES",
            "iban": "TR330006100519786457841327",
            "currency": "USD",
            "is_active": true
          }
        ]
      }
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "shipping_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe"
    },
    "billing_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe"
    },
    "payment_option": {
      "pk": 3,
      "name": "Bank Transfer",
      "slug": "bank-transfer",
      "payment_type": "funds_transfer",
      "payment_type_label": "Bank Transfer"
    },
    "funds_transfer_bank": null,
    "total_amount": "159.99",
    "unpaid_amount": "159.99",
    "currency_type_label": "USD"
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Select Bank Account for Funds Transfer

post

Sets the selected bank account for funds transfer payment.

Validation:

• Selected bank account must be active

• Basket amount must be greater than or equal to zero

Reference Code Generation:

• If payment gateway supports reference codes (has_reference_code):

  • Generates unique reference code for the order

  • Uses order number, amount, currency as input

  • Includes user email, addresses, and site domain

  • Stores reference code in pre_order.data['funds_transfer']['reference_code']

• Reference code is displayed to user on next page for payment matching

Order Number Assignment:

• Pre-order number is assigned at this step (if not already assigned)

• Order number used in reference code generation

Bank Account Change Handling:

• If user changes bank account selection:

  • Reference code is regenerated

  • Previous reference code is invalidated

Next Pages:

• FundsTransferPage (display payment instructions)

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

application/x-www-form-urlencoded

bank_accountintegerRequired

Primary key of the selected bank account. Must be an active bank account configured in the system.

Responses

200

Bank account selected successfully

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

post/orders/checkout/?page=FundsTransferChoicePage

HTTPcURLJavaScriptPython

POST /orders/checkout/?page=FundsTransferChoicePage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 18

"bank_account=1"

200

Bank account selected successfully

{
  "context_list": [
    {
      "page_name": "FundsTransferPage",
      "page_slug": "fundstransferpage",
      "page_context": {
        "reference_code": "REF-ORD-2026-0001-ABC123"
      }
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "shipping_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe"
    },
    "billing_address": {
      "pk": 10,
      "first_name": "John",
      "last_name": "Doe"
    },
    "payment_option": {
      "pk": 3,
      "name": "Bank Transfer",
      "slug": "bank-transfer",
      "payment_type": "funds_transfer",
      "payment_type_label": "Bank Transfer"
    },
    "funds_transfer_bank": {
      "pk": 1,
      "bank_name": "Example Bank",
      "account_holder": "AKINON TECHNOLOGIES",
      "iban": "TR330006100519786457841326",
      "currency": "TRY"
    },
    "number": "ORD-2026-0001",
    "total_amount": "159.99",
    "unpaid_amount": "159.99",
    "currency_type_label": "USD"
  },
  "errors": {},
  "template_name": "orders/checkout.html"
}

Get Pay Later Complete Page context

get

Returns the context for the pay-later order completion step. No additional data is required at this stage; the page serves as the final agreement confirmation before the pay-later order is placed.

Preconditions:

• Basket must not be empty.

• The selected payment option must be of pay-later type.

Page Context:

• Returns an empty object {}. All required data was collected at the payment option selection step.

Step Completion: This page is considered already completed when the selected payment option is of pay-later type and the order has been finalised.

available_for_post_order: false

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

Pay later complete page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=PayLaterCompletePage

HTTPcURLJavaScriptPython

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

200

Pay later complete page context retrieved

{
  "context_list": [
    {
      "page_name": "PayLaterCompletePage",
      "page_slug": "paylatercompletepage",
      "page_context": {}
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "payment_option": {
      "pk": 7,
      "name": "Pay Later",
      "slug": "pay-later",
      "payment_type": "pay_later",
      "payment_type_label": "Pay Later"
    }
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Confirm and place pay-later order

post

Submits the final agreement and places the pay-later order. The customer must accept the terms and conditions; once accepted, the order is finalised immediately without a payment transaction.

Required Fields:

• agreement: Must be true.

Backward Navigation:

• No state is reset on backward navigation.

Next Page:

• ThankYouPage

available_for_post_order: false

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

application/x-www-form-urlencoded

agreementboolean · enumRequired

Acceptance of the terms and conditions. Must be true to place the pay-later order.

Possible values:

Responses

200

Pay-later order placed

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

post/orders/checkout/?page=PayLaterCompletePage

HTTPcURLJavaScriptPython

POST /orders/checkout/?page=PayLaterCompletePage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 18

"agreement=true"

200

Pay-later order placed

{
  "context_list": [
    {
      "page_name": "ThankYouPage",
      "page_slug": "thankyoupage",
      "page_context": {}
    }
  ],
  "errors": [],
  "template_name": "orders/checkout.html"
}

Get Checkout Provider Shipping Option Page context

get

Returns the available shipping options for the delivery address provided by the checkout provider. The customer's device (via the provider's hosted form) selects a shipping option and submits it back.

Preconditions:

• Basket must not be empty

• A checkout provider must be selected

Skip Conditions:

• Page is skipped if both billing_address and shipping_address are already set on the pre-order

Page Context:

• shipping_options — list of available options, each with name, slug, logo_url, shipping_amount, description, key

Previous Page: CheckoutProviderAddressSelectionPage

Next Page: CheckoutProviderAgreementListPage

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

Shipping Option Page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=CheckoutProviderShippingOptionPage

HTTPcURLJavaScriptPython

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

200

Shipping Option Page context retrieved

{
  "context_list": [
    {
      "page_name": "CheckoutProviderShippingOptionPage",
      "page_slug": "checkoutprovidershippingoptionpage",
      "page_context": {
        "shipping_options": [
          {
            "name": "Standard Shipping",
            "slug": "standard-shipping",
            "logo_url": "https://cdn.example.com/shipping-logo.png",
            "shipping_amount": "9.90",
            "description": "Delivery in 3-5 days",
            "key": 1
          }
        ]
      }
    }
  ],
  "pre_order": {
    "user_email": "[e-mail]"
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Submit shipping option selection from checkout provider

post

Accepts the shipping option selection forwarded from the checkout provider's hosted form along with the basket and conversation identifiers. Verifies the conversation_id against the one stored in the pre-order to ensure the response belongs to the active session.

Required Fields: basket_id, conversation_id

Optional Fields: language

Validation:

• conversation_id must match pre_order.checkout_provider_data['conversation_id']

Next Page: CheckoutProviderAgreementListPage

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

application/x-www-form-urlencoded

Payload forwarded by the checkout provider after the customer selects a shipping option on the hosted form. The conversation_id is validated against the active session to prevent replay.

basket_idintegerRequired

Primary key of the active basket.

Example: 42

conversation_idstringRequired

Provider conversation identifier. Must match the value stored in pre_order.checkout_provider_data['conversation_id'].

Example: conv-abc-123

languagestring · nullableOptional

Optional language code forwarded by the provider (e.g. "tr", "en").

Example: tr

Responses

200

Shipping option step processed

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

post/orders/checkout/?page=CheckoutProviderShippingOptionPage

HTTPcURLJavaScriptPython

POST /orders/checkout/?page=CheckoutProviderShippingOptionPage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 65

"basket_id=42&conversation_id='conv-abc-123'&language='tr'"

200

Shipping option step processed

{
  "context_list": [
    {
      "page_name": "CheckoutProviderAgreementListPage",
      "page_slug": "checkoutprovideragreementlistpage",
      "page_context": {
        "agreements": [
          {
            "code": "info",
            "text": "Preliminary Information Form"
          },
          {
            "code": "sales",
            "text": "Distance Sales Agreement"
          }
        ]
      }
    }
  ],
  "pre_order": {
    "user_email": "[e-mail]"
  },
  "errors": {},
  "template_name": "orders/checkout.html"
}