cancelPayment
1. Overview
Endpoint: https://open.alipay.hk/aps/api/intl/wallet/v1/payments/cancelPayment
Use this interface to cancel a payment.
2. Sample
- Issuing Participantsends the cancellation request to AlipayHK.
{
"acquirerId": "1022188000000000001",
"pspId":"1022172000000000001",
"paymentRequestId":"20200101234567890132"
}- AlipayHK returns the cancellation request to Issuing Participant.
{
"result": {
"resultCode":"SUCCESS",
"resultStatus":"S",
"resultMessage":"Success"
}
}3. Structure
3.1 Request
No. | Field | Description |
1 | acquirerId | MANDATORY String (64) The unique ID that is assigned by AlipayHK to identify an Acquirer. |
2 | pspId | MANDATORY String (64) The unique ID that is assigned by AlipayHK to identify a Issuing Participant,. |
3 | paymentRequestId | MANDATORY String (64) The unique ID that is assigned by the payment initiator to identify an order payment. |
3.2 Response
4. Result code
No. | resultCode | resultStatus | resultMessage |
1 | SUCCESS | S | Success |
2 | PROCESS_FAIL | F | A general business failure occurred. Don't retry. |
3 | PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. |
4 | KEY_NOT_FOUND | F | The key is not found. |
5 | ACCESS_DENIED | F | The access is denied. |
6 | REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. |
7 | INVALID_API | F | The called API is invalid or not active. |
8 | INVALID_CLIENT | F | The client is invalid. |
9 | INVALID_SIGNATURE | F | The signature is invalid. |
10 | METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. |
11 | MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. |
12 | UNKNOWN_EXCEPTION | U | An API calling is failed, which is caused by unknown reasons. |