Mastercard Payment Gateway API Reference: Operations -
Version 70,
Protocol: REST-JSON

Retrieve Wallet Options

Request to retrieve information from the payer's wallet before the checkout page is presented so that you can streamline the checkout process. For example, the wallet may return details about the payer's shipping address and masked card numbers that you can use to display on checkout pages.

For the MasterPass wallet, provide the Long Access Token for a paired wallet to retrieve information about that wallet.

For more information on pairing see - MasterPass Pairing

URL https://na.gateway.mastercard.com/api/rest/version/70/merchant/{merchantId}/walletOptions
HTTP Method POST
Authentication This operation requires authentication via one of the following methods:
  • Certificate authentication.
  • Basic HTTP authentication as described at w3.org. Provide 'merchant.<your gateway merchant ID>' in the userid portion and your API password in the password portion.

Request Parameters

order   = COMPULSORY

order
Fixed value

order.walletProvider  Enumeration = COMPULSORY

Select the wallet provider for this interaction.
Existence
COMPULSORY
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
AMEX_EXPRESS_CHECKOUT
Amex Express Checkout wallet provider.
APPLE_PAY
Apple Pay mobile wallet provider.
CHASE_PAY
Chase Pay wallet provider.
GOOGLE_PAY
Google Pay mobile wallet provider.
MASTERPASS_ONLINE
MasterPass Online wallet provider.
SAMSUNG_PAY
Samsung Pay mobile wallet provider.
VISA_CHECKOUT
Visa Checkout wallet provider.

wallet.masterpass.longAccessToken  String = COMPULSORY

A wallet token provided by the gateway for Masterpass paired accounts.
Save this token and use it in the Retrieve Wallet Options request to obtain pre-checkout data from the payer's wallet for future interactions.
Existence
COMPULSORY
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

correlationId  String = OPTIONAL

A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Existence
OPTIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100

order   = COMPULSORY

order
Fixed value

order.walletProvider  Enumeration = COMPULSORY

Select the wallet provider for this interaction.
Existence
COMPULSORY
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
AMEX_EXPRESS_CHECKOUT
Amex Express Checkout wallet provider.
APPLE_PAY
Apple Pay mobile wallet provider.
CHASE_PAY
Chase Pay wallet provider.
GOOGLE_PAY
Google Pay mobile wallet provider.
MASTERPASS_ONLINE
MasterPass Online wallet provider.
SAMSUNG_PAY
Samsung Pay mobile wallet provider.
VISA_CHECKOUT
Visa Checkout wallet provider.

wallet.masterpass.longAccessToken  String = COMPULSORY

A wallet token provided by the gateway for Masterpass paired accounts.
Save this token and use it in the Retrieve Wallet Options request to obtain pre-checkout data from the payer's wallet for future interactions.
Existence
COMPULSORY
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

{merchantId}  Alphanumeric + additional characters COMPULSORY

The unique identifier issued to you by your payment provider.
Existence
COMPULSORY
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
40

Response Parameters

merchant  Alphanumeric + additional characters = Always Provided

The unique identifier issued to you by your payment provider.
Existence
Always Provided
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
JSON type
String
minimum length
1
maximum length
40

result  Enumeration = Always Provided

A system-generated high level overall result of the operation.
Existence
Always Provided
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
ERROR
ERROR
SUCCESS
SUCCESS

wallet.masterpass   = CONDITIONAL

Details of the MasterPass wallet.
Fixed value

wallet.masterpass.longAccessToken  String = CONDITIONAL

A wallet token provided by the gateway for Masterpass paired accounts.
Provide this token to obtain pre-checkout data from the payer's wallet for future interactions.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.masterpassLogoUrl  Url = CONDITIONAL

The Url for the MasterPass logo.
Display the image near the pre-checkout data in order to comply with MasterPass branding requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
Ensure that the URL begins with 'https' and is longer than 11 characters.
JSON type
String

wallet.masterpass.precheckoutData   = CONDITIONAL

Information obtained from the payer's paired wallet.
Present this pre-checkout data to the payer during the checkout process to streamline the MasterPass interaction.
Fixed value

wallet.masterpass.precheckoutData.billing.address.country  String = CONDITIONAL

The 3 letter ISO standard alpha country code of the payer's address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
3
maximum length
3

wallet.masterpass.precheckoutData.card[n]   = CONDITIONAL

Information about the cards in the payer's MasterPass wallet.
Present these cards to the payer during the checkout process so they may choose which card to pay with.
Fixed value

wallet.masterpass.precheckoutData.card[n].alias  String = CONDITIONAL

