Create

API： Create Order
Description： Create order with hosted checkout url
Path： /hosted-checkout/create
Method： POST
Request Header： Content-Type: application/json

Request Parameters#

parameter	type	require	description
merchantId	string	Y
amount	number	Y
merchantReference	string	Y	merchant's reference number, must be unique.
callbackUrl	object	O
callbackUrl.success	string	O
callbackUrl.fail	string	O
callbackUrl.cancel	string	O
callbackUrl.notify	string	O
isRecurring	boolean	O	Recurring payment 1:Yes 0:No. Default is 0.
lineItems	array	Y
lineItems[index].quantity	number	Y
lineItems[index].priceData	object	Y
lineItems[index].priceData.unitAmount	number	Y
lineItems[index].priceData.name	string	Y

Example：

{
    "request": "{\"merchantId\":\"3000001\",\"amount\":100.2,\"isRecurring\":0,\"callbackUrl\":{\"fail\":\"https://www.bbmsl.com/fail\",\"success\":\"https://www.bbmsl.com/success\",\"cancel\":\"https://www.bbmsl.com/cancel\"},\"merchantReference\":\"Martin0331\",\"lineItems\":[{\"quantity\":1,\"priceData\":{\"unitAmount\":1.22,\"name\":\"Book\"}}]}",
    "signature":"c1hTR2RBNHRSNEIwd25GNk5yOFNocGZOTXRISVNXdXpMcGRLb05Xc2tJZ0Njc3BNVkZGemdrZXo0QnJtdFlYa01xWmgxdHl6LzhzTk5VM0YyVlR1MGZPeCtaUDRDbm1Wak51OGJjaXU0aFR0bnl0QTNZMUdaL3lYQVVEK21WWUdYZXlETzNmSHJxRGRJN2szeFYvUThGQ09kMGN1bFRzTjZSUk14TVpxK29xUjJ4K0VqT1hWb2ZwN0JaSndoUUU4VXM0QWw1NzNGUXo1RUhEdkNMeDM1bHEyaG9NaFhMQ1ZMVkRCSGNwQ2dvdHVZNG1nOTFNWGgvcXFjRkdZL2hRS2hHZFdBYlo5dGNwMlE1czJFU2gzN3JxeG5Pd1pycmVwSzhOQzZ2TUJQVWlTUHhRZWZwZXYybkcwSnpBSE9qUlBiQlhZdzFYQlM2UkJZS0FtdWZaWmlRPT0="
}

Response Parameters#

parameter	type	require	description
responseCode	string	Y
message	string	Y
checkoutUrl	string	Y
order	object	Y
order.id	number	Y	If it is recurring payment, please save this value as next recurring payment's parentOrderId.
order.merchantId	number	Y
order.merchantReference	string	Y
order.currency	string	Y
order.amount	number	Y
order.itemAmount	number	Y
order.netAmount	number	Y
order.createTime	dateTime	Y
order.updateTime	dateTime	Y
order.status	string	Y
order.recurring	boolean	Y

Example：

{
    "responseCode": "0000",
    "message": "SUCCESS",
    "checkoutUrl": "https://checkout.dev.bbmsl.com/ss787sxsxssressxs4234212",
    "order":{
        "id": "1076",
        "merchantId": 3000001,
        "merchantReference": "Martin 0331",
        "currency": "HKD",
        "amount": 76.19,
        "itemAmount": 76.19,
        "netAmount": 0,
        "createTime": "2022-03-04T04:24:18.363+00:00",
        "updateTime": "2022-03-04T04:24:18.423+00:00",
        "status": "OPEN",
        "recurring": false
    }
}