Recurring

API： Recurring
Description： Set recurring payment for the related transaction
Path： /hosted-checkout/recurring
Method： POST
Request Header： Content-Type: application/json

Request Parameters#

parameter	type	require	description
merchantId	string	Y	Merchant ID which is assigned by BBMSL
amount	number	Y	Recurring amount
merchantReference	string	Y	merchant's reference number, different from create merchantReference
parentOrderId	number	Y	Order ID which response from API Create reuccring: /hosted-checkout/create

Example：

{
    "request": "{\"merchantId\":\"3000001\",\"amount\":76.19,\"merchantReference\":\"s22tring\",\"parentOrderId\":2710}",
    "signature":"c1hTR2RBNHRSNEIwd25GNk5yOFNocGZOTXRISVNXdXpMcGRLb05Xc2tJZ0Njc3BNVkZGemdrZXo0QnJtdFlYa01xWmgxdHl6LzhzTk5VM0YyVlR1MGZPeCtaUDRDbm1Wak51OGJjaXU0aFR0bnl0QTNZMUdaL3lYQVVEK21WWUdYZXlETzNmSHJxRGRJN2szeFYvUThGQ09kMGN1bFRzTjZSUk14TVpxK29xUjJ4K0VqT1hWb2ZwN0JaSndoUUU4VXM0QWw1NzNGUXo1RUhEdkNMeDM1bHEyaG9NaFhMQ1ZMVkRCSGNwQ2dvdHVZNG1nOTFNWGgvcXFjRkdZL2hRS2hHZFdBYlo5dGNwMlE1czJFU2gzN3JxeG5Pd1pycmVwSzhOQzZ2TUJQVWlTUHhRZWZwZXYybkcwSnpBSE9qUlBiQlhZdzFYQlM2UkJZS0FtdWZaWmlRPT0="
}

Response Parameters#

parameter	type	require
responseCode	string	Y
message	string	Y
order	object	Y
order.id	number	Y
order.merchantId	number	Y
order.merchantReference	string	Y
order.currency	string	Y
order.amount	number	Y
order.itemAmount	number	Y
order.transFee	number	Y
order.netAmount	number	Y
order.cardType	string	Y
order.email	string	Y
order.createTime	dateTime	Y
order.updateTime	dateTime	Y
order.status	string	Y
order.recurring	boolean	Y
transaction	object	Y
transaction.id	number	Y
transaction.merchantId	number	Y
transaction.type	string	Y
transaction.amount	number	Y
transaction.status	string	Y
transaction.maskedPan	string	Y
transaction.stan	string	Y

Example：

{
    "responseCode": "0000",
    "message": "SUCCESS",
    "order":{
        "id": "1076",
        "merchantId": 3000001,
        "merchantReference": "s22tring",
        "currency": "HKD",
        "amount": 76.19,
        "itemAmount": 76.19,
        "transFee": 2.00,
        "netAmount": 76.19,
        "cardType": "VISA",
        "email": "",
        "createTime": "2022-03-04T06:19:57.000+00:00",
        "updateTime": "2022-03-04T06:22:36.002+00:00",
        "status": "SUCCESS",
        "recurring": true
    },
    "transaction": {
        "id": 871,
        "merchantId": 3000001,
        "type": "SALE",
        "amount": 76.19,
        "status": "SUCCESS",
        "maskedPan": "400000XXXXXX1091",
        "stan": "871"
    }
}