Create or Update Merchant Organization
This allows you to create a new Merchant Organization or update details for an existing Merchant Organization that you own.
Creating a new Merchant Organization
You must provide the following mandatory fields when you create a new Merchant Organization using the Update Merchant Organization request:
Merchant Organization details
merchantOrganization.id: A unique identifier for the merchant organization on the gateway. You must use a prefix to identify this merchant organization. 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 the id toXYZBANK_ACME_ACCOUNTS.merchantOrganization.name: The legal name of the corporate entity for which this merchant organization was created.
Contact details
merchantOrganization.contactName: The name of the primary contact person for this merchant organization.merchantOrganization.email: The email address of the primary contact person for this merchant organization.merchantOrganization.address.*: The address of the primary contact person for this merchant organization.merchantOrganization.phone: The phone number for the primary contact person in ITU-T E123 format, for example +1 607 1234 5678.
User details
merchantOrganization.administrativePassword: The initial password for the merchant organization's administrative user.
It can only be set once and cannot be updated via the Merchant Organization API. The administrative user will be prompted to change the password when logging into the Merchant Organization UI for the first time.
Corporate Merchant Organization
merchantOrganization.authority: Set the value of this field to "CORPORATE" to define this merchant organization as the authoritative owner of the data of merchant(s) that will be assigned to this merchant organization. A corporate merchant organization represents the top of the hierarchy for a legal entity. Assigning the merchant to a corporate merchant organization ensures that you do not accidentally assign a merchant to a merchant organization that belongs to a different legal entity. Note that you cannot assign any parent merchant organizations to a corporate merchant organization.
Parent Merchant Organizations
merchantOrganization.parentMerchantOrganizations: The list of merchant organizations of which this merchant organization is a member.
Updating an Merchant Organization
If you are updating an existing Merchant Organization then you should:
- Use
Retrieve Merchant Organizationto retrieve the current details of the Merchant Organization. - Make your updates to the retrieved details.
- Use
Update Merchant Organizationto provide complete details for the Merchant Organization.
You can update all the Merchant Organization details in a subsequent
Update Merchant Organization request except the merchantOrganization.administrativePassword field.Create or Update Merchant Organization[REST][NVP]
Example: Update Merchant Organization
Request
| URL | https://suncorp.gateway.mastercard.com/api/rest/version/100/mso/{msoId} |
| HTTP method | PUT |
{
"apiOperation": "UPDATE_MERCHANT_ORGANIZATION",
"correlationId": "TestCorrId",
"merchantOrganization": {
"id": "TEST_MERCHANT2",
"name": "Acme Pty Ltd2",
"description": "View of all merchant profiles for Acme2.",
"address": {
"street1": "300 Big Street2",
"city": "Littletown2",
"state": "NSW",
"postcode": "E12345",
"countryCode": "AUS"
},
"contactName": "Mary B Smith",
"phone": "+61 7123 4567 5990",
"email": "mary.smith@acm.com",
"contactNameAlternative": "John C Brown",
"phoneAlternative": "+61 712345987",
"emailAlternative": "john.brown@acme.com",
"authority":"CORPORATE",
"parentMerchantOrganizations": "100000012",
"administrativePassword": "ABCDEFG123"
}
}
Response
{
"correlationId": "TestCorrId",
"result": "SUCCESS"
}