Skip to main content
  • Last Updated: 2022-01-16 21:31:02

Common Response Parameters

ParameterTypeDescriptionExampleRequired
codestringResponse status code00000000Yes
messagestringError messageParameter errorYes
traceIdstringUnique identifier for the request. The traceId is the trace number generated by this call. Provide it when reporting API call issues.7457794513993866186Yes
dataObjectBusiness data as a JSON object. If the request fails, this field may contain detailed error information.Yes
data.statusstringOrder status (see notes below)SUCCESSYes

Notes

status represents the order status. For payment, refund, and reversal orders, the success or failure is determined by the value of status.
status has four possible values: PENDING, SUCCESS, FAILED, CLOSED, representing processing, success, failure, and order closed respectively.

Response Format

All API responses have Content-Type: application/json. Responses follow a unified format:

Success Format

{
  "code": "00000000",
  "message": "SUCCESS",
  "traceId": "cfef69feec8d25aa",
  "data": {
    "status": "SUCCESS"
  }
}
  1. Active QR code payment is asynchronous. A code of 00000003 means the business request was accepted and is awaiting user payment. The order will show as PENDING. The payment result can be retrieved by querying the transaction order manually.
  2. For WeChat passive scan payment (MICROPAY), if the user pays successfully, SUCCESS is returned directly. If a network error or timeout occurs, PENDING is returned — query the transaction result via the query API.
  3. When the request succeeds, the data field contains the business data of the response.

Failure Format

{
  "code": "22070030",
  "message": "Format error-transType cannot be empty",
  "traceId": "174d6e0d78675e0c",
  "data": {
    "status": "FAILED"
  }
}
  • For code definitions, refer to the Error Codes. The message field contains the error description.
  • traceId is the trace number generated by this call. Provide it when reporting API call issues.

Common Errors FAQ

IssueResponse
Request reports missing system parameters.Check that all system parameters are correct. For POST requests, all parameters must be placed in the request body — not in the query string.