Void

Description： Void payment order
Path： /direct/void
Request Header： Content-Type: application/json

Request Parameters#

Parameter	Type	Required	Description
merchantId	string	Required	Merchant identifier
orderId	number	Optional	Order identifier
merchantReference	string	Optional	A reference that you provided in Sale order

Example:#

{
    "request": "{\"merchantId\":\"3000001\",\"merchantReference\":\"s22tring\",}",
    "signature":"c1hTR2RBNHRSNEIwd25GNk5yOFNocGZOTXRISVNXdXpMcGRLb05Xc2tJZ0Njc3BNVkZGemdrZXo0QnJtdFlYa01xWmgxdHl6LzhzTk5VM0YyVlR1MGZPeCtaUDRDbm1Wak51OGJjaXU0aFR0bnl0QTNZMUdaL3lYQVVEK21WWUdYZXlETzNmSHJxRGRJN2szeFYvUThGQ09kMGN1bFRzTjZSUk14TVpxK29xUjJ4K0VqT1hWb2ZwN0JaSndoUUU4VXM0QWw1NzNGUXo1RUhEdkNMeDM1bHEyaG9NaFhMQ1ZMVkRCSGNwQ2dvdHVZNG1nOTFNWGgvcXFjRkdZL2hRS2hHZFdBYlo5dGNwMlE1czJFU2gzN3JxeG5Pd1pycmVwSzhOQzZ2TUJQVWlTUHhRZWZwZXYybkcwSnpBSE9qUlBiQlhZdzFYQlM2UkJZS0FtdWZaWmlRPT0="
}

Response Parameters#

Parameter	Type	Required	Description
responseCode	string	Required	Payment Gateway response code
message	string	Required	Payment Gateway response message
order	object	Required
order.id	number	Required	Order identifier
order.merchantReference	string	Required	Merchant identifier which own this order
order.currency	string	Required	3-Letters ISO currency code of the order
order.status	string	Required	Status of the order. Maintained by the Payment Gateway
order.amount	number	Required	Order amount
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

Example:#

{
    "responseCode": "0000",
    "message": "SUCCESS",
    "order":{
        "id": "1076",
        "merchantReference": "s22tring",
        "currency": "HKD",
        "amount": 76.19,
        "status": "VOIDED"
    }
}