Opportunity entity
The Opportunity entity is used to submit additional product details, such as potential volumes. There is a required relationship between the Opportunity entity and the Account entity, as well as between the Opportunity entity and the Products entity (see visual below).
The table below captures the Opportunities 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 |
|---|---|---|---|
| accountId | 6410461062cebb512 | This is 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 |
| ats | 100 | Average transaction value * Numerical digits only | Mandatory |
| atsCurrency | HKD | Currency of the Average Transaction Value. Currency 3 letter code ISO 4217-Alpha 3 * Case sensitive submission | Mandatory |
| closeDate | YYYY-MM-DD | Year, month, date on which it is expected that the merchant will have signed the contract. | Mandatory |
| E-commerceAPMs | 20 | Share of e-commerce transactions that are paid for using APMs (alternative payment methods) * Numerical digits only (Conditional) | Conditional – only required if the Product ID in the Opportunity is for the “Ecommerce” model and it is “Card” payment type |
| E-commerceCards | 80 | Share of e-commerce transactions that are paid for using cards * Numerical digits only (Conditional) | Conditional – only required if the Product ID in the Opportunity is for the “Ecommerce” model and it is “Card” payment type |
| expectedFirstTransactionDate | YYYY-MM-DD | Year, month, date on which the first transaction is expected. * Date must be formatted as shown in the Value column | Mandatory |
| inStoreAPMs | 30 | Share of transactions in physical stores that are paid for using APMs (alternative payment methods) * Numerical digits only (Conditional) | Conditional – only required if the Product ID in the Opportunity is for the “In Store” model |
| inStoreCards | 70 | Share of transactions in physical stores that are paid for using cards * Numerical digits only (Conditional) | Conditional – only required if the Product ID in the Opportunity is for the “In Store” model |
| maxTV | 5000 | Maximum average transaction value * Numerical digits only, round to a whole number (no decimal inputs) | Mandatory |
| maxTVCurrency | HKD | Currency of the Maximum average transaction value. Currency 3 letter code ISO 4217-Alpha 3 *Case sensitive submission | |
| numberOfOnlineOutlets | 2 | Total number of e-commerce websites related to this Opportunity * Numerical digits only (Conditional) | Conditional – only required if the Product ID in the Opportunity is for the “Ecommerce” model |
| numberOfPhysicalStores | 5 | Total number of physical stores related to this Opportunity * Numerical digits only (Conditional) | Conditional – only required if the Product ID in the Opportunity is for the “Ecommerce” model |
| productDelivery | At the time of payment/transaction | When the product is delivered in relation to the payment/transaction. Options are: • Before the payment/transaction • After payment/transaction • At the time of payment/transaction • Other * Case sensitive submission | Mandatory |
| productDeliveryafterPaymenttransaction | 10 | The percentage of the product delivery that occurs after the payment/transaction * Numerical digits only (Conditional) | Conditional – only required if productDelivery contains • After payment/transaction |
| productDeliveryatTheTimeOfPaymenttransaction | 20 | The percentage of the product delivery that occurs at the time of the payment/transaction * Numerical digits only (Conditional) | Conditional – only required if productDelivery contains • After payment/transaction |
| productDeliverybeforeThePaymenttransaction | 15 | The percentage of the product delivery that occurs before the payment/transaction * Numerical digits only (Conditional) | Conditional – only required if productDelivery contains • After payment/transaction |
| productDeliveryDaysInAdvance | 10 | Number of days in advance the payment/transaction is made before the product is delivered * Numerical digits only (Conditional) | Conditional – only required if productDelivery contains • After payment/transaction |
| productDeliveryMaximumTimeOfDelivery | 7-14 days | Maximum number of days for the product to be delivered within. Options are: • 1-7 days • 7-14 days • 14-30 days • 30-90 days • 90-180 days • 180-365 days • +365 days * Case sensitive submission | Conditional – only required if productDelivery contains • After payment/transaction |
| productDeliveryMinimumTimeOfDelivery | 5 | Minimum number of days for the product to be delivered within. Options are: • 1-7 days • 7-14 days • 14-30 days • 30-90 days • 90-180 days • 180-365 days • +365 days * Case sensitive submission | Conditional – only required if productDelivery contains • After payment/transaction |
| productDeliveryOther | 10 | Field to provide additional context when "Other" is selected for product delivery | Conditional – only required if productDelivery contains • Other |
| productDeliveryother | 25 | The percentage of the product delivery that occurs when "Other" is selected for product delivery * Numerical digits only (Conditional) | Conditional – only required if productDelivery contains • Other |
| productsIds | 63c3dc62dc635e8c2 63c3ce60c82856942 63c3cdfec5722d1dd 63c3dbfd4e03ca9d1 63c3c94b699e644a0 | The list of Products (using the provided IDs) from NomuPay that this Opportunity will include | Mandatory |
| sOW | 100 | Signifies the percentage of total processing volume of the Opportunity that this merchant has committed to NomuPay * Numerical digits only | Mandatory |
| totalProcessingVolume | 100000 | The annual transaction processing volume for this Opportunity * Numerical digits only, round to a whole number (no decimal inputs) | Mandatory |
| totalProcessingVolumeCurrency | HKD | Currency of the annual transaction processing volume. Currency 3 letter code ISO 4217-Alpha 3 * Case sensitive submission | Mandatory |