Refund

---

• Description： Refund the order if the payment method allows. Support both full refund and partial refund, and can refund only once. Refund will only approve when there is enough unsettled balance in merchant account.
• Path： /direct/refund
• Method： POST
• Request Header： Content-Type: application/json

Request Parameters

Parameter	Type	Mandatory	Description
merchantId	String	M	Merchant identifier
orderId	Number	C	Order ID of the payment. Mandatory when merchantReference is not given
merchantReference	String(64)	C	Unique reference of the order. Mandatory when orderId is not given
amount	Number(9,2)	M	Refund amount

Example:

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

Response Parameters

Parameter	Type	Mandatory	Description
responseCode	String	M	Payment Gateway response code
message	String	M	Payment Gateway response message
order	Object	M
order.id	Number	M	Order identifier
order.merchantReference	String	M	Merchant identifier which own this order
order.currency	String	M	3-Letters ISO currency code of the order
order.status	String	M	Status of the order. Maintained by the Payment Gateway
order.amount	Number	M	Order amount
order.createTime	Datetime	M	Timestamp when the order is created. Maintained by the Payment Gateway
order.updateTime	Datetime	M	Timestamp when the order is last updated. Maintained by the Payment Gateway
transaction	Object	M
transaction.id	Number	M	Transaction identifier for the void transaction
transaction.merchantId	Number	M	Merchant identifier which own this transaction
transaction.type	String	M	Transaction type
transaction.currency	String	M	Transaction currency
transaction.amount	Number	M	Transaction amount
transaction.status	String	M	Status of the transaction. Maintained by the Payment Gateway
transaction.maskedPan	String	M	Masked card number of the original sale transaction if supported by the payment method
transaction.stan	String	M	System trace audit number for the transaction

Example:

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