Akinon Release Notes (06/09/2025) are now live! Click here to learn what's new.
LogoLogo
API Reference
  • Home
  • Quick Start
  • Tutorials
  • Technical Guides
  • Release Notes
  • Glossary
  • Welcome to Akinon Technical Guides
  • ACC
    • ACC CLI
    • Create Application via CLI
    • Deploy Environment Variables
    • App Store for Developers
  • Omnitron
    • Product Types
    • Product Categorization
    • Splitting a Merged Order Item
  • Commerce
    • Shipping Rules Calculator
    • Data Source Shipping Options
    • Attribute Based Shipping Options
    • Filtering Products
    • Conversation & Messages
    • Sitemap Configuration
    • Weight-Based Product Sales
    • Group Attribute Sets
    • Contract Management
    • Find in Store for Whippy Ware
    • Plugins
    • Remote Price
    • E-mail Templates
    • Loyalty Accounts
    • Search Structure
    • User Segmentation & Rules
    • Configuring User Segmentation
    • Promotions
    • Email Redirection in Multi-Frontend Structure
  • OMS
    • Getting Started with OMS
    • Basic Setup
    • Scenarios
    • Capacity Feature
    • Package Management
      • Packages
      • Transfer
      • States
    • Commands
      • Packages
        • Package Command Parameters
        • DeAllocate Package Reservations Command
        • Channel Based Complete Packaging without Shipment Command
        • Complete Packaging with Shipment Command
        • Complete Packaging without Shipment Command
        • Package Refuse with Denial Reason Command
        • Product Not Found & Wrong Product Command
        • Product Not Found & Wrong Product Command Advanced
        • Package Packed for Refund Command
        • Block The Package For Action Command
        • Unblock the Package For Action Command
        • Update The Package’s Invoice
        • Manual Planning Command
      • Transfer
        • Transfer Order Advanced Command
        • Product for Transfer Not Found & Wrong Product Command
        • Transfer Delivered Command
        • Transfer Dispatch Command
        • Transfer Ready for Dispatch Command
        • Transfer Out Of Stock
      • Shipment
        • Shipment Order Command
        • Package Advanced Shipment Command
        • Ship The Package Command
        • Ship The Package without Shipment Integration Command
        • Update The Package’s Shipment Status Command
        • Update Shipment Info of Package Command
    • Inventory Locations & Engine
      • Properties & Domain Relation
      • Customization
      • Inventory Engine
    • Fulfillment
      • Shipments
      • Invoice Integration
    • Webhooks
      • Webhook Examples
        • Order Webhook
        • Package Webhook
        • Shipment Webhook
        • Stock Location Webhook
        • Transfer Webhook
    • Integrating OMS with Seller Center
  • Instore
    • Getting Started
    • Cash Register Integration
    • OTP (One Time Password) Process
    • Services
      • Password Reset Services
  • Marketplace Dashboard
    • N11 Marketplace Setup Configurations
    • Trendyol Marketplace Setup Configurations
    • Walmart Marketplace Setup Configurations
    • Amazon Marketplace Setup Configurations
    • Hepsiburada Marketplace Setup Configurations
    • Fashfed Marketplace Setup Configurations
    • Mono Marketplace Setup Configurations
    • Passo Marketplace Setup Configurations
    • Package Splitting Flow
    • Marketplace Dashboard Flow Trigger
  • Project Zero
    • Django
      • Basic Setup
      • Project Structure
        • Templates & Components
        • Private Dependencies
        • Omnife Project Submodule
        • Webpack
        • ESLint Rules
        • Bundles
        • Multilanguage & Translation
        • Environmental File
        • Custom Error Pages
        • Icon Font
      • Page Types
        • Static Pages & Flatpages
        • Account Page
          • Template Rendering in Account Pages
          • Forms & Validation
        • Basket Page
          • Redux Basket State
          • Basket Page - View
        • Checkout
          • Redux Checkout State
          • View & Template Rendering
          • Masking & Validation
      • Theming & Styling
      • Widgets
      • SEO Management
      • Extending Project Zero
    • Next.js
      • Basic Setup
      • Deployment
      • Static Assets
      • Widgets
      • Icons
      • Localization
      • SEO Management
      • Advanced Usage
      • Plugins
        • Akifast
        • B2B
        • Basket Gift Package
        • BKM Express
        • Checkout Gift Package
        • Click&Collect
        • Credit Payment
        • GarantiPay
        • Hepsipay
        • Masterpass
        • Multi Basket
        • One Click Checkout
        • OTP
        • Pay on Delivery
        • Saved Card
        • Tabby Payment Gateway
        • Tamara Payment Gateway
      • Data Fetching
        • Client
          • Account
          • Address
          • Basket
          • Checkout
          • Misc
          • Product
          • User
          • Wishlist
        • Server
          • Category
          • Flat Page
          • List
          • Menu
          • Product
          • SEO
          • Special Page
          • Widget
  • App Maker
    • Setup Your Environment
    • Plugin Quickstart
    • Create Project
    • Setup Existing Project
    • Deploy Project
    • Users and Roles
    • Add Public Key
    • App Maker CLI
    • Create App on Stores
      • Creating App on Apple App Store
      • Creating App on Google Play Store
    • Mobile App Framework
      • Configuration
      • Framework
      • Project Structure
        • Structure
        • Data Containers
        • Pages
      • Dependency Integration
        • Plugins
        • Akinon Plugin Adapter
  • Akifast
    • HPP
      • Getting Started
      • Authorization
      • Payment Session Creation
        • Key Points Before Creating a Payment Session
        • Creating Payment Session
        • Redirecting to the Payment Page
        • Errors Encountered During Payment Session Creation
      • Merchant Services
        • Shipping Query URL
        • Agreement Query URL
        • Other URLs
  • B2B
    • Getting Started
    • B2B Setup
  • Adds-on
    • Invoicer
      • Introduction
      • Invoice & Pay On Delivery Service
  • Channel App Template
    • Introduction
    • Installation and Usage
    • Development Steps
      • Folder Structure
      • Starting Step
      • Encoding the Sales Channel
        • Introduction
        • Setup
        • Products
        • Product Price
        • Product Stock
        • Product Image
        • Orders
        • Product Data
      • Adding a New Command to Akinon
      • Listening for External Requests
    • Architecture
      • Introduction
      • Integration
      • Services (Flows)
        • Introduction
        • Product Service
        • Price Service
        • Stock Service
        • Image Service
        • Order Service
  • Multi Regional Settings
    • Multi Regional Settings
  • 3rd Party Integration
    • NKolay POS Payment Integration
    • ShipX (Inpost) Shipment Extension
    • Checkout Flow Integration
    • Ngenius Payment Integration
    • ShypV Shipment Extension
    • Masterpass via Craftgate POS
    • Benefit via Tap
    • Tap Credit Card
    • PayU Payment Extension
    • Pay with Iyzico Payment Extension
    • Multisafepay Payment Extension
    • Masterpass Installment Integration
    • Masterpass Iframe Extension
    • Mollie Payment Extension
    • Masterpass Rest POS
    • Masterpass Rest Payment Option
    • Yoomoney Payment Extension
    • MyFatoorah Payment Installation
    • Checkout Payment Extension
    • CyberSource Credit Card Integration
    • QNBPay Integration
    • KNET Payment Integration
    • MNG Seller Pays Shipment Extension
    • Porter Express Shipment Extension
    • Akbank Installation
    • Fero AI Shipment Extension
    • Horoz Lojistik Satıcı Öder Shipment Extension
    • Kolay Gelsin Shipment Extension
    • Falcon Flex Shipment Extension
    • Tap Saved Card Installation
    • NAPS QPay via Tap Installation
    • Tamara Payment Extension
    • Paywall Payment Integration
    • Horoz Lojistik Shipment Extension
    • Monist Shipment Extension
    • Sipay Integration
    • Nestpay Integration
