Banking detail entity
The Banking detail entity is used to submit a merchant’s bank account information to the uP POM. This is the bank account that NomuPay will auto-send funds to from the merchant’s Unified Balance on the uP Platform, less any applicable fees and taxes. There is a required relationship between the Banking details entity and a merchant (i.e., an Account entity).
See visual below.
The table below captures the Banking details entity’s required fields.
note
Some field values are case sensitive. These field will be denoted with an * for clarity.
| Field Name | Value | Description | Type |
|---|---|---|---|
| parentId | 6410461062cebb512 | ID of the “Parent” for this location. This will be the unique uP POM Account ID of the merchant on the uP Platform. This is provided automatically by the uP POM after the Account entity is created. | Mandatory |
| parentType | Account | Type of the “Parent” for this location. Should always send “Account”. * Case sensitive submission | Mandatory |
| name | Company ABC | The operating name that the merchant is doing business under. | Mandatory |
| fIType | BANK ACCOUNT | Type of financial instrument that will receive the funds. Should always send “BANK_ACCOUNT”. * Case sensitive submission | Mandatory |
| fIOwnerType | BUSINESS | Clarify if the financial instrument is owned by an individual or a business. Options are: • INDIVIDUAL • BUSINESS * Case sensitive submission | Mandatory |
| fIOwner | Company ABC | Name registered to the financial instrument. | Mandatory |
| fICountry | HK | Country of the financial instrument. Country 2 letter code ISO 3166-1 Alpha 2. * Case sensitive submission. | Mandatory |
| fICurrency | HKD | Currency of the financial instrument. Currency 3 letter code ISO 4217-Alpha 3. * Case sensitive submission. | Mandatory |
| bankID | 004 | Routing code or Bank ID of the financial instrument. * Numerical digits only. | Mandatory |
| bankAccountID | 987654321 | Bank account number of the financial instrument. * Numerical digits only. | Mandatory |
| branchID | 812 | Branch number of the financial instrument. | Conditional – only required if the fICountry is “TH” or “HK” and fIType is “BANK_ACCOUNT”. |