merchantId | string | Required | | Merchant identifier |
currency | string | Optional | HKD | 3-Letters ISO currency code, supports HKD , USD |
amount | number | Required | | Order amount |
merchantReference | string | Required | | An unique reference to identify this order |
callbackUrl | object | Optional | | |
callbackUrl.success | string | Optional | | An URL to redirect after successful payment |
callbackUrl.fail | string | Optional | | An URL to redirect after failed payment |
callbackUrl.cancel | string | Optional | | An URL to redirect when payment is cancelled |
callbackUrl.notify | string | Optional | | An API URL in merchant's backend to receive notification |
isRecurring | boolean | Optional | false | Enable/disable recurring payment |
expiryTime | datetime | Optional | now + 1000s | Time that this order will be expired in ISO 8601 format. |
lineItems | array | Required | | Line item list. There can be 1..n object with line item details |
lineItems[index].quantity | number | Required | | Number of items, must be an integer |
lineItems[index].priceData | object | Required | | Price data object with details |
lineItems[index].priceData.unitAmount | number | Required | | Unit amount of the item |
lineItems[index].priceData.name | string | Required | | Name of the item |
lang | string | Optional | Web browser default | Default language, value can be zh-HK or en |
showLang | boolean | Optional | true | Show/hide language options |
showPoweredBy | boolean | Optional | true | Show/hide Powered by BBMSL text at the bottom |
paymentMethods | string | Optional | All available payment methods | Supported payment methods by order, separated with comma. Available methods: CARD , APPLEPAY , GOOGLEPAY , ALIPAYHK , ALIPAYCN , WECHATPAY |
defaultPaymentMethod | string | Optional | | Preselected payment method, fallback to first method if it is not available. Available methods: CARD , APPLEPAY , GOOGLEPAY , ALIPAYHK , ALIPAYCN , WECHATPAY |
allowedCardType | string | Optional | | Allow only the provided card type to proceed if given, applying only when CARD , APPLEPAY , or GOOGLEPAY is included in paymentMethods . Available card type: VISA , MASTER |
showOrderDetail | boolean | Optional | true | Show/hide order item list |
showEmail | boolean | Optional | true | Show/hide email input field |
showMerchantReference | boolean | Optional | true | Show/hide order's merchant reference on the top right corner |
showOrderId | boolean | Optional | true | Show/hide order ID |
showResultPage | boolean | Optional | true | Show/hide result page, callbackUrl must be given if set to false |
themeColor | string | Optional | | Order page background color |
buttonBackgroundColor | string | Optional | | Background color of all buttons |
buttonFontColor | string | Optional | | Font color of all buttons |