/v2/authorizations/revoke

2021-07-21 11:23

POST /v2/authorizations/revoke

The revoke API is used to cancel an access token at wallets.

Message structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see：

Property	Data type	Required	Description	Example
accessToken	String	Yes	An access token that can be used to access the user resource scope. Max. length: 128 characters.	"281010033AB2F588D14B43238637264FCA5AAF35xxxx"
authClientId	String	No	The unique identifier allocated for a client. Max. length: 128 characters.	"202016726873874774774xxxx"
extendInfo	String	No	The extended information that wallets and merchants want to describe. Max. length: 4096 characters.	copy `{ "memo": "memo" }`

Property

Data type

Required

Description

Example

result

Yes

The request result, which contains information related to the request result, such as status and error codes.

{ "resultCode":"SUCCESS", "resultStatus":"S", "resultMessage":"success" }

extendInfo

String

The extended information that wallets and merchants want to describe.

Max. length: 4096 characters.

copy

{
    "memo": "memo"
}

In the response, the result.resultStatus field indicates the result of processing a request as follow:

resultStatus	Description
S	The authorization is canceled successfully. AuthClient cannot use the AccessToken to access user's resources, and may not use the relative refreshToken to retrieve new AccessToken. The corresponding `result.resultCode` is "SUCCESS" and the `result.resultMessage` is "Success".
U	The API status is unknown. It means that authorization is failed to cancel, and AuthClient may guide the user to try again. The corresponding `result.resultCode` is "UNKNOWN_EXCEPTION" and `result.resultMessage` is "An API calling is failed, which is caused by unknown reasons.". For details, see the Common error codes section.
F	It means that authorization is failed to cancel, and AuthClient may guide the user to try again. The corresponding `result.resultCode` and `result.resultMessage` are various based on different situations. For details, see the following Error codes section.

Error codes are usually classified into the following categories:

resultStatus	resultCode	resultMessage	Further Action
F	INVALID_AUTH_CLIENT_STATUS	Invalid auth client status.
F	INVALID_ACCESS_TOKEN	The access token is invalid.
F	INVALID_AUTH_CLIENT	The auth client id is invalid.
F	EXPIRED_ACCESS_TOKEN	The access token is expired.
F	EXPIRED_AGENT_TOKEN	The access token of mini program is expired.
F	INVALID_AGENT_TOKEN	The access token of mini program is invalid.

You can cancel the authorization. After cancellation, the refreshToken cannot be used even if it is valid.

When users cancel an access token from the mini program,

The merchant server calls the revoke interface to cancel an access token (Step 2).
And the wallet server returns the token cancellation result to the merchant server (Step 3).

copy

{
  "accessToken": "281010033AB2F588D14B43238637264FCA5AAF35xxxx",
  "authClientId": "202016726873874774774xxxx"
}

copy

{
 "result": {
    "resultCode":"SUCCESS",
    "resultStatus":"S",
    "resultMessage":"success"
  }
}