> ## Documentation Index
> Fetch the complete documentation index at: https://doc2.payloco.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Common Response

* Last Updated: 2022-01-16 21:31:02

## Common Response Parameters

| Parameter   | Type   | Description                                                                                                                           | Example             | Required |
| :---------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------ | :------------------ | :------- |
| code        | string | Response status code                                                                                                                  | 00000000            | Yes      |
| message     | string | Error message                                                                                                                         | Parameter error     | Yes      |
| traceId     | string | Unique identifier for the request. The traceId is the trace number generated by this call. Provide it when reporting API call issues. | 7457794513993866186 | Yes      |
| data        | Object | Business data as a JSON object. If the request fails, this field may contain detailed error information.                              | {}                  | Yes      |
| data.status | string | Order status (see notes below)                                                                                                        | SUCCESS             | Yes      |

#### Notes

<Tip>
  `status` represents the order status. For payment, refund, and reversal orders, the success or failure is determined by the value of `status`.
</Tip>

<Tip>
  `status` has four possible values: `PENDING`, `SUCCESS`, `FAILED`, `CLOSED`, representing processing, success, failure, and order closed respectively.
</Tip>

## Response Format

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

### Success Format

```json theme={null}
{
  "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

```json theme={null}
{
  "code": "22070030",
  "message": "Format error-transType cannot be empty",
  "traceId": "174d6e0d78675e0c",
  "data": {
    "status": "FAILED"
  }
}
```

* For `code` definitions, refer to the [Error Codes](/appendix/return-code). 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

| Issue                                      | Response                                                                                                                                      |
| :----------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- |
| 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. |
