DescribeRechargeRefundHistory

1. API Description

This API is used to query recharge and refund history.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
pageNum	No	Integer	Number of pages returned. Default value: 1.
pageSize	No	Integer	Number of items in the current page result. Maximum value: 5000.
state	No	Array of RechargeState	Recharge type.
startTime	No	Date	Start time. For example: 2023-08-15T09:47:01Z.
endTime	No	Date	End time. For example: 2023-08-15T09:47:01Z.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
totalCount	Integer	Number of recharges and refunds meeting the filtering conditions.
dataSet	Array of RechargeRefundHistory	Information on recharges and refunds.

4. Code Example

Example

Query recharge and refund history.

POST /api/v2/zbc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeRechargeRefundHistory
<Common Request Params>

Request:
{
  "endTime": "2023-09-05T14:26:18Z",
  "startTime": "2023-08-05T14:26:18Z",
  "pageSize": 10,
  "pageNum": 1,
  "state":["PAY_SUCCESS"]
}

Response:
{
    "requestId": "TB11F9883-9134-460B-AA54-7079B3DAD308",
    "response": {
        "requestId": "TB11F9883-9134-460B-AA54-7079B3DAD308",
        "totalCount": 1,
        "dataSet": [
            {
                "transactionType": "ORDER_REFUND",
                "amount": 39.05,
                "paymentMethod": "REFUND",
                "state": "PAY_SUCCESS",
                "transactionTime": "2023-08-15T09:47:01Z",
                "accountUid": "cccbf4c0-12ab-417a-95ba-0bf8e60a55d1",
                "transactionId": "10000000893685"
            }
        ]
    }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​​