Create

Description： Create an order and obtain URL to the hosted checkout page
Path： /hosted-checkout/create
Method： POST
Request Header： Content-Type: application/json

Request Parameters#

Parameter	Type	Required/optional	Default	Description
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 default if it is not available. Available methods: `CARD`, `APPLEPAY`, `GOOGLEPAY`, `ALIPAYHK`, `ALIPAYCN`, `WECHATPAY`
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

Example:#

{
  "request": "{\"currency\":\"HKD\",\"amount\":50,\"lineItems\":[{\"priceData\":{\"name\":\"Book\",\"unitAmount\":50},\"quantity\":1}],\"merchantId\":3,\"merchantReference\":\"merRef1658821702947\",\"isRecurring\":false,\"paymentMethods\":\"CARD,APPLEPAY,GOOGLEPAY,ALIPAYHK\"}",
  "signature": "zl6+TX8BNsIeIW9RtX8xIr/29aXaYso49FipB9EBwz5TNSEURhJ67MTMeMsio91llpNayMGyd9PqX6UsKehlKEMDTfAJFPIPI4h7ChrL8kilej96ykgPxFcakKBM8NdQuLiftkizYXipnbJer7f8ndynle4bC/9cVNVyHyToIZXA5a2Ee4RbIzSRhS7EvqbNPO3UucK/jYER7bP431re/UGx+0GCCwPMPnT0DfBH7UHD/gde3wq50F7Pe5P6JVjL61yuMqY+sh79IJLZedKSY4q2msnXJ1jVVYyWoM+6K+FMPtClkSBr8ed63OPokDXs0/xh/8yYS2W9lzWpc39ZxA=="
}

Response Parameters#

Parameter	Type	Required/optional	Description
responseCode	string	Required	Payment Gateway response code
message	string	Required	Payment Gateway response message
checkoutUrl	string	Required	URL to hosted checkout page
order	object	Required	Object contains order details
order.id	number	Required	Order identifier. If it is recurring payment, save this value as next recurring payment's parentOrderId
order.merchantId	number	Required	Merchant identifier which own this order
order.merchantReference	string	Required	Your reference for the order
order.currency	string	Required	3-Letters ISO currency code of the order
order.amount	number	Required	Amount of order
order.netAmount	number	Required	Net amount of the order
order.createTime	datetime	Required	Timestamp when the order is created. Maintained by the Payment Gateway
order.updateTime	datetime	Required	Timestamp when the order is last updated. Maintained by the Payment Gateway
order.status	string	Required	Status of the order. Maintained by the Payment Gateway
order.recurring	boolean	Required	Flags the order is a recurring order or not

Example:#

{
  "responseCode": "0000",
  "message": "SUCCESS",
  "checkoutUrl": "https://checkout.sit.bbmsl.com/order?sid=4643d04ce495462b8367de567b6ed096",
  "order": {
    "id": 7221,
    "merchantId": 3,
    "merchantReference": "merRef1658821702947",
    "currency": "HKD",
    "amount": 50,
    "netAmount": 0,
    "createTime": "2022-07-26T07:48:23.321+00:00",
    "updateTime": "2022-07-26T07:48:23.337+00:00",
    "status": "OPEN",
    "recurring": false
  }
}