Skip to main content

Payment Strategy Related

This document covers all services for payment strategy related checkout to complete any chosen payment option, including the requests and responses associated with these services.

Send Funds Transfer Choice​

This method is used to notify the funds transfer choice (bank account) selected by the user.

The available bank accounts are listed within the PaymentOptionSelectionPage context following the selection of a payment option.

POST Send-Funds-Transfer-Choice

Path: https://{storefront_url}/orders/checkout/?page=FundsTransferChoicePage

Example Request​

{
    "bank_account": 1
}

Example Response​

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "FundsTransferPage",
            "page_slug": "fundstransferpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Complete Funds Transfer Payment​

This method is used to complete order with FundsTransfer payment type.

POST Complete-Funds-Transfer-Payment

Path: https://{storefront_url}/orders/checkout/?page=FundsTransferPage

Example Request​

{
    "agreement": true
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Complete Loyalty Money Payment​

This method is used to complete order with LoyaltyMoney payment type.

POST Complete-Loyalty-Money-Payment

Path: https://{storefront_url}/orders/checkout/?page=LoyaltyMoneyPage

Example Request​

{
    "agreement": true
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Complete Pay Later Payment​

This method is used to complete order with PayLater payment type.

POST Complete-Pay-Later-Payment

Path: https://{storefront_url}/orders/checkout/?page=PayLaterCompletePage

Example Request​

{
    "agreement": true
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Set Pay on Delivery Payment Choice​

This method is used to set payment choice for PayOnDelivery payment type.

POST Set-Pay-on-Delivery-Payment-Choice

Path: https://{storefront_url}/orders/checkout/?page=PayOnDeliveryPaymentChoicePage

Example Request​

{
    "payment_choice": "cash"
}

Example Response​

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "PayOnDeliveryPage",
            "page_slug": "payondeliverypage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Complete Pay on Delivery Payment​

This method is used to complete order with PayOnDelivery payment type.

POST Complete-Pay-on-Delivery-Payment

Path: https://{storefront_url}/orders/checkout/?page=PayOnDeliveryPage

Example Request​

{
    "agreement": true
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Start Redirection Payment​

This method is used to start redirection to 3rd party payment service.

POST Start-Redirection-Payment

Path: https://{storefront_url}/orders/checkout/?page=RedirectionPaymentSelectedPage

Example Request​

{
    "agreement": true
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "https://3rd-party-payment.com/pay/XASiso-daaskA12-1"
            },
            "page_name": "RedirectionPageCompletePage",
            "page_slug": "redirectionpagecompletepage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Complete Redirection Payment​

This method is used by 3rd party payment services in order to complete order.

POST Complete-Redirection-Payment

Path: https://{storefront_url}/orders/checkout/?page=RedirectionPageCompletePage

Example Request​

{
    ...
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Set Credit Payment Option on Credit Payment Type​

This method is used to set credit payment option for Credit payment type.

The available Credit Payment options are listed within the PaymentOptionSelectionPage context following the selection of a payment option.

POST Set-Credit-Payment-Option-on-Credit-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=CreditPaymentSelectionPage

Example Request​

{
    "credit_payment_option": 1
}

Example Response​

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

Start Redirection on Credit Payment​

This method is used to start redirection process on credit payment option for Credit payment type.

After the completion on the third-party application, user is redirected to the next page, which is called CreditPaymentCompletePage.

POST Start-Redirection-on-Credit-Payment

Path: https://{storefront_url}/orders/checkout/?page=CreditPaymentConfirmationPage

Example Request​

{
    "agreement": true
}

Example Response​

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

Complete Credit Payment Payment​

This method is used by 3rd party payment services in order to complete order.

POST Complete-Credit-Payment-Payment

Path: https://{storefront_url}/orders/checkout/?page=CreditPaymentCompletePage

Example Request​

{
    ...
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Start Cash Register Payment​

This method is used to start Cash Register Payment in stores with Akinon Instore application in order to generate barcode which will be used on payment process.

If the payment option configuration includes a setting called is_installment_active, the next page will be CashRegisterInstallmentSelectionPage; otherwise, it will be CashRegisterCompletePage.

POST Start-Cash-Register-Payment

Path: https://{storefront_url}/orders/checkout/?page=CashRegisterPage

Example Request​

{}

Example Response​

Response from CashRegisterInstallmentSelectionPage

{
    "context_list": [
        {
            "page_context": {
                "cards": [
                    {
                        "card_payment_type": "credit",
                        "installments": [
                            {
                                "pk": 1,
                                "installment_count": 1,
                                "label": "Advance",
                                "price_with_accrued_interest": 100,
                                "monthly_price_with_accrued_interest": 100
                            },
                            {
                                "pk": 2,
                                "installment_count": 3,
                                "label": "3 Installments",
                                "price_with_accrued_interest": 105,
                                "monthly_price_with_accrued_interest": 105
                            },
                        ],
                        "bank": {
                            "pk": 1,
                            "name": "Bank",
                            "slug": "bank",
                            "logo": "https://cdn-mgsm.akinon.net/card_types/2017/01/25/56dd552c-c769-4b3f-86f6-1f340bafa3c0.jpg"
                        }
                    }
                ]
            },
            "page_name": "CashRegisterInstallmentSelectionPage",
            "page_slug": "cashregisterinstallmentselectionpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Response from CashRegisterCompletePage

The client needs to generate an image from the barcode field, which is a base64 encoded string. The term number refers to the order number. Additionally, the client can utilize the seconds field to check the order's completion by using it as a request frequency.

{
    "context_list": [
        {
            "page_context": {
                "barcode": "iVBoAAAANSUhEUgAAAV4AAAEYCAIAAACbSAk8AAAI00lEQVR4nO3bXWiWdQPH8f....",
                "number": 9922111123321,
                "seconds": 5
            },
            "page_name": "CashRegisterCompletePage",
            "page_slug": "cashregistercompletepage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Set Installment Option on Cash Register Payment​

This method is used to set installment option on Cash Register Payment.

POST Set-Installment-Option-on-Cash-Register-Payment

Path: https://{storefront_url}/orders/checkout/?page=CashRegisterInstallmentSelectionPage

Example Request​

{
    "installment": 1
}

Example Response​

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "CashRegisterCompletePage",
            "page_slug": "cashregistercompletepage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Complete Cash Register Payment​

This method is used to complete Cash Register Payment.

POST Complete-Cash-Register-Payment

Path: https://{storefront_url}/orders/checkout/?page=CashRegisterCompletePage

Example Request​

{}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Start BKM Express Payment Type​

This method is used to start BKM Express payment type. The client opens a popup using the BKM Express JS Client Library, utilizing the data in the page context provided below.

POST Start-BKM-Express-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=BexSelectionPage

Example Request​

{}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "path": "https://api.bkmexpress.com.tr/v1/merchant/path/ticket?type=payment",
                "token": "ASDXX123123kaSDJAA",
                "transaction_id": "5b03cc8a2902ff2e3e7a8706cd3c033a"
            },
            "page_name": "BexBinNumberPage",
            "page_slug": "bexbinnumberpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Set Bin Number on BKM Express Payment Type​

This method is used to set bin_number for BKM Express Payment Type.

POST Set-Bin-Number-on-BKM-Express-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=BexBinNumberPage

Example Request​

{
    "bin_number": "665544"
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "installments": [
                    {
                        "pk": 1,
                        "installment_count": 1,
                        "label": "Advance",
                        "price_with_accrued_interest": 100,
                        "monthly_price_with_accrued_interest": 100
                    },
                    {
                        "pk": 2,
                        "installment_count": 3,
                        "label": "3 Installments",
                        "price_with_accrued_interest": 105,
                        "monthly_price_with_accrued_interest": 105
                    },
                    
                ],
                "card_type": {
                    "name": "Card Finans",
                    "slug": "card-finans",
                    "logo": "https://cdn-mgsm.akinon.net/card_types/2017/01/25/56dd552c-c769-4b3f-86f6-1f340bafa3c0.jpg"
                },
                "installment_messages": []
            },
            "page_name": "BexInstallmentSelectionPage",
            "page_slug": "bexinstallmentselectionpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Set Installment Option on BKM Express Payment Type​

This method is used to set an installment option for BKM Express Payment Type.

POST Set-Installment-Option-on-BKM-Express-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=BexInstallmentSelectionPage

Example Request​

{
    "installment": 3
}

Example Response​

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "BexNoncePage",
            "page_slug": "bexnoncepage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Bex Nonce Page on BKM Express Payment Type​

This method is used by BKM Express client.

POST Bex-Nonce-Page-on-BKM-Express-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=BexNoncePage

Example Request​

{
    "order_id": "123123asdasd",
    "transaction_id": "asdasdasdasdas",
    "data": {
        "status": "ok",
        "paymentPurchased": true
    }
}

Example Response​

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "BexCompletePage",
            "page_slug": "bexcompletepage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Complete BKM Express Payment Type​

This method is used to Complete BKM Express Payment Type.

POST Complete-BKM-Express-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=BexCompletePage

Example Request​

{}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Start Garanti Pay Payment​

This method is used to start Garanti Pay payment process.

POST Start-Garanti-Pay-Payment

Path: https://{storefront_url}/orders/checkout/?page=GPaySelectionPage

Example Request​

{}

Example Response​

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "GPayRedirectPage",
            "page_slug": "gpayredirectpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Start Redirection on Garanti Pay Payment​

This method is used to start redirection process on Garanti Pay payment type. The client needs to utilize the URL provided in the page context below to redirect to the Garanti Pay payment service page.

POST Start-Redirection-on-Garanti-Pay-Payment

Path: https://{storefront_url}/orders/checkout/?page=GPayRedirectPage

Example Request​

{}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "https://akinon-shop.com/orders/garanti-pay-redirect/"
            },
            "page_name": "GPayCompletePage",
            "page_slug": "gpaycompletepage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Complete Garanti Pay Payment​

This method is used by the Garanti Pay payment service, a third-party service, to complete the order.

POST Complete-Garanti-Pay-Payment

Path: https://{storefront_url}/orders/checkout/?page=GPayCompletePage

Example Request​

{
    "gpay": true,
    "success": true,
    "gpinstallment": "3"
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Start Confirmation Payment​

This method is used to start payment confirmation process.

POST Start-Confirmation-Payment

Path: https://{storefront_url}/orders/checkout/?page=ConfirmationPaymentAgreementCheckPage

During the checkout step, if the customer selects the "Paycell" payment method, the suitability of the customer's phone number for this payment method is checked. If the customer has not accepted the terms and conditions or if mobile payment is not enabled, the customer's approval is obtained, and the service is activated with their approval.

If the phone number is suitable for this payment method, an "OTP" verification code is sent to the customer via SMS. The customer enters the "OTP" verification code, which is then verified through the gateway. The payment process is finalized on the complete page.

The customer's phone number must always be suitable for this payment method. This page run the check_agreement to verify the suitability of the phone_number and determines the next page based on the status of the phone number. Additionally, if necessary, the terms and conditions will be displayed on this page.

If there is a configuration setting called agreement_required in the payment settings, the next page will be ConfirmationPaymentAgreementConfirmPage; otherwise, it will be ConfirmationPaymentSelectedPage.

Example Request​

{}

Example Response​

Response from ConfirmationPaymentAgreementConfirmPage

{
    "context_list": [
        {
            "page_context": {
                "terms_and_conditions": {...}
            },
            "page_name": "ConfirmationPaymentAgreementConfirmPage",
            "page_slug": "confirmationpaymentagreementconfirmpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Response from ConfirmationPaymentSelectedPage

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "ConfirmationPaymentSelectedPage",
            "page_slug": "confirmationpaymentselectedpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Agree Terms and Conditions on Confirmation Payment​

This method is used to agree terms and conditions for Confirmation Payment.

POST Agree-Terms-and-Conditions-on-Confirmation-Payment

Path: https://{storefront_url}/orders/checkout/?page=ConfirmationPaymentAgreementConfirmPage

Example Request​

{
    "agreement": true
}

Example Response​

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "ConfirmationPaymentSelectedPage",
            "page_slug": "confirmationpaymentselectedpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Continue on Confirmation Payment​

This method is used to validate user and user phone for Confirmation Payment option.

POST Continue-on-Confirmation-Payment

Path: https://{storefront_url}/orders/checkout/?page=ConfirmationPaymentSelectedPage

Example Request​

{
    "agreement": true
}

Example Response​

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "ConfirmationPaymentQueryPage",
            "page_slug": "confirmationpaymentquerypage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Confirmation Query on Confirmation Payment​

This method is used to query payment gateway with OTP or token.

POST Confirmation-Query-on-Confirmation-Payment

Path: https://{storefront_url}/orders/checkout/?page=ConfirmationPaymentQueryPage

The query page validates the OTP code that is sent via SMS and expects the OTP code as a parameter. However, the required inputs may vary depending on the payment gateway configured for this payment type.

Example Request​

{
    "otp": "5544"
}

Example Response​

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "ConfirmationPaymentCompletePage",
            "page_slug": "confirmationpaymentcompletepage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Complete Confirmation Payment​

This method is used to complete Confirmation Payment.

POST Complete-Confirmation-Payment

Path: https://{storefront_url}/orders/checkout/?page=ConfirmationPaymentCompletePage

Example Request​

{}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Fetch Saved Cards to Start Saved Cards Payment Type​

This method is used to fetch customer's saved cards.

GET Fetch-Saved-Cards-to-Start-Saved-Cards-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=ConfirmationPaymentCompletePage

Example Request​

GET Request

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "cards": [
                    "name": "My Visa Card",
                    "masked_card_number": "5555 55** **** **92",
                    "token": "my-visa-card"
                ]
            },
            "page_name": "SavedCardSelectionPage",
            "page_slug": "savedcardselectionpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Set Saved Card on Saved Card Payment Type​

This method is used to set card on Saved Card Payment Type.

POST Set-Saved-Card-on-Saved-Card-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=SavedCardSelectionPage

Example Request​

{
    "card": "my-visa-card"
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "installments": [
                    {
                        "pk": 1,
                        "installment_count": 1,
                        "label": "Advance",
                        "price_with_accrued_interest": 100,
                        "monthly_price_with_accrued_interest": 100
                    },
                    {
                        "pk": 2,
                        "installment_count": 3,
                        "label": "3 Installments",
                        "price_with_accrued_interest": 105,
                        "monthly_price_with_accrued_interest": 105
                    },
                ],
                "card_type": {
                    "name": "Card Finans",
                    "slug": "card-finans",
                    "logo": "https://cdn-mgsm.akinon.net/card_types/2017/01/25/56dd552c-c769-4b3f-86f6-1f340bafa3c0.jpg"
                },
                "installment_messages": []
            },
            "page_name": "SavedCardInstallmentSelectionPage",
            "page_slug": "savedcardinstallmentselectionpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Set Installment Option on Saved Card Payment Type​

This method is used to set installment option on Saved Card Payment Type.

POST Set-Installment-Option-on-Saved-Card-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=SavedCardInstallmentSelectionPage

Example Request​

{
    "installment": 1
}

Example Response​

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "SavedCardConfirmationPage",
            "page_slug": "savedcardconfirmationpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Complete Saved Card Payment Type​

This method is used to complete Saved Card Payment Type.

POST Complete-Saved-Card-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=SavedCardConfirmationPage

Example Request​

{
    "agreement": true
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Start Masterpass Payment Type​

This method is used to start Masterpass Payment Type.

POST Start Masterpass Payment Type

Path: https://{storefront_url}/orders/checkout/?page=MasterpassBinNumberPage

Example Request​

{
    "is_masterpass_stored_card": true,
    "bin_number": "665544"
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "installments": [
                    {
                        "pk": 1,
                        "installment_count": 1,
                        "label": "Advance",
                        "price_with_accrued_interest": 100,
                        "monthly_price_with_accrued_interest": 100
                    },
                    {
                        "pk": 2,
                        "installment_count": 3,
                        "label": "3 Installments",
                        "price_with_accrued_interest": 105,
                        "monthly_price_with_accrued_interest": 105
                    },
                ],
                "card_type": {
                    "name": "Card Finans",
                    "slug": "card-finans",
                    "logo": "https://cdn-mgsm.akinon.net/card_types/2017/01/25/56dd552c-c769-4b3f-86f6-1f340bafa3c0.jpg"
                },
                "installment_messages": []
            },
            "page_name": "MasterpassInstallmentPage",
            "page_slug": "masterpassinstallmentpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Set Installment on Masterpass Payment Type​

This method is used to set installment option on Masterpass Payment Type.

POST Set-Installment-on-Masterpass-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=MasterpassInstallmentPage

Example Request​

{
    "installment": 1
}

Example Response​

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "MasterpassOrderNoPage",
            "page_slug": "masterpassordernopage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Continue on Masterpass Payment Type​

This method is used to continue on Masterpass Payment Type.

POST Continue-on-Masterpass-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=MasterpassOrderNoPage

Example Request​

{}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "msisdn": "...",
                "order_no": "...",
                "token": "...",
                "direct_token": "...",
                "three_d": true,
                "extras": {...},
            },
            "page_name": "MasterpassCompletePage",
            "page_slug": "masterpasscompletepage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Continue on Masterpass Payment Type​

This method is used to complete Masterpass Payment Type by Masterpass 3rd party service.

POST Continue-on-Masterpass-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=MasterpassCompletePage

Example Request​

{...}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Start MobilExpress Payment Type​

This method is used to fetch saved cards on MobilExpress according to the clear parameter.

Based on the configuration, the next page can be one of the following: MobilExpressCardFoundOtpRequiredPhonePage or MobilExpressCardListPage.

POST Start-MobilExpress-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=MobilExpressSelectionPage

Example Request​

{
    "clear": false
}

Response from MobilExpressCardFoundOtpRequiredPhonePage

{
    "context_list": [
        {
            "page_context": {
                "phone_number": "5554443322"
            },
            "page_name": "MobilExpressCardFoundOtpRequiredPhonePage",
            "page_slug": "mobilexpresscardfoundotprequiredphonepage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Response from MobilExpressCardListPage

{
    "context_list": [
        {
            "page_context": {
                "cards": [
                    {
                        "cardId": "6f08f86f-0343-4e9e-a3e2-656a3facf79b",
                        "maskedCardNo": "454671******7894",
                        "alias": "MAXIMUM",
                        "cardBrand": "MAXIMUM",
                        "isDefault": true,
                        "isExpired": false,
                        "showEulaId": false,
                        "isThreeDValidated": true,
                        "isOTPValidated": false,
                        "activationDate": "2020-11-02 22:08:55",
                        "cardType": "Credit"
                    }
                ]
            },
            "page_name": "MobilExpressCardListPage",
            "page_slug": "mobilexpresscardlistpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Phone Number Validation on MobilExpress Payment Type​

This method is used to validate phone number on MobilExpress payment type.

POST Phone-Number-Validation-on-MobilExpress-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=MobilExpressCardFoundOtpRequiredPhonePage

Example Request​

{
    "phone_number": "5554443322"
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "phone_number": "5554443322"
            },
            "page_name": "MobilExpressCardFoundOtpRequiredOtpPage",
            "page_slug": "mobilexpresscardfoundotprequiredotppage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Continue on Phone Number Validation on MobilExpress Payment Type​

This method is used to validate phone number with OTP code on MobilExpress payment type.

POST Continue-on-Phone-Number-Validation-on-MobilExpress-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=MobilExpressCardFoundOtpRequiredOtpPage

Example Request​

{
    "otp": "5432"
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "cards": [
                    {
                        "cardId": "6f08f86f-0343-4e9e-a3e2-656a3facf79b",
                        "maskedCardNo": "454671******7894",
                        "alias": "MAXIMUM",
                        "cardBrand": "MAXIMUM",
                        "isDefault": true,
                        "isExpired": false,
                        "showEulaId": false,
                        "isThreeDValidated": true,
                        "isOTPValidated": false,
                        "activationDate": "2020-11-02 22:08:55",
                        "cardType": "Credit"
                    }
                ]
            },
            "page_name": "MobilExpressCardListPage",
            "page_slug": "mobilexpresscardlistpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Set card on MobilExpress Payment Type​

This method is used to set card on MobilExpress payment type.

POST Set-Card-on-MobilExpress-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=MobilExpressCardFoundOtpRequiredOtpPage

Example Request​

{
    "card_token": "asddasdada",
    "masked_card_number": "454671******7894"
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "installments": [
                    {
                        "pk": 1,
                        "installment_count": 1,
                        "label": "Advance",
                        "price_with_accrued_interest": 100,
                        "monthly_price_with_accrued_interest": 100
                    },
                    {
                        "pk": 2,
                        "installment_count": 3,
                        "label": "3 Installments",
                        "price_with_accrued_interest": 105,
                        "monthly_price_with_accrued_interest": 105
                    },
                    
                ],
                "installment_messages": []
            },
            "page_name": "MobilExpressInstallmentSelectionPage",
            "page_slug": "mobilexpressinstallmentselectionpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Set Installment Option on MobilExpress Payment Type​

This method is used to set Installment Option on MobilExpress payment type.

POST Set-Installment-Option-on-MobilExpress-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=MobilExpressInstallmentSelectionPage

Example Request​

{
    "installment": 1
}

Example Response​

{
    "context_list": [
        {
            "page_context": {},
            "page_name": "MobilExpressTryPaymentPage",
            "page_slug": "mobilexpresstrypaymentpage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}

Complete MobilExpress Payment Type​

This method is used to complete MobilExpress payment type.

POST Complete-MobilExpress-Payment-Type

Path: https://{storefront_url}/orders/checkout/?page=MobilExpressTryPaymentPage

Example Request​

{
    "agreement": true
}

Example Response​

{
    "context_list": [
        {
            "page_context": {
                "redirect_url": "/orders/completed/IjcwMjExMjMyMTA5MTci:1mRByT:tTgDsJbIKXyxJZyIZwHIBqtShvw/",
                "order_id": 303,
                "new_user": false,
                "token": "138ddd19a0436166354cccbacb4cbb0473104193",
                "campaigns": []
            },
            "page_name": "ThankYouPage",
            "page_slug": "thankyoupage"
        }
    ],
    "template_name": "orders/checkout.html",
    "errors": null,
    "pre_order": {...}
}