Powered by GitBook

© 2025 Akinon. All rights reserved.

On this page
  • Omnitron Settings
  • Payment Options
  • Token Services and Init Payments
  • Masterpass Rest Token
  • Masterpass via Craftgate Rest Token
  • Masterpass via Craftgate 3D Init
  • Pages
  • Start Masterpass Rest Payment Type
  • Set Installment on Masterpass Rest Payment Type
  • Continue on Masterpass Rest Payment Type
  • Continue on Masterpass Rest Payment Type
  • Additional Notes

Was this helpful?

  1. 3rd Party Integration

Masterpass Rest Payment Option

Omnitron Settings

Payment Options

One payment option must be defined in Omnitron to be specific for the extension installed. Explanations on how the settings should be made at this stage are in the table below.

Field
Description

Payment Option

Masterpass Rest

Payment Option Name

Masterpass Rest

Payment Option Slug

mp_rest

Config

{ “pos_slug”: “mp_rest”, "provision_enabled": true/false }

Token Services and Init Payments

Masterpass Rest Token

This method is used to get Masterpass Bearer Token. It should be used after PaymentOptionSelectionPage. If three_d is false or isn’t provided, pos’es “Three d enabled” value will be used.

GET
https://{{commerce_url}}/orders/masterpass-rest-token?three_d=true|false&msisdn_validated=true|false