The name the payer gave to the card.
Display this to the payer along with the card data, so they know which card they are selecting.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
50

wallet.masterpass.precheckoutData.card[n].brand  Enumeration = CONDITIONAL

The brand name used to describe the card that is recognized and accepted globally.
Existence
CONDITIONAL
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
AMEX
American Express
CHINA_UNIONPAY
China UnionPay
DINERS_CLUB
Diners Club
DISCOVER
Discover
JCB
JCB (Japan Credit Bureau)
LOCAL_BRAND_ONLY
The card does not have a global brand.
MAESTRO
Maestro
MASTERCARD
MasterCard
RUPAY
RuPay
UATP
UATP (Universal Air Travel Plan)
UNKNOWN
The brand of the card used in the transaction could not be identified
VISA
Visa

wallet.masterpass.precheckoutData.card[n].default  Boolean = CONDITIONAL

The payer-preferred card for payment.
If this value is TRUE, present this card as selected by default.
Existence
CONDITIONAL
Fixed value
Validation Rules
JSON boolean values 'true' or 'false'.
JSON type
Boolean

wallet.masterpass.precheckoutData.card[n].expiry   = CONDITIONAL

Expiry date, as shown on the card.
Fixed value

wallet.masterpass.precheckoutData.card[n].expiry.month  Digits = CONDITIONAL

Month, as shown on the card.
Months are numbered January=1, through to December=12.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a number between 1 and 12 represented as a string.
JSON type
String

wallet.masterpass.precheckoutData.card[n].expiry.year  Digits = CONDITIONAL

Year, as shown on the card.
The Common Era year is 2000 plus this value.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
JSON type
String
minimum length
2
maximum length
2

wallet.masterpass.precheckoutData.card[n].masterpassCardId  String = CONDITIONAL

The MasterPass identifier for the card.
Provide this value to MasterPass in the cardId parameter when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.card[n].nameOnCard  String = CONDITIONAL

The cardholder's name as printed on the card.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.card[n].number  String = CONDITIONAL

The masked card number.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
20

wallet.masterpass.precheckoutData.consumerWalletId  String = CONDITIONAL

The MasterPass identifier for the payer's wallet.
Provide this value to MasterPass when you initiate a 'Connected Checkout' or 'Express Checkout' interaction for this wallet.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
50

wallet.masterpass.precheckoutData.customer.email  String = CONDITIONAL

The payer's email address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.customer.firstName  String = CONDITIONAL

The payer's first name.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.customer.lastName  String = CONDITIONAL

The payer's last name or surname.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.customer.phone  String = CONDITIONAL

The payer's telephone number.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.precheckoutTransactionId  String = CONDITIONAL

A MasterPass transaction identifier.
Provide this value to MasterPass when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
50

wallet.masterpass.precheckoutData.shippingAddress[n]   = CONDITIONAL

Information about the shipping addresses contained in the payer's MasterPass wallet.
Present these shipping addresses to the payer during the checkout process to streamline the MasterPass interaction.
Fixed value

wallet.masterpass.precheckoutData.shippingAddress[n].address   = CONDITIONAL

Address to ship the goods to.
Fixed value

wallet.masterpass.precheckoutData.shippingAddress[n].address.alias  String = CONDITIONAL

The name the payer gave to the shipping address.
Display this to the payer along with the shipping address data, so they know which shipping address they are selecting.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].address.city  String = CONDITIONAL

The city portion of the shipping address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].address.country  String = CONDITIONAL

The 3 letter ISO standard alpha country code of the shipping address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
3
maximum length
3

wallet.masterpass.precheckoutData.shippingAddress[n].address.default  Boolean = CONDITIONAL

The payer-preferred shipping address for payment.
If this value is TRUE, present this shipping address as the initially-selected one.
Existence
CONDITIONAL
Fixed value
Validation Rules
JSON boolean values 'true' or 'false'.
JSON type
Boolean

wallet.masterpass.precheckoutData.shippingAddress[n].address.masterpassShippingId  String = CONDITIONAL

The MasterPass identifier for the shipping address.
Provide this value to MasterPass in the shippingId parameter when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].address.postcodeZip  String = CONDITIONAL

The post code or zip code of the shipping address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].address.stateProvince  String = CONDITIONAL

The state or province of the shipping address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].address.street  String = CONDITIONAL

The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].address.street2  String = CONDITIONAL

The second line of the address (if provided).
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].contact   = CONDITIONAL

The contact details for the person residing at this address.
Fixed value

