Update Merchant Amex Express Checkout Configuration
Operation to board or update a merchant's configuration in Amex Express Checkout.
Authentication Copied to clipboard
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 Copied to clipboard
URL Parameters Copied to clipboard
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: 40Fields Copied to clipboard
To view the optional fields, please toggle on the "Show optional fields" setting.
The merchant's Amex Express Checkout configuration.
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
String
OPTIONAL
Amex Merchant Id or Client id of Amex Merchant.
Data can consist of any characters
Primary business contact.
String
OPTIONAL
Primary contact email.
Data can consist of any characters
String
OPTIONAL
Primary contact fax.
Data can consist of any characters
String
REQUIRED
Primary first name.
Data can consist of any characters
String
REQUIRED
Primary last name.
Data can consist of any characters
String
REQUIRED
Primary contact phone number.
Data can consist of any characters
String
REQUIRED
Name of Merchant.
Data can consist of any characters
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.
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.
String
OPTIONAL
Name of eCommerce shopping cart provider.
Data can consist of any characters
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
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
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.
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.
Digits
REQUIRED
Identifier for the Time Zone offset from Greenwich Mean Time.
Data is a number between 0 and 999 represented as a string.
String
OPTIONAL
Used to register with MCSC ACS.
Required only if Secure Code enabled
Data can consist of any characters
Merchant's address
String
REQUIRED
City
Data can consist of any characters
String
REQUIRED
ISO-3166-1 alpha-2 standard country associated with the merchant's address.
Data can consist of any characters
String
REQUIRED
First line of the merchant's address
Data can consist of any characters
String
OPTIONAL
Second line of the merchant's address
Data can consist of any characters
String
REQUIRED
Merchant's Contact Phone number.
Data can consist of any characters
String
REQUIRED
Postal code associated with the merchant's address.
Data can consist of any characters
String
REQUIRED
State or province code associated with the address.
Data can consist of any characters
Url
OPTIONAL
The QA URL of the store.
Ensure that the URL begins with 'https' and is longer than 11 characters.
String
OPTIONAL
TODO Text not defined in User Story
Data can consist of any characters
String
REQUIRED
Indicator if the merchant is SafeKey enabled.
Data can consist of any characters
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.
String
REQUIRED
Indicator if the merchant is SecureCode enabled.
Data can consist of any characters
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
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
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.
Primary technical contact.
String
OPTIONAL
Primary contact email.
Data can consist of any characters
String
OPTIONAL
Primary contact fax.
Data can consist of any characters
String
REQUIRED
Primary first name.
Data can consist of any characters
String
REQUIRED
Primary last name.
Data can consist of any characters
String
REQUIRED
Primary contact phone number.
Data can consist of any characters
String
REQUIRED
Indicator if merchant is Verified by VISA enabled.
Data can consist of any characters
Digits
REQUIRED
The version used for optimistic locking.
Data is a number between 0 and 2147483647 represented as a string.
String
OPTIONAL
Used to register with VBV ACS.
Required only if Verified By Visa enabled
Data can consist of any characters
Url
REQUIRED
Merchant's store website.
Ensure that the URL begins with 'https' and is longer than 11 characters.
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
Response Copied to clipboard
Fields Copied to clipboard
To view the conditional fields, please toggle on the "Show conditional fields" setting.
String
CONDITIONAL
The merchant's configuration in Amex Express Checkout.
Data can consist of any characters
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
Errors Copied to clipboard
Information on possible error conditions that may occur while processing an operation using the API.
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.
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
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
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
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.
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.