> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/checkout/payment-method-selection/get-payment-option-selection-page-context.md).

# Get Payment Option Selection Page context

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.

```json
{"openapi":"3.1.0","info":{"title":"Overview","version":"1.0.0"},"tags":[{"name":"Payment Method Selection","description":"# Checkout Payment Method Selection\n\nPresent 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.\n\n## Request Format\n\nInclude the following header in all checkout requests:\n\n- **x-requested-with**: `XMLHttpRequest`\n\n## Authentication\n\nA valid session cookie is required. The checkout URL token mechanism is also supported for external redirect flows.\n\n## Dynamic Settings\n\n### CHECKOUT_WITH_TOKEN_ALLOW_ANONYMOUS\nControls whether anonymous users may access checkout via token-based URLs. When disabled, only authenticated users can use token checkout links."}],"servers":[{"description":"Akinon Checkout API","url":"https://{commerce_url}","variables":{"commerce_url":{"default":"sandbox.akinon.com"}}}],"paths":{"/orders/checkout/?page=PaymentOptionSelectionPage":{"get":{"tags":["Payment Method Selection"],"operationId":"getPaymentOptionSelectionPage","summary":"Get Payment Option Selection Page context","description":"Returns available payment options for the order.\nPayment options are filtered based on configured rules and user context.\n\n**Preconditions**:\n- Shipping option must be selected (`check_shipping_option_selected`)\n- Basket must not be empty\n\n**Payment Option Availability**:\n- Each payment option has associated rules that determine availability\n- Rules can check basket contents, user status, order amount, and more\n- Unavailable options are returned separately with error codes and messages\n\n**Checkout URLs**:\n- `checkout_url`: URL for checkout with token (used for external payment flows)\n- `status_url`: URL to check checkout status (used for polling payment status)\n- Generated by `CheckoutWithTokenService`\n\n**Payment Types**:\nPayment options can have different types that determine the next page flow:\n- `credit_card`: Routes to `BinNumberPage`\n- `funds_transfer`: Routes to `FundsTransferChoicePage`\n- `bkm_express`: Routes to `BexSelectionPage`\n- `loyalty_money`: Routes to `LoyaltyMoneyPage`\n- `cash_register`: Routes to `CashRegisterPage`\n- `gpay`: Routes to `GPaySelectionPage`\n- `redirection`: Routes to `RedirectionPaymentSelectedPage`\n- `stored_card`: Routes to `MobilExpressSelectionPage`\n- `masterpass`: Routes to `MasterpassBinNumberPage`\n- `masterpass_rest`: Routes to `MasterpassRestBinNumberPage`\n- `credit_payment`: Routes to `CreditPaymentSelectionPage`\n- `pay_later`: Routes to `PayLaterCompletePage`\n- `saved_card`: Routes to `SavedCardSelectionPage`\n- `confirmation`: Routes to `ConfirmationPaymentAgreementCheckPage`\n- `b2b`: Routes to `B2BPage`\n- `wallet`: Routes to `WalletSelectionPage`\n- `pay_on_delivery`: Routes to `PayOnDeliveryPaymentChoicePage` or `PayOnDeliveryPage`\n- `gift_card`: Routes to `GiftCardPaymentPage`\n\n**Gift Card Payment Option**:\nThe `gift_card` payment option appears in the available options list **only\nwhen** all of the following are true:\n- At least one gift card reservation exists on the order\n- The remaining unpaid amount is exactly zero (gift cards fully cover the order)\n\nWhen gift cards only partially cover the order total, the `gift_card` payment\noption is **not shown**. In this case the user selects a regular payment option\n(e.g. credit card). During order placement the applied gift card amounts are\ncharged first; the remaining balance is then charged to the selected payment\nmethod.","parameters":[{"$ref":"#/components/parameters/AjaxRequestHeader"},{"$ref":"#/components/parameters/SessionCookieHeader"}],"responses":{"200":{"description":"Payment option selection page context retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutResponse"}}}}}}}},"components":{"parameters":{"AjaxRequestHeader":{"name":"x-requested-with","in":"header","required":true,"description":"Required header for AJAX requests. Must be set to `XMLHttpRequest` for all checkout requests.","schema":{"type":"string","enum":["XMLHttpRequest"],"default":"XMLHttpRequest"}},"SessionCookieHeader":{"name":"Cookie","in":"header","required":false,"description":"Session cookie header (e.g. `sessionid=abc123` or `osessionid=<session_id>`)","schema":{"type":"string"}}},"schemas":{"CheckoutResponse":{"type":"object","properties":{"context_list":{"type":"array","items":{"$ref":"#/components/schemas/PageContext"}},"pre_order":{"$ref":"#/components/schemas/PreOrder"},"errors":{"oneOf":[{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},{"type":"null"},{"type":"array","items":{"type":"string"}}]},"template_name":{"type":"string"}}},"PageContext":{"type":"object","properties":{"page_name":{"type":"string","description":"Class name of the page (e.g., \"IndexPage\", \"AddressSelectionPage\")"},"page_slug":{"type":"string","description":"URL-friendly slug for the page"},"page_context":{"type":"object","description":"Page-specific context data","additionalProperties":true}}},"PreOrder":{"type":"object","description":"Pre-order state containing basket, addresses, shipping, payment information","properties":{"basket":{"$ref":"#/components/schemas/Basket"},"shipping_address":{"oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"billing_address":{"oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"shipping_option":{"oneOf":[{"$ref":"#/components/schemas/ShippingOptionDetail"},{"type":"null"}]},"billing_and_shipping_same":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"payment_option":{"oneOf":[{"$ref":"#/components/schemas/PaymentOptionDetail"},{"type":"null"}]},"notifications":{"type":"array","items":{"type":"object"}},"shipping_amount":{"oneOf":[{"type":"string","pattern":"^\\d+\\.\\d{2}$"},{"type":"null"}]},"total_amount":{"oneOf":[{"type":"string","pattern":"^\\d+\\.\\d{2}$"},{"type":"null"}]},"unpaid_amount":{"oneOf":[{"type":"string","pattern":"^\\d+\\.\\d{2}$"},{"type":"null"}]},"loyalty_money":{"oneOf":[{"type":"string","pattern":"^\\d+\\.\\d{2}$"},{"type":"null"}]},"currency_type_label":{"type":"string"},"installment":{"oneOf":[{"$ref":"#/components/schemas/Installment"},{"type":"null"}]},"card_info":{"oneOf":[{"type":"object","description":"Card information from BIN lookup","properties":{"bin_number":{"type":"string","description":"Card BIN (first 6-8 digits)"},"card":{"type":"object","description":"Card details from BIN database","properties":{"pk":{"type":"integer"},"name":{"type":"string","description":"Card type name (e.g., \"Visa\", \"Mastercard\")"}}}}},{"type":"null"}]},"redirect_to_three_d":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"delivery_option":{"oneOf":[{"$ref":"#/components/schemas/DeliveryOption"},{"type":"null"}]},"retail_store":{"oneOf":[{"$ref":"#/components/schemas/RetailStore"},{"type":"null"}]},"funds_transfer_bank":{"oneOf":[{"$ref":"#/components/schemas/BankAccount"},{"type":"null"}]},"number":{"oneOf":[{"type":"string","description":"Pre-order/order number"},{"type":"null"}]},"order":{"oneOf":[{"type":"object","description":"Created order (after checkout completion)","properties":{"pk":{"type":"integer"},"number":{"type":"string"},"status":{"type":"string"}}},{"type":"null"}]},"payment_choice":{"oneOf":[{"$ref":"#/components/schemas/PaymentChoice"},{"type":"null"}]},"user_email":{"oneOf":[{"type":"string"},{"type":"null"}]},"phone_number":{"oneOf":[{"type":"string"},{"type":"null"}]},"user_phone_number":{"oneOf":[{"type":"string"},{"type":"null"}]},"gift_box":{"oneOf":[{"type":"object","properties":{"note":{"type":"string"},"gift_video":{"type":"boolean"},"gift_video_notification_sent":{"type":"boolean"},"price":{"type":"string"}}},{"type":"null"}]},"delivery_range":{"oneOf":[{"type":"object","properties":{"lower":{"type":"string","format":"date-time"},"upper":{"type":"string","format":"date-time"}}},{"type":"null"}]},"total_amount_with_interest":{"oneOf":[{"type":"string","pattern":"^\\d+\\.\\d{2}$"},{"type":"null"}]},"is_guest":{"type":"boolean"},"is_post_order":{"type":"boolean"},"data_source_shipping_options":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/DataSourceShippingOptionDetail"}},{"type":"null"}]},"attribute_based_shipping_options":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/PreOrderAttributeBasedShippingOption"}},{"type":"null"}]}}},"Basket":{"type":"object","properties":{"pk":{"type":"integer"},"total_amount":{"type":"string","pattern":"^\\d+\\.\\d{2}$"}}},"Address":{"type":"object","properties":{"pk":{"type":"integer"},"email":{"type":"string"},"phone_number":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string"},"title":{"type":"string"},"township":{"$ref":"#/components/schemas/Township"},"district":{"oneOf":[{"$ref":"#/components/schemas/District"},{"type":"null"}]},"postcode":{"type":"string"},"notes":{"type":"string"},"company_name":{"type":"string"},"tax_office":{"type":"string"},"tax_no":{"type":"string"},"e_bill_taxpayer":{"type":"boolean"},"is_corporate":{"type":"boolean"},"primary":{"type":"boolean"},"identity_number":{"type":"string"}}},"Country":{"type":"object","properties":{"pk":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string"}}},"City":{"type":"object","properties":{"pk":{"type":"integer"},"name":{"type":"string"}}},"Township":{"type":"object","properties":{"pk":{"type":"integer"},"name":{"type":"string"}}},"District":{"type":"object","properties":{"pk":{"type":"integer"},"name":{"type":"string"}}},"ShippingOptionDetail":{"type":"object","description":"Detailed shipping option with calculated amount","properties":{"pk":{"type":"integer"},"name":{"type":"string"},"slug":{"type":"string"},"logo":{"oneOf":[{"type":"string","format":"uri"},{"type":"null"}]},"shipping_amount":{"type":"string","pattern":"^\\d+\\.\\d{2}$"},"description":{"oneOf":[{"type":"string"},{"type":"null"}]},"kwargs":{"type":"object","additionalProperties":true}}},"PaymentOptionDetail":{"type":"object","description":"Detailed payment option with type information","properties":{"pk":{"type":"integer"},"name":{"type":"string"},"slug":{"type":"string"},"payment_type":{"type":"string","enum":["credit_card","funds_transfer","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","masterpass_rest","credit_payment","pay_later","saved_card","confirmation","b2b","wallet","pay_on_delivery"]},"payment_type_label":{"type":"string"}}},"Installment":{"type":"object","properties":{"pk":{"type":"integer"},"installment_count":{"type":"integer"},"label":{"type":"string"},"price_with_accrued_interest":{"type":"string","pattern":"^\\d+\\.\\d{2}$"},"monthly_price_with_accrued_interest":{"type":"string","pattern":"^\\d+\\.\\d{2}$"}}},"DeliveryOption":{"type":"object","properties":{"pk":{"type":"integer"},"name":{"type":"string"},"delivery_option_type":{"type":"string","enum":["customer","retail_store","pickup_location"]},"is_active":{"type":"boolean"}}},"RetailStore":{"type":"object","properties":{"pk":{"type":"integer"},"name":{"type":"string"},"erp_code":{"type":"string"},"township":{"$ref":"#/components/schemas/Township"},"click_and_collect":{"type":"boolean"},"is_active":{"type":"boolean"}}},"BankAccount":{"type":"object","description":"Bank account for funds transfer payments","properties":{"pk":{"type":"integer"},"bank_name":{"type":"string","description":"Name of the bank"},"account_holder":{"type":"string","description":"Account holder name"},"iban":{"type":"string","description":"International Bank Account Number"},"currency":{"type":"string","description":"Currency code (e.g., \"USD\", \"EUR\", \"TRY\")"},"is_active":{"type":"boolean"}}},"PaymentChoice":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"},"price":{"type":"string","pattern":"^\\d+\\.\\d{2}$"}}},"DataSourceShippingOptionDetail":{"type":"object","description":"Data source shipping option for multi-vendor shipping","properties":{"pk":{"type":"integer"},"shipping_amount":{"type":"string","pattern":"^\\d+\\.\\d{2}$"},"shipping_option_name":{"type":"string"},"shipping_option_logo":{"oneOf":[{"type":"string","format":"uri"},{"type":"null"}]},"data_source":{"type":"object","properties":{"pk":{"type":"integer"},"title":{"type":"string"}}},"description":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"PreOrderAttributeBasedShippingOption":{"type":"object","description":"Attribute-based shipping option selected for a product group","properties":{"pk":{"type":"integer"},"shipping_option_name":{"type":"string"},"shipping_option_logo":{"oneOf":[{"type":"string","format":"uri"},{"type":"null"}]},"shipping_amount":{"type":"string","pattern":"^\\d+\\.\\d{2}$"},"product_ids":{"type":"array","items":{"type":"integer"}},"attribute_value":{"type":"string"},"attribute_key":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://apidocs.akinon.com/commerce-openapis/checkout/payment-method-selection/get-payment-option-selection-page-context.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.