wallet.masterpass.precheckoutData.shippingAddress[n].contact.firstName  String = CONDITIONAL

The first name of the person the goods are being shipped to.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].contact.lastName  String = CONDITIONAL

The last name or surname of the person the goods are being shipped to.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].contact.phone  String = CONDITIONAL

The telephone number of the person the goods are being shipped to.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.walletName  String = CONDITIONAL

The name the payer has assigned to their MasterPass wallet.
Display this name to the payer during the checkout process, so they know which wallet is being used for the payment interaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
50

wallet.masterpass.walletPartnerLogoUrl  Url = CONDITIONAL

The Url for the Wallet partner logo.
Display the image near the pre-checkout data in order to comply with MasterPass branding requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
Ensure that the URL begins with 'https' and is longer than 11 characters.
JSON type
String

correlationId  String = CONDITIONAL

A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100

merchant  Alphanumeric + additional characters = Always Provided

The unique identifier issued to you by your payment provider.
Existence
Always Provided
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
JSON type
String
minimum length
1
maximum length
40

result  Enumeration = Always Provided

A system-generated high level overall result of the operation.
Existence
Always Provided
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
ERROR
ERROR
SUCCESS
SUCCESS

wallet.masterpass   = CONDITIONAL

Details of the MasterPass wallet.
Fixed value

wallet.masterpass.longAccessToken  String = CONDITIONAL

A wallet token provided by the gateway for Masterpass paired accounts.
Provide this token to obtain pre-checkout data from the payer's wallet for future interactions.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.masterpassLogoUrl  Url = CONDITIONAL

The Url for the MasterPass logo.
Display the image near the pre-checkout data in order to comply with MasterPass branding requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
Ensure that the URL begins with 'https' and is longer than 11 characters.
JSON type
String

wallet.masterpass.precheckoutData   = CONDITIONAL

Information obtained from the payer's paired wallet.
Present this pre-checkout data to the payer during the checkout process to streamline the MasterPass interaction.
Fixed value

wallet.masterpass.precheckoutData.billing.address.country  String = CONDITIONAL

The 3 letter ISO standard alpha country code of the payer's address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
3
maximum length
3

wallet.masterpass.precheckoutData.card[n]   = CONDITIONAL

Information about the cards in the payer's MasterPass wallet.
Present these cards to the payer during the checkout process so they may choose which card to pay with.
Fixed value

wallet.masterpass.precheckoutData.card[n].alias  String = CONDITIONAL

The name the payer gave to the card.
Display this to the payer along with the card data, so they know which card they are selecting.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
50

wallet.masterpass.precheckoutData.card[n].brand  Enumeration = CONDITIONAL

The brand name used to describe the card that is recognized and accepted globally.
Existence
CONDITIONAL
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
AMEX
American Express
CHINA_UNIONPAY
China UnionPay
DINERS_CLUB
Diners Club
DISCOVER
Discover
JCB
JCB (Japan Credit Bureau)
LOCAL_BRAND_ONLY
The card does not have a global brand.
MAESTRO
Maestro
MASTERCARD
MasterCard
RUPAY
RuPay
UATP
UATP (Universal Air Travel Plan)
UNKNOWN
The brand of the card used in the transaction could not be identified
VISA
Visa

wallet.masterpass.precheckoutData.card[n].default  Boolean = CONDITIONAL

The payer-preferred card for payment.
If this value is TRUE, present this card as selected by default.
Existence
CONDITIONAL
Fixed value
Validation Rules
JSON boolean values 'true' or 'false'.
JSON type
Boolean

wallet.masterpass.precheckoutData.card[n].expiry   = CONDITIONAL

Expiry date, as shown on the card.
Fixed value

wallet.masterpass.precheckoutData.card[n].expiry.month  Digits = CONDITIONAL

Month, as shown on the card.
Months are numbered January=1, through to December=12.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a number between 1 and 12 represented as a string.
JSON type
String

wallet.masterpass.precheckoutData.card[n].expiry.year  Digits = CONDITIONAL

Year, as shown on the card.
The Common Era year is 2000 plus this value.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
JSON type
String
minimum length
2
maximum length
2

wallet.masterpass.precheckoutData.card[n].masterpassCardId  String = CONDITIONAL

The MasterPass identifier for the card.
Provide this value to MasterPass in the cardId parameter when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.card[n].nameOnCard  String = CONDITIONAL

The cardholder's name as printed on the card.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.card[n].number  String = CONDITIONAL

The masked card number.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
20

wallet.masterpass.precheckoutData.consumerWalletId  String = CONDITIONAL

