codeConsult
1. Overview
Endpoint: https://open.alipay.hk/aps/hk/payments/codeConsult
Use this interface to tell codeValue source, CN wallet or HK wallet. etc.
2. Sample
- Issuing Participant sends a code consult request to AlipayHK.
{
"codeValue":"281xxxxxxxxxxxxxxxx4441"
}- AlipayHK returns the request result to Issuing Participant.
{
"result": {
"resultCode":"SUCCESS",
"resultStatus":"S",
"resultMessage":"success"
},
"pspSiteName":"ALIPAY_CN"
}3. Structure
3.1 Request
No. | Field | Description |
1 | codeValue | RequiredString (512) The code value that is generated after the user scans the QR code. |
3.2 Response
4. Result code
No. | resultCode | resultStatus | resultMessage |
1 | SUCCESS | S | Success |
2 | INVALID_CONTRACT | F | The contract is invalid. |
3 | INVALID_CODE | F | The code is invalid. |
4 | EXPIRED_CODE | F | The code is expired. |
5 | CURRENCY_NOT_SUPPORT | F | The currency is not supported. |
6 | PROCESS_FAIL | F | A general business failure occurred. Don't retry. |
7 | PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. |
8 | KEY_NOT_FOUND | F | The key is not found. |
9 | ACCESS_DENIED | F | The access is denied. |
10 | REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. |
11 | INVALID_API | F | The called API is invalid or not active. |
12 | INVALID_CLIENT | F | The client is invalid. |
13 | INVALID_SIGNATURE | F | The signature is invalid. |
14 | METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. |
15 | MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. |
16 | UNKNOWN_EXCEPTION | U | An API calling is failed, which is caused by unknown reasons. |