- Integration Guidelines
- Implementing a Merchant Organization API Integration
- Create or Update Merchant Organization
Create or Update Merchant Organization
Allows you to create a new Merchant Organization (MO) or update details for an existing MO that you own.
Creating a New MO
You must provide the following mandatory fields when you create a new MO using the Update Merchant Organization request:
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 to XYZBANK_ACME_ACCOUNTS.merchantOrganization.name: The legal name of the corporate entity for which this merchant organization was created.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.merchantOrganization.administrativePassword: The initial password for the merchant organization's administrative user.
It can only be set once and cannot be updated via the MO API. The administrative user will be prompted to change the password when logging into the Merchant Organization UI for the first time.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.merchantOrganization.parentMerchantOrganizations: The list of merchant organizations of which this merchant organization is a member.
Merchant Organization Details
Contact Details
User Details
Corporate Merchant Organization
Parent Merchant Organizations
Updating an MO
If you are updating an existing MO then you should:
- Use
Retrieve Merchant Organizationto retrieve the current details of the MO. - Make your updates to the retrieved details.
- Use
Update Merchant Organizationto provide complete details for the MO.
You can update all the MO details in a subsequent Update Merchant Organization request except the merchantOrganization.administrativePassword field.