Account entity
The Account entity is used to collect merchant-specific information, such as company, name registration, address, etc., and transfer it to the uP POM. The table below captures the Account entity’s required fields.
The Account entity is the main entity of the merchant onboarding API.
Some field values are case sensitive. These field will be denoted with an * for clarity.
Field Name | Value | Description | Type |
---|---|---|---|
name | Company ABC | The operating name that the merchant is doing business under. | Mandatory |
description | Sells computers and other electronic devices. | Short description of what the business does. | Mandatory |
source | Client reseller | Identifies that the merchant is being onboarded to the uP POM by a client reseller. Should always send “Client reseller”. * Case sensitive submission | Mandatory |
referredById | 63d96bc13a5e9d951 | Your uP POM referred by ID (this will be provided to you during your client onboarding process). | Mandatory |
referredByType | Account | Identifies that the reseller client referrer is an account on our system. Should always send “Account”. * Case sensitive submission | Mandatory |
accountType | Indirect | Identifies that the merchant is an indirect customer of NomuPay’s; the direct relationship lies with you, the reseller client. Should always send “Indirect”. * Case sensitive submission | Mandatory |
accountSubtype | merchant | Further clarifies that the Indirect Customer being onboarded is a merchant. Should always send “Merchant”. * Case sensitive submission | Mandatory |
contractingEntity | NOMU PAY HONG KONG LIMITED | The NomuPay entity that the merchant has entered into a contract with. Options are: • NOMU PAY HONG KONG LIMITED • NOMU PAY MALAYSIA SDN. BHD. • NOMU PAY E-MONEY PHILIPPINES, INC. • NOMU PAY (THAILAND) CO., LTD. • NOMU PAY SINGAPORE PTE. LTD. • NOMU PAY ÖDEME VE ELEKTRONIK PARA HIZMETLERI A.Ş • NOMU PAY LIMITED • NOMU PAY EUROPE (PAYFAC) • NOMU PAY EUROPE (ACQUIRING) NomuPay will confirm the contracting entity during the onboarding process. * Case sensitive submission | Mandatory |
fundingCurrency | HKD | Currency that the merchant will accept funds in into their bank account. Currency 3 letter code ISO 4217-Alpha 3. * Case sensitive submission | Mandatory |
legalName | Company ABC Ltd. | The proper legal name under which the merchant’s business is licensed. | Mandatory |
refundPolicy | www.companyabc.com/refund-policy | The URL for the merchant’s Refund Policy. The refund policy should outline in which circumstances the merchant will refund a consumer for a purchase. | Mandatory |
yearsInBusiness | 12 | The number of years the merchant has legally been in business. * Numerical digits only | Mandatory |
companyType | Corporate | Legal structure of the merchant’s business. Options are: • Sole Proprietor • Corporate • Partnership • Financial Institution • Public Listed Company • Government Linked Company • NGO • Other * Case sensitive submission | Mandatory |
registrationCountry | HK | Country 2 letter code ISO 3166-1 Alpha 2. * Case sensitive submission | Mandatory – except for when companyType is “Sole Proprietor” |
registrationNumber | 1234567 | merchant’s registration number. *Numerical digits only | Mandatory – except for when companyType is “Sole Proprietor” |
registrationDate | YYYY-MM-DD | Year, month, date that the merchant’s business wasregistered. *Date must be formatted as shown in the Value column | Mandatory – except for when companyType is “Sole Proprietor” |
numberOfUBOs | 1 | Number of Ultimate Beneficial Owner(s) of the merchant’s business. *Numerical digits only | Mandatory – except for when companyType is “Sole Proprietor” |
legalAdressCity | Sheung Wan | City where the merchant’s business is legally licensed. | Mandatory |
legalAdressState | Hong Kong | State where the merchant’s business is legally licensed. | Mandatory |
legalAdressStreet | 123 Main Rd C | Street address where the merchant’s business is legally licensed. | Mandatory |
legalAdressPostalCode | 999077 | Postal code where the contact lives. | Mandatory |
legalAdressCountry | HK | Country where the contact lives. Country 2 letter code ISO 3166-1 Alpha 2. * Case sensitive submission | Mandatory |
bnmCategory | SME | Company category as required by the Central Bank of Malaysia. Options are: • SME • Non-SME * Case sensitive submission | Conditional – only required if the registrationCountry is “MY” |
bnmSize | Small | Company size as required by the Central Bank of Malaysia. Options are: • Corporate • Medium • Small • Micro * Case sensitive submission | Conditional – only required if the registrationCountry is “MY” |
bnmType | Retail | Company type as required by the Central Bank of Malaysia. Options are: • Government Service • Fuel/Petrol • Retail • Food and Restaurant • Utility • Processional and Commercial Service • Transportation • Accommodation and Hotel • Amusement and Entertainment • Financial Service • Insurance • Others * Case sensitive submission | Conditional – only required if the registrationCountry is “MY” |
Accounts with multiple branches
If an Account has multiple branches, (i.e., multiple legal entities with their own unique business registrations), the Account entity for the headquarters must be created first as it will act as a Parent Account. Once the headquarters Account entity has been created, you can proceed with creating each branches’ Account entity. Each branch Account entity will be required to send the following fields:
Field Name | Value | Description | Type |
---|---|---|---|
parentAccount | true | Identifies if the Merchant has a Parent Merchant. | Mandatory |
parentType | Account | Identifies the Parent Merchant type. Should always send “Account”. *Case sensitive | Mandatory |
parentID | 645d4a78753131ff5 | ID of the Parent Account for this branch. This will be the unique uP POM Account ID of the headquarters’ Account entity (see the accountID field under the Contact entity) | Mandatory |
Suggested Merchant Category Code (MCC)
The Account entity has an optional “suggestedMCC” field that can be used to submit a suggested merchant category code (MCC) to the uP POM. The suggested MCC code will be assessed by the NomuPay risk and underwriting teams to ensure that it fits the qualifications for that MCC designation. If it is found that the MCC is not in alignment with the services provided by the merchant, NomuPay will update the MCC to a more appropriate designation; you will be informed of the change in a webhook under an “mcc” field.
View a full listing on NomuPay’s Merchant Category Codes.