Operation details
GET /v1/admin/recharges/orders
List reconciled recharge order heads
- operationId
listAdminRechargeOrders- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
The contract has no separate permission annotation; see the description below and the 403 response.
Parameters
listAdminRechargeOrders Parameters| Name | In | Type | Required | Description |
|---|
X-Request-ID | header | string | Yes | — |
|---|
page | query | integer | No | — |
|---|
limit | query | integer | No | — |
|---|
channel | query | string: alipay / wechat / transfer / usdt | No | — |
|---|
state | query | string: pending / paid / partially_refunded / refunded / voided / failed / canceled / reconcile_required | No | — |
|---|
tenant_scope_id | query | string(uuid) | No | — |
|---|
user_id | query | string(uuid) | No | — |
|---|
from | query | string(date-time) | No | — |
|---|
to | query | string(date-time) | No | — |
|---|
snapshot_at | query | string(date-time) | No | Reuse snapshot_at returned by the first page to keep later pages and CSV on the same fact boundary. |
|---|
Responses
listAdminRechargeOrders Responses| Status | Description |
|---|
200 | Stable database snapshot Fields：items: array<RechargeOrder> total: integer(int64) page: integer limit: integer snapshot_at: string(date-time) |
|---|
400 | Stable error code; message is not safe for direct UI rendering |
|---|
401 | Stable error code; message is not safe for direct UI rendering |
|---|
403 | Stable error code; message is not safe for direct UI rendering |
|---|
What to do on failure
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
↑ Back to list
GET /v1/admin/recharges/orders/{order_id}/reconciliation
Read exact order, callback, ledger and statistics identities
- operationId
getRechargeReconciliation- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
The contract has no separate permission annotation; see the description below and the 403 response.
Parameters
getRechargeReconciliation Parameters| Name | In | Type | Required | Description |
|---|
X-Request-ID | header | string | Yes | — |
|---|
order_id | path | string(uuid) | Yes | — |
|---|
Responses
getRechargeReconciliation Responses| Status | Description |
|---|
200 | Exact four-way reconciliation Fields：order: RechargeOrder callback: RechargeCallbackFact ledger: RechargeLedgerFact statistic: RechargeStatistic provider_events: array<RechargeProviderEventFact> ledger_entries: array<RechargeLedgerFact> gross_amount_minor: integer(int64) refunded_amount_minor: integer(int64) net_amount_minor: integer(int64) |
|---|
401 | Stable error code; message is not safe for direct UI rendering |
|---|
403 | Stable error code; message is not safe for direct UI rendering |
|---|
404 | Stable error code; message is not safe for direct UI rendering |
|---|
503 | Stable error code; message is not safe for direct UI rendering |
|---|
What to do on failure
401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.404 The resource does not exist or belongs to another tenant.503 A dependency is unavailable: retry later with the original Idempotency-Key.
↑ Back to list
GET /v1/admin/recharges/statistics
List immutable settlement statistics facts
- operationId
listRechargeStatistics- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
The contract has no separate permission annotation; see the description below and the 403 response.
Parameters
listRechargeStatistics Parameters| Name | In | Type | Required | Description |
|---|
X-Request-ID | header | string | Yes | — |
|---|
page | query | integer | No | — |
|---|
limit | query | integer | No | — |
|---|
channel | query | string: alipay / wechat / transfer / usdt | No | — |
|---|
tenant_scope_id | query | string(uuid) | No | — |
|---|
user_id | query | string(uuid) | No | — |
|---|
from | query | string(date-time) | Yes | — |
|---|
to | query | string(date-time) | Yes | — |
|---|
snapshot_at | query | string(date-time) | No | Reuse snapshot_at returned by the first page to keep later pages and CSV on the same fact boundary. |
|---|
Responses
listRechargeStatistics Responses| Status | Description |
|---|
200 | Totals and rows from one stable snapshot Fields：items: array<RechargeStatistic> total_amount_minor: integer(int64) total_gross_amount_minor: integer(int64) total_refunded_amount_minor: integer(int64) total_net_amount_minor: integer(int64) total_orders: integer(int64) page: integer limit: integer snapshot_at: string(date-time) |
|---|
400 | Stable error code; message is not safe for direct UI rendering |
|---|
401 | Stable error code; message is not safe for direct UI rendering |
|---|
403 | Stable error code; message is not safe for direct UI rendering |
|---|
What to do on failure
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
↑ Back to list
GET /v1/admin/recharges/statistics.csv
Export the same bounded settlement snapshot as CSV
- operationId
exportRechargeStatistics- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
The contract has no separate permission annotation; see the description below and the 403 response.
Parameters
exportRechargeStatistics Parameters| Name | In | Type | Required | Description |
|---|
X-Request-ID | header | string | Yes | — |
|---|
channel | query | string: alipay / wechat / transfer / usdt | No | — |
|---|
tenant_scope_id | query | string(uuid) | No | — |
|---|
user_id | query | string(uuid) | No | — |
|---|
from | query | string(date-time) | Yes | — |
|---|
to | query | string(date-time) | Yes | — |
|---|
snapshot_at | query | string(date-time) | No | Reuse snapshot_at returned by the first page to keep later pages and CSV on the same fact boundary. |
|---|
Responses
exportRechargeStatistics Responses| Status | Description |
|---|
200 | UTF-8 CSV, at most 10000 facts |
|---|
400 | Stable error code; message is not safe for direct UI rendering |
|---|
401 | Stable error code; message is not safe for direct UI rendering |
|---|
403 | Stable error code; message is not safe for direct UI rendering |
|---|
What to do on failure
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
↑ Back to list