Retrieve Merchant Organization

Request to retrieve a merchant organization.

GET https://gateway-na.americanexpress.com/api/rest/version/57 / mso / {msoId} / merchantOrganization / {merchantOrganizationId} / showChildren / {responseControl}

Authentication

This operation requires authentication via one of the following methods:


  • Certificate authentication.
  • Basic HTTP authentication as described at w3.org. Provide 'MSO.<your gateway MSO ID>' in the userid portion and your API password in the password portion.

Request

URL Parameters

{msoId} Alphanumeric + additional characters REQUIRED

The identifier that uniquely identifies you or an MSO that has authorized you to use this operation on their behalf.


Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.'

Min length: 1 Max length: 16
{merchantOrganizationId} Alphanumeric + additional characters REQUIRED

The unique identifier of the merchant organization on the gateway.The identifier must use a prefix assigned to you by your payment service provider.


For example, if you have been assigned the prefix 'XYZBANK', and you are creating the 'account department' merchant organization for Acme corp, you could set merchantOrganization to XYZBANK_ACCOUNTS.


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

Min length: 1 Max length: 16
{responseControl} Alpha + additional characters REQUIRED

Set this value if you want a list of this merchant organization's child merchant organizations returned in the response.


Possible values are NONE or MERCHANT_ORGANIZATIONS. When set to NONE, no child merchant organization information will be returned. Note: setting this value to MERCHANT_ORGANIZATIONS may significantly slow the response.


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

Min length: 3 Max length: 23

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

Response

Fields

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
merchantOrganization ALWAYS PROVIDED

The merchant organization details.

merchantOrganization.address ALWAYS PROVIDED

The address of the primary contact person for this merchant organization.

merchantOrganization.address.city String ALWAYS PROVIDED

The city or town of the street address.

Data can consist of any characters

Min length: 1 Max length: 30
merchantOrganization.address.countryCode Upper case alphabetic text ALWAYS PROVIDED

The 3 letter ISO standard alpha country code of the address.

Data must consist of the characters A-Z

Min length: 3 Max length: 3
merchantOrganization.address.postcode String ALWAYS PROVIDED

The post code or zip code of the address.

Data can consist of any characters

Min length: 1 Max length: 16
merchantOrganization.address.state String ALWAYS PROVIDED

The state or province of the address in a form recognized for postal delivery.

Data can consist of any characters

Min length: 1 Max length: 30
merchantOrganization.address.street1 String ALWAYS PROVIDED

The first line of the street address.

Data can consist of any characters

Min length: 1 Max length: 40
merchantOrganization.address.street2 String CONDITIONAL

An optional second line of the street address.

Data can consist of any characters

Min length: 1 Max length: 40
merchantOrganization.childMerchantOrganizations[n] Alphanumeric + additional characters CONDITIONAL

The list of merchants which are direct members of this merchant organization.

This value is provided only if you set the value for responseControls.showChildren to ALL.

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

Min length: 1 Max length: 16
merchantOrganization.contactName String ALWAYS PROVIDED

The name of the primary contact person for this merchant organization.

Data can consist of any characters

Min length: 1 Max length: 100
merchantOrganization.contactNameAlternative String CONDITIONAL

The name of a contact person for this merchant organization, in case where the primary contact is unavailable.

Data can consist of any characters

Min length: 1 Max length: 100
merchantOrganization.description String CONDITIONAL

A textual description of the business purpose for which this merchant organization is used.

For example, 'Acme East Asia accounts department'.

Data can consist of any characters

Min length: 1 Max length: 200
merchantOrganization.email Email ALWAYS PROVIDED

The email address of the primary contact person for this merchant organization.

The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.

Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses

merchantOrganization.emailAlternative Email CONDITIONAL

The email address of the alternative contact person for this merchant organization.

The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.

Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses

merchantOrganization.id Alphanumeric + additional characters ALWAYS PROVIDED

The unique identifier of the merchant organization on the gateway.The identifier must use a prefix assigned to you by your payment service provider.

For example, if you have been assigned the prefix 'XYZBANK', and you are creating the 'account department' merchant organization for Acme corp, you could set merchantOrganization to XYZBANK_ACCOUNTS.

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

Min length: 1 Max length: 16
merchantOrganization.name String ALWAYS PROVIDED

The legal name of the corporate entity for which this merchant organization was created.

For example, Acme Holdings Pty Ltd.

Data can consist of any characters

Min length: 1 Max length: 100
merchantOrganization.parentMerchantOrganizations[n] Alphanumeric + additional characters CONDITIONAL

The list of merchant organizations of which this merchant organization is a member.

If this field is present on an Update Merchant Organization request, any existing parent merchant organizations will be replaced with this set. If this field is absent: when updating a merchant organization, the existing set will be retained. when creating a new merchant organization, there will be no parent merchant organizations.

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

Min length: 1 Max length: 16
merchantOrganization.phone Telephone Number ALWAYS PROVIDED

The phone number for the primary contact person in ITU-T E123 format, for example +1 607 1234 5678.

The number consists of: '+' country code (1, 2 or 3 digits) 'space' national number ( which may embed single spaces characters for readability).

Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)

Mandatory country code: true Max total digits: 15
merchantOrganization.phoneAlternative Telephone Number CONDITIONAL

The phone number for a alternative contact person in ITU-T E123 format, for example +1 607 1234 5678.

The number consists of: '+' country code (1, 2 or 3 digits) 'space' national number ( which may embed single spaces characters for readability).

Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)

Mandatory country code: true Max total digits: 15
result Enumeration ALWAYS PROVIDED

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

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

FAILURE

The operation was declined or rejected by the gateway, acquirer or issuer

PENDING

The operation is currently in progress or pending processing

SUCCESS

The operation was successfully processed

UNKNOWN

The result of the operation is unknown

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.

Resources

Glossary FAQs