- Integration Guidelines
- Integrating the Merchant Boarding API
- Update Merchant Payment Details
- Enabling Masterpass
Enabling Masterpass
To enable Masterpass, simply provide the following field in the Update Merchant Payment Details or Create or Update request:
The Create or Update Merchant operation is only supported from version 63 onwards.
- merchant.masterPassOnline.checkoutIdentifier: A unique identifier generated by Masterpass when creating a merchant account in Masterpass.
Optionally, you can configure the following fields for Masterpass:
- merchant.masterPassOnline.collectShippingAddressAtMasterPassOnline: If enabled, Masterpass will collect the payer's shipping address at the Masterpass website. The merchant can then obtain the shipping address through the transaction response or via the Order and Transaction Details page in merchantUI.
If disabled, the merchant can choose to collect the shipping address on their website or bypass the shipping address, for example, for digitals goods. - merchant.masterPassOnline.consumerKey: A key generated by Masterpass when creating the merchant account. This is the consumer key associated with the merchant’s production profile.
- merchant.masterPassOnline.sandboxConsumerKey: A key generated by Masterpass when creating the merchant account. This is the consumer key associated with the merchant’s sandbox profile.
- merchant.masterPassOnline.shippingLocationId: An identifier defining the locations the merchant ships to.
If provided, the location ID restricts the customer's selection of shipping address in Masterpass to the defined locations for all Masterpass transactions. If set to None, Masterpass Online uses the preferred shipping profile configured against the merchant's Masterpass Online profile.