Example Response

{
    "msisdn": "...",
    "token": "Bearer...",
    "extras": {
        "bank_ica": null
    }
}

Masterpass via Craftgate Rest Token

This method is used to get Masterpass Bearer Token from Craftgate. It should be used after PaymentOptionSelectionPage to list saved cards. It uses 123456 for bin_number and 1 for installment_count*.* After MasterpassRestOrderNoPage, it uses customers bin_number and installment_count. So, the token must be requested again.

Example request flow:

  • PaymentOptionSelectionPage

  • Get token from Craftgate

  • MasterpassRestBinNumberPage

  • MasterpassRestInstallmentPage

  • MasterpassRestOrderNoPage

  • Get token from Craftgate again

  • MasterpassRestCompletePage

GET
https://{{commerce_url}}/orders/craftgate-masterpass-token?three_d=true|false

Example Response

{
    "msisdn": "...",
    "token": "Bearer...",
    "referenceId": "...",
    "orderNo": "...",
    "extras": {
        "bank_ica": null
    }
}

Masterpass via Craftgate 3D Init

Also, if the payment is 3D, init service must be called before the payment. You can get more details from Craftgate

GET
https://{{commerce_url}}/orders/craftgate-masterpass-init?reference_id=...

Example Response

{
    "paymentId": ...,
    "returnUrl": "https://...",
}

Pages

Start Masterpass Rest Payment Type

This method is used to start Masterpass Rest Payment Type.

POST
https://{{commerce_url}}/orders/checkout/?page=MasterpassRestBinNumberPage

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": "MasterpassRestInstallmentPage",
        	"page_slug": "masterpassrestinstallmentpage"
    	}
	],
	"template_name": "orders/checkout.html",
	"errors": null,
	"pre_order": {}
}

Set Installment on Masterpass Rest Payment Type

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

POST
https://{{commerce_url}}/orders/checkout/?page=MasterpassRestInstallmentPage

Example Request


{
	"installment": 1
}

Example Response

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

Continue on Masterpass Rest Payment Type

This method is used to continue on Masterpass Rest Payment Type.

POST
https://{{commerce_url}}/orders/checkout/?page=MasterpassRestOrderNoPage

Example Request


{
	"use_three_d": true
}

Example Response

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

Continue on Masterpass Rest Payment Type

This method is used to continue on Masterpass Rest Payment Type.

transactionType values:

  • DIRECT_PURCHASE

  • DIRECT_PURCHASE_3D

  • PURCHASE

  • PURCHASE_3D

  • REGISTER_AND_PURCHASE

  • REGISTER_AND_PURCHASE_3D

POST https://{{commerce_url}}/orders/checkout/?page=MasterpassRestCompletePage&responseCode={{responseCode}}&token={{token}}&three_d_secure={{true/false}}

Example Request for Masterpass POS


{
	"token": "...",
	"transactionType": "...",
	...
}

Example Request for Craftgate POS


{
	"token": "...", // Non-3D
	"referenceId": "...", // Non-3D
	"paymentId": "...", // 3D
...
}

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": {...}
}

Additional Notes

  • Postman Collection

PreviousMasterpass Rest POSNextYoomoney Payment Extension

Last updated 3 days ago

Was this helpful?