Update Wallet Configuration

Operation to board or update a merchant's configuration with wallet providers.

POST https://gateway-japa.americanexpress.com/api/rest/version/35 / merchant / {merchantId} / walletConfiguration

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

URL Parameters

{merchantId} Alphanumeric + additional characters REQUIRED

The unique identifier issued to you by your payment provider.


This identifier can be up to 12 characters in length.


Data may consist of the characters 0-9, a-z, A-Z, '-', '_'

Min length: 1 Max length: 40

Fields

To view the optional fields, please toggle on the "Show optional fields" setting.

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.

Data can consist of any characters

Min length: 1 Max length: 100
walletProvider.masterpass OPTIONAL

Provide merchant configuration details for the MasterPass Wallet.

walletProvider.masterpass.address REQUIRED

Merchant's address

walletProvider.masterpass.address.city String REQUIRED

Merchant's city

Data can consist of any characters

Min length: 1 Max length: 25
walletProvider.masterpass.address.country String REQUIRED

Merchant's country.

ISO-3166-1 alpha-2 standard country associated with the merchant's address.

Data can consist of any characters

Min length: 2 Max length: 2
walletProvider.masterpass.address.postCode String OPTIONAL

Merchant's postal code

Data can consist of any characters

Min length: 0 Max length: 10
walletProvider.masterpass.address.state String OPTIONAL

Merchant's country subdivision.

ISO-3166-1 alpha-2 standard country and alpha-2 subdivision or province code e.g US-OH, AU-QL, associated with the address.

Data can consist of any characters

Min length: 0 Max length: 5
walletProvider.masterpass.address.street1 String REQUIRED

Merchant's address line 1

Data can consist of any characters

Min length: 1 Max length: 40
walletProvider.masterpass.address.street2 String OPTIONAL

Merchant's address line 2

Data can consist of any characters

Min length: 0 Max length: 40
walletProvider.masterpass.address.street3 String OPTIONAL

Merchant's address line 3

Data can consist of any characters

Min length: 0 Max length: 100
walletProvider.masterpass.business REQUIRED

Merchant's business details.

walletProvider.masterpass.business.category String OPTIONAL

Merchant goods description.

Data can consist of any characters

Min length: 0 Max length: 255
walletProvider.masterpass.business.email String OPTIONAL

Merchant's email address.

Data can consist of any characters

Min length: 0 Max length: 254
walletProvider.masterpass.business.federalTaxId String OPTIONAL

Merchant federal tax id.

Data can consist of any characters

Min length: 0 Max length: 100
walletProvider.masterpass.business.name String REQUIRED

Merchant business name.

Data can consist of any characters

Min length: 1 Max length: 255
walletProvider.masterpass.business.phone REQUIRED

Merchant's phone number.

walletProvider.masterpass.business.phone.countryCode String REQUIRED

Country code for the phone number.

Data can consist of any characters

Min length: 1 Max length: 10
walletProvider.masterpass.business.phone.number String REQUIRED

Merchant's phone number.

Data can consist of any characters

Min length: 3 Max length: 20
walletProvider.masterpass.business.tradingName String REQUIRED

Merchant trading name.

Data can consist of any characters

Min length: 1 Max length: 255
walletProvider.masterpass.business.webSiteUrl Url REQUIRED

The URL of the merchant's web site

Ensure that the URL begins with 'https' and is longer than 11 characters.

walletProvider.masterpass.checkoutBrand REQUIRED

Merchant's MasterPass wallet checkout brand details.

walletProvider.masterpass.checkoutBrand.checkoutProductionUrl Url REQUIRED

The URL of merchant production merchant website that will call the MasterPass wallet.

Ensure that the URL begins with 'https' and is longer than 11 characters.

walletProvider.masterpass.checkoutBrand.checkoutTestUrl Url REQUIRED

The URL of merchant test merchant website that will call the MasterPass wallet.

Ensure that the URL begins with 'https' and is longer than 11 characters.

walletProvider.masterpass.checkoutBrand.displayName String REQUIRED

The merchant's name that will display to payers for MasterPass interactions.

Data can consist of any characters

Min length: 1 Max length: 255
walletProvider.masterpass.checkoutBrand.logoUrl Url OPTIONAL

Merchant's store checkout logo URL.

Ensure that the URL begins with 'https' and is longer than 11 characters.

walletProvider.masterpass.checkoutBrand.name String REQUIRED

Name displayed on MasterPass site during checkout, when no logo is provided.

Data can consist of any characters

Min length: 1 Max length: 255
walletProvider.masterpass.checkoutIdentifier String OPTIONAL

Merchant ID or Client ID for MasterPass Wallet Provider.

Data can consist of any characters

Min length: 0 Max length: 255
walletProvider.masterpass.checkoutLevel Enumeration OPTIONAL

Merchant's checkout level with the MasterPass wallet provider.

Value must be a member of the following list. The values are case sensitive.

ADVANCED

3D secure authentication

STANDARD
walletProvider.masterpass.collectShippingAddressAtMasterPass Boolean OPTIONAL

If enabled, MasterPass will collect the payer's shipping address on the MasterPass website.

JSON boolean values 'true' or 'false'.

walletProvider.masterpass.locationId Enumeration OPTIONAL

The shipping location defines which countries merchant ship to and restricts the customer's shipping address selection in MasterPass accordingly.

Value must be a member of the following list. The values are case sensitive.

ANZ
Mexico
None
USOnly
walletProvider.masterpass.version Digits REQUIRED

The version used for optimistic locking.

Data is a number between 0 and 2147483647 represented as a string.

Response

Fields

To view the conditional fields, please toggle on the "Show conditional fields" setting.

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.

Data can consist of any characters

Min length: 1 Max length: 100
walletConfig String CONDITIONAL

The merchant's configuration at Wallet Provider.

Data can consist of any characters

Min length: 0 Max length: 2147483647

Errors

error

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

error.cause Enumeration

Broadly categorizes the cause of the error.

For example, errors may occur due to invalid requests or internal system failures.

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

Textual description of the error based on the cause.

This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.

Data can consist of any characters

Min length: 1 Max length: 1000
error.field String

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.

Data can consist of any characters

Min length: 1 Max length: 100
error.supportCode String

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.

Data can consist of any characters

Min length: 1 Max length: 100
error.validationType Enumeration

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.

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

A system-generated high level overall result of the operation.

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.