Antom, leading provider of tailored payment solutions

alipay.intl.oauth.auth.cancelByAuthInfo

You can use this interface to cancel an existing oAuth authorization by authorization information.

Request Parameters

No
Name
Description
Type
Length
Required
Remarks
Sample
1
version
API version
string
8
Y
As per the respective API reference
2.0.0
2
function
API interface
string
128
Y
According to specifications defined by each business domain
alipay.intl.function
3
clientId
Client ID
string
32
Y
Provided by AlipayHK, used to identify partner and application system
4Q5XPV504B0A5302
4
reqTime
Request time
datetime
/
Y
DateTime with timezone, which follows the ISO-8601 standard.
Refer to: RFC 3339 Section 5.6
2001-07-04T12:08:56+05:30
5
reqMsgId
Request message ID
string
64
Y
Each request will be assigned with a unique id (uuid).
The reqMsgId identify an unique system request, it is not used to identity an unique business request.
1234567asdfasdf1123fda
6
reserve
Reserved for future implementation
string
256
N
Key/Value
{}

Body

No
Name
Description
Type
Length
Required
Remarks
Sample
1
authMerchantId
Auth merchant ID. The auth merchant can be authorized by the user  to access user resources.
string
64
Y

2160400000002012
2
merchantAgreementId
The external agreement id from the merchant.
string
32
Y
8b0b4dd8218a42269483f5806e17a7d4

Request Sample

{
    "request":{
        "head":{
            "version":"2.0.0",
            "function":"alipay.intl.oauth.auth.cancelByAuthInfo",
            "clientId":"4Q5XPV504B0A5302",
            "reqTime":"2018-12-04T12:08:56+05:30",
            "reqMsgId":"1234567asdfasdf1123fde",
            "reserve":"{}"
        },
        "body":{
            "authMerchantId":"2160400000002012",
            "merchantAgreementId":"8b0b4dd8218a42269483f5806e17a7d4"
        }
    },
    "signature":"XXX "
}

Response parameter

Header

No
Name
Description
Type
Length
Required
Remarks
Sample
1
version
API version
string
8
Y
As per the respective API reference
2.0.0
2
function
API interface
string
128
Y
According to specifications defined by each business domain
alipay.intl.function
3
clientId
Client ID
string
32
Y
Provided by AlipayHK, used to identify partner and application system
4Q5XPV504B0A5302
4
respTime
Response time
datetime
/
Y
DateTime with timezone, which follows the ISO-8601 standard.  
Refer to: RFC 3339 Section 5.6
2001-07-04T12:08:56+05:30
5
reqMsgId
Request message ID
string
64
Y
Each request will be assigned with a unique id (uuid).
1234567asdfasdf1123fda
6
reserve
Reserved for future implementation
string
256
N
Key/Value
{}


Body

No
Name
Description
Type
Length
Required
Remarks
Sample
1
resultInfo
Result info
/
Y
{  
"resultStatus": "S",  
"resultCodeId": "00000000",  
"resultCode":"SUCCESS",  
"resultMsg": "result message"  
}
2
cancelTime
The cancel time of the transaction
datetime
/
N
DateTime with timezone, which follows the ISO-8601 standard.
Refer to: RFC 3339 Section 5.6
2018-12-11T01:36:46-08:00

Response Sample

{
    "response": {
        "body": {
            "cancelTime": "2018-12-11T01:36:46-08:00",
            "resultInfo": {
                "resultCode": "SUCCESS",
                "resultCodeId": "00000000",
                "resultMsg": "Success",
                "resultStatus": "S"
            }
        },
        "head": {
            "clientId": "4Q5XPV504B0A5302",
            "function": "alipay.intl.oauth.auth.cancelByAuthInfo",
            "reqMsgId": "1234567asdfasdf1123fde",
            "respTime": "2018-12-11T01:36:46-08:00",
            "version": "2.0.0"
        }
    }
}

Business Error code

Functional Logic Result Code
No
ResultCodeId
ResultCode
ResultStatus
Remarks
1
00000023
PRODUCT_IS_INVALID
F
Product is invalid
2
00000019PROCESS_FAIL
F
General business failure
3
12005125
AUTH_NOT_FOUND
F
The authorization is not found
4
12002005
USER_NOT_EXIST
F
User does not exist
5
12007001
RISK_AML_REJECT
F
Anti money laundering risk reject
6
00000011
RISK_REJECT
F
Risk reject