DOCS

Error codes

If an error occurs when you call an API, an error response is returned, where the object result indicates the error code (resultCode) and error message (resultMessage). You can use error codes and messages to troublshoot issues.

Error codes are usually classified into the following categories:

Common error codes

The following table lists all common error codes for Mini Program OpenAPIs. If you do not find an error code in the following table, it means that the error code is not common, but dedicated to a specific OpenAPI.

Error code

Result status

Error message

Further action

PROCESS_FAIL

F

A general business failure occurred. Do not retry.

Contact technical support to troubleshoot the issue. 

PARAM_ILLEGAL

F

Illegal parameters. For example, non-numeric input, invalid date.        


Check and verify whether the request fields (including the header fields and body fields) of the current API are correct and valid. For example, /v1/authorizations/applyToken.

INVALID_API

F

The called API is invalid or not active.

Check whether the current API name is used by mistakes when the API is called.

ACCESS_DENIED

F

Access is denied                   

Need to check the resultMessage of the current API specification for details. For example, /v1/authorizations/applyToken.

REQUEST_TRAFFIC_EXCEED_LIMIT

F

The request traffic exceeds the limit.

   

  • The party that calls APIs needs to reduce the API calling frequency, or
  • The API service provider needs to increase the traffic limit or threshold.

UNKNOWN_EXCEPTION

U

An API calling is failed, which is caused by unknown reasons.

Trying to recall the API might help to resolve the issue. 

INVALID_SIGNATURE

F

The request signature is invalid.

Contact technical support to troubleshoot the issue. 

INVALID_AUTH_CLIENT

F

The auth client is invalid.

Use a valid clientId assigned by the super app.

INVALID_AUTH_CLIENT_STATUS

F

The status of the authorized merchant is invalid.

Contact technical support to troubleshoot the issue.

API-specific error codes

For error codes that are dedicated to a specific API, see the Error codes section in each API specification, for example, /v1/authorizations/applyToken.