Overview
Ledger events reconcile recharges, holds, settlements, and refunds. Use stable event types and amount fields; do not infer business state from display copy.
Authentication: Bearer API key
Request
Query parameters
| Name | Type | Description |
|---|---|---|
page | integer | Page number, starting at 1. |
page_size | integer | Items per page, 1–100; default 20. |
event_type | string | Filter by stable ledger event type. |
Response
JSON endpoints use the standard response envelope. HTTP status represents the request outcome; business errors are not disguised as HTTP 200.
| HTTP | Meaning |
|---|---|
200 | Request succeeded |
400 | Invalid business parameter or filter |
401 | Missing or invalid API key |
403 | API key disabled or access forbidden |
422 | Request-structure validation failed |
500 | Internal service error |
Complete success example (optional fields vary by state)
{
"code": 0,
"message": "success",
"data": {
"items": [],
"total": 0,
"page": 1,
"page_size": 20
},
"request_id": "8f25b42f-2ed1-4ad7-99de-61d7f779bc7b",
"timestamp": "2026-08-10T00:00:00Z"
}Important boundaries
- This read-only query never changes balance or task state.