The MasterPass identifier for the payer's wallet.
Provide this value to MasterPass when you initiate a 'Connected Checkout' or 'Express Checkout' interaction for this wallet.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
50

wallet.masterpass.precheckoutData.customer.email  String = CONDITIONAL

The payer's email address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.customer.firstName  String = CONDITIONAL

The payer's first name.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.customer.lastName  String = CONDITIONAL

The payer's last name or surname.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.customer.phone  String = CONDITIONAL

The payer's telephone number.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.precheckoutTransactionId  String = CONDITIONAL

A MasterPass transaction identifier.
Provide this value to MasterPass when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
50

wallet.masterpass.precheckoutData.shippingAddress[n]   = CONDITIONAL

Information about the shipping addresses contained in the payer's MasterPass wallet.
Present these shipping addresses to the payer during the checkout process to streamline the MasterPass interaction.
Fixed value

wallet.masterpass.precheckoutData.shippingAddress[n].address   = CONDITIONAL

Address to ship the goods to.
Fixed value

wallet.masterpass.precheckoutData.shippingAddress[n].address.alias  String = CONDITIONAL

The name the payer gave to the shipping address.
Display this to the payer along with the shipping address data, so they know which shipping address they are selecting.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].address.city  String = CONDITIONAL

The city portion of the shipping address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].address.country  String = CONDITIONAL

The 3 letter ISO standard alpha country code of the shipping address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
3
maximum length
3

wallet.masterpass.precheckoutData.shippingAddress[n].address.default  Boolean = CONDITIONAL

The payer-preferred shipping address for payment.
If this value is TRUE, present this shipping address as the initially-selected one.
Existence
CONDITIONAL
Fixed value
Validation Rules
JSON boolean values 'true' or 'false'.
JSON type
Boolean

wallet.masterpass.precheckoutData.shippingAddress[n].address.masterpassShippingId  String = CONDITIONAL

The MasterPass identifier for the shipping address.
Provide this value to MasterPass in the shippingId parameter when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].address.postcodeZip  String = CONDITIONAL

The post code or zip code of the shipping address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].address.stateProvince  String = CONDITIONAL

The state or province of the shipping address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].address.street  String = CONDITIONAL

The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].address.street2  String = CONDITIONAL

The second line of the address (if provided).
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].contact   = CONDITIONAL

The contact details for the person residing at this address.
Fixed value

wallet.masterpass.precheckoutData.shippingAddress[n].contact.firstName  String = CONDITIONAL

The first name of the person the goods are being shipped to.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].contact.lastName  String = CONDITIONAL

The last name or surname of the person the goods are being shipped to.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.shippingAddress[n].contact.phone  String = CONDITIONAL

The telephone number of the person the goods are being shipped to.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
255

wallet.masterpass.precheckoutData.walletName  String = CONDITIONAL

The name the payer has assigned to their MasterPass wallet.
Display this name to the payer during the checkout process, so they know which wallet is being used for the payment interaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
50

wallet.masterpass.walletPartnerLogoUrl  Url = CONDITIONAL

The Url for the Wallet partner logo.
Display the image near the pre-checkout data in order to comply with MasterPass branding requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
Ensure that the URL begins with 'https' and is longer than 11 characters.
JSON type
String

error   = CONDITIONAL

Information on possible error conditions that may occur while processing an operation using the API.
Fixed value

error.cause  Enumeration = CONDITIONAL

Broadly categorizes the cause of the error.
For example, errors may occur due to invalid requests or internal system failures.
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
INVALID_REQUEST
The request was rejected because it did not conform to the API protocol.
REQUEST_REJECTED
The request was rejected due to security reasons such as firewall rules, expired certificate, etc.
SERVER_BUSY
The server did not have enough resources to process the request at the moment.
SERVER_FAILED
There was an internal system failure.

error.explanation  String = CONDITIONAL

Textual description of the error based on the cause.
This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
1000

error.field  String = CONDITIONAL

Indicates the name of the field that failed validation.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
100

error.supportCode  String = CONDITIONAL

Indicates the code that helps the support team to quickly identify the exact cause of the error.
This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
100

error.validationType  Enumeration = CONDITIONAL

Indicates the type of field validation error.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
INVALID
The request contained a field with a value that did not pass validation.
MISSING
The request was missing a mandatory field.
UNSUPPORTED
The request contained a field that is unsupported.

result  Enumeration = CONDITIONAL

A system-generated high level overall result of the operation.
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
ERROR
The operation resulted in an error and hence cannot be processed.

Copyright © 2023 Mastercard