Update Merchant Amex Express Checkout Configuration

Operation to board or update a merchant's configuration in Amex Express Checkout.

POST https://mcb.gateway.mastercard.com/api/rest/version/33 / merchant / {merchantId} / amexExpressCheckoutConfiguration

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.

amexMerchantConfig OPTIONAL

The merchant's Amex Express Checkout configuration.

amexMerchantConfig.acceptedCards[n] Enumeration REQUIRED

The major credit card types that are accepted by this particular Merchant.

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

AMEX
MASTERCARD
VISA
amexMerchantConfig.amexMerchantId String OPTIONAL

Amex Merchant Id or Client id of Amex Merchant.

Data can consist of any characters

Min length: 0 Max length: 36
amexMerchantConfig.businessContact REQUIRED

Primary business contact.

amexMerchantConfig.businessContact.email String OPTIONAL

Primary contact email.

Data can consist of any characters

Min length: 0 Max length: 254
amexMerchantConfig.businessContact.fax String OPTIONAL

Primary contact fax.

Data can consist of any characters

Min length: 0 Max length: 24
amexMerchantConfig.businessContact.firstName String REQUIRED

Primary first name.

Data can consist of any characters

Min length: 0 Max length: 50
amexMerchantConfig.businessContact.lastName String REQUIRED

Primary last name.

Data can consist of any characters

Min length: 0 Max length: 50
amexMerchantConfig.businessContact.phone String REQUIRED

Primary contact phone number.

Data can consist of any characters

Min length: 0 Max length: 24
amexMerchantConfig.businessName String REQUIRED

Name of Merchant.

Data can consist of any characters

Min length: 0 Max length: 120
amexMerchantConfig.callbackProdURL Url OPTIONAL

The Production URL the browser will be redirected to by Amex Express Checkout based on successful customer login and card selection.

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

amexMerchantConfig.callbackQAURL Url OPTIONAL

The QA URL the browser will be redirected to by Amex Express Checkout based on successful customer login and card selection.

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

amexMerchantConfig.cartProviderName String OPTIONAL

Name of eCommerce shopping cart provider.

Data can consist of any characters

Min length: 0 Max length: 100
amexMerchantConfig.currencyCode Upper case alphabetic text REQUIRED

The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.

Data must consist of the characters A-Z

Min length: 3 Max length: 3
amexMerchantConfig.defaultSENO String REQUIRED

Default AMEX Service Establishment number (sometimes referred to as Merchant Numbers or MIDs).

Used to register with Safekey ACS.

Data can consist of any characters

Min length: 0 Max length: 15
amexMerchantConfig.errorCallbackProdURL Url OPTIONAL

The Prod URL the browser will be redirected to by Amex Express Checkout in case of an error.

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

amexMerchantConfig.errorCallbackQAURL Url OPTIONAL

The QA URL the browser will be redirected to by Amex Express Checkout in case of an error.

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

amexMerchantConfig.gmtOffsetKey Digits REQUIRED

Identifier for the Time Zone offset from Greenwich Mean Time.

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

amexMerchantConfig.mcMerchantID String OPTIONAL

Used to register with MCSC ACS.

Required only if Secure Code enabled

Data can consist of any characters

Min length: 0 Max length: 19
amexMerchantConfig.merchantAddress REQUIRED

Merchant's address

amexMerchantConfig.merchantAddress.city String REQUIRED

City

Data can consist of any characters

Min length: 0 Max length: 50
amexMerchantConfig.merchantAddress.country String REQUIRED

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

Data can consist of any characters

Min length: 0 Max length: 2
amexMerchantConfig.merchantAddress.line1 String REQUIRED

First line of the merchant's address

Data can consist of any characters

Min length: 0 Max length: 200
amexMerchantConfig.merchantAddress.line2 String OPTIONAL

Second line of the merchant's address

Data can consist of any characters

Min length: 0 Max length: 200
amexMerchantConfig.merchantAddress.phone String REQUIRED

Merchant's Contact Phone number.

Data can consist of any characters

Min length: 0 Max length: 24
amexMerchantConfig.merchantAddress.postalCode String REQUIRED

Postal code associated with the merchant's address.

Data can consist of any characters

Min length: 0 Max length: 20
amexMerchantConfig.merchantAddress.state String REQUIRED

State or province code associated with the address.

Data can consist of any characters

Min length: 0 Max length: 50
amexMerchantConfig.qaURL Url OPTIONAL

The QA URL of the store.

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

amexMerchantConfig.safeKeyAcquirerBin String OPTIONAL

TODO Text not defined in User Story

Data can consist of any characters

Min length: 0 Max length: 20
amexMerchantConfig.safeKeyEnabled String REQUIRED

Indicator if the merchant is SafeKey enabled.

Data can consist of any characters

Min length: 0 Max length: 1
amexMerchantConfig.seNumbers[n] Digits OPTIONAL

Full list of AMEX Service Establishment numbers (sometimes referred to as Merchant Numbers or MIDs) used by Merchant.

You can provide up to 200 SE Numbers in json format.

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

amexMerchantConfig.secureCodeEnabled String REQUIRED

Indicator if the merchant is SecureCode enabled.

Data can consist of any characters

Min length: 1 Max length: 1
amexMerchantConfig.shipToCountries[n] Upper case alphabetic text OPTIONAL

A list of ISO 3166-Alpha 2 country codes where shipping is acceptable.

Data must consist of the characters A-Z

Min length: 2 Max length: 2
amexMerchantConfig.shippingMethod[n] Enumeration OPTIONAL

The method(s) of shipping allowed for the transaction.

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

DOWNLOAD
SHIP
STORE
amexMerchantConfig.storeURL Url REQUIRED

The Production URL of the store.

The merchant's store homepage in Production.

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

amexMerchantConfig.techContact REQUIRED

Primary technical contact.

amexMerchantConfig.techContact.email String OPTIONAL

Primary contact email.

Data can consist of any characters

Min length: 0 Max length: 254
amexMerchantConfig.techContact.fax String OPTIONAL

Primary contact fax.

Data can consist of any characters

Min length: 0 Max length: 24
amexMerchantConfig.techContact.firstName String REQUIRED

Primary first name.

Data can consist of any characters

Min length: 0 Max length: 50
amexMerchantConfig.techContact.lastName String REQUIRED

Primary last name.

Data can consist of any characters

Min length: 0 Max length: 50
amexMerchantConfig.techContact.phone String REQUIRED

Primary contact phone number.

Data can consist of any characters

Min length: 0 Max length: 24
amexMerchantConfig.verifiedByVisaEnabled String REQUIRED

Indicator if merchant is Verified by VISA enabled.

Data can consist of any characters

Min length: 0 Max length: 1
amexMerchantConfig.version Digits REQUIRED

The version used for optimistic locking.

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

amexMerchantConfig.visaMerchantID String OPTIONAL

Used to register with VBV ACS.

Required only if Verified By Visa enabled

Data can consist of any characters

Min length: 0 Max length: 19
amexMerchantConfig.websiteURL Url REQUIRED

Merchant's store website.

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

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

Response

Fields

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

amexMerchantConfig String CONDITIONAL

The merchant's configuration in Amex Express Checkout.

Data can consist of any characters

Min length: 0 Max length: 2147483647
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

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.