Retrieve Merchant Organization
This allows you to retrieve details for merchant organizations on the gateway that you own.
To successfully retrieve a merchant organization's configuration details, you must provide the identifier:
- For your MSO on the gateway.
- For the merchant organization on the gateway.
The Retrieve Merchant Organization operation allows you to retrieve all MO details that you've supplied in the Create or Update Merchant Organization operation in addition to the following details:
merchantOrganization.childMerchantOrganizations:A comma separated list of merchant organizations, which are direct members of this merchant organization.
merchantOrganization.childMerchants:A comma separated list of merchants, which are direct children of this merchant organization.
merchantOrganizationRelationships[n]:The list of relationships between any merchant organizations for the full merchant organization structure that includes this merchant organization. The list contains details about both the parent and the child within the relationship. If you set the
includeMerchantsfield in the request to INCLUDE then the list also includes all relationships between any merchant organizations and merchants.
Retrieve Merchant Organization API Reference[REST][NVP]
Example: Retrieve Merchant Organization
Request
| URL | https://gateway-emea.americanexpress.com/api/rest/version/100/mso/{msoId}/merchantOrganization/{merchantOrganizationId} |
| HTTP method | GET |
Response
{
"merchantOrganization": {
"address": {
"city": "Beverly Hills",
"countryCode": "USA",
"postcode": "90201",
"state": "CA",
"street1": "123 Example St"
},
"contactName": "Test Merchant",
"contactNameAlternative": "John C Brown",
"description": "Acme Pty Ltd",
"email": "abc@test.com",
"emailAlternative": "abc@xyz.com",
"id": "MO2",
"name": "Test Merchant Organization",
"phone": "3143212522",
"phoneAlternative": "+61 712345987",
"parentMerchantOrganizations": "100000012",
"childMerchantOrganizations": "100000014,100000015,100000016",
"childMerchants": "TEST12345,TEST123456",
"merchantOrganizationRelationships": [
{
"parentId": "ACME_MSO",
"parentType": "MSO",
"childId": "100000012",
"childType": "MERCHANT_ORGANIZATION",
"childName": "ACME_HQ"
},
{
"parentId": "ACME_MSO",
"parentType": "MSO",
"childId": "MO_JV_ID",
"childType": "MERCHANT_ORGANIZATION",
"childName": "MO_JV"
},
{
"parentId": "100000012",
"parentType": "MERCHANT_ORGANIZATION",
"parentName": "ACME_HQ",
"childId": "100000013",
"childType": "MERCHANT_ORGANIZATION",
"childName": "ACME_ACCOUNTS"
},
{
"parentId": "MO_JV_ID",
"parentType": "MERCHANT_ORGANIZATION",
"parentName": "MO_JV",
"childId": "MO_Runner_ID",
"childType": "MERCHANT_ORGANIZATION",
"childName": "MO_Runner"
},
{
"parentId": "100000013",
"parentType": "MERCHANT_ORGANIZATION",
"parentName": "ACME_ACCOUNTS",
"childId": "100000014",
"childType": "MERCHANT_ORGANIZATION",
"childName": "ACME_ACCOUNTS_QLD"
},
{
"parentId": "100000013",
"parentType": "MERCHANT_ORGANIZATION",
"parentName": "ACME_ACCOUNTS",
"childId": "100000015",
"childType": "MERCHANT_ORGANIZATION",
"childName": "ACME_ACCOUNTS_NSW"
},
{
"parentId": "100000013",
"parentType": "MERCHANT_ORGANIZATION",
"parentName": "ACME_ACCOUNTS",
"childId": "100000016",
"childType": "MERCHANT_ORGANIZATION",
"childName": "ACME_ACCOUNTS_VIC"
},
{
"parentId": "100000013",
"parentType": "MERCHANT_ORGANIZATION",
"parentName": "ACME_ACCOUNTS",
"childId": "TEST12345",
"childType": "MERCHANT",
"childName": "ACME_REFUNDS"
},
{
"parentId": "100000013",
"parentType": "MERCHANT_ORGANIZATION",
"parentName": "ACME_ACCOUNTS",
"childId": "TEST123456",
"childType": "MERCHANT",
"childName": "Runner"
}
],
"result": "SUCCESS"
}
}