查询交易流水¶
分页查询账户的充值、消费、赠送和退款等账务交易。
GET https://billing.moi.matrixorigin.cn/api/v1/billing/accounts/$ACCOUNT_ID/transactions
调用前准备¶
请求示例¶
将示例中的 $MOI_PERSONAL_ACCESS_TOKEN 和 $ACCOUNT_ID 分别替换为个人访问令牌和所选账户的 ID。
curl -X GET \
"https://billing.moi.matrixorigin.cn/api/v1/billing/accounts/$ACCOUNT_ID/transactions?page_size=2" \
-H "X-API-Key: $MOI_PERSONAL_ACCESS_TOKEN"
路径参数¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
目标账户的 ID,取自“查询当前账户”响应中的 |
查询参数¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
否 |
按记录创建时间筛选的起点,包含该时刻;支持 RFC 3339、 |
|
string |
否 |
按记录创建时间筛选的终点,不包含该时刻。日期值扩展到所选日期的次日零点。 |
|
string |
否 |
解析日期值的 IANA 时区;省略时使用 UTC。 |
|
string |
否 |
收入使用 income,支出使用 expense。 |
|
string |
否 |
按来源类型筛选:recharge、grant、consume、refund、reservation;也接受对应来源类型代码。 |
|
string |
否 |
按支付渠道或赠送来源渠道筛选。 |
|
string |
否 |
按来源订单、赠送审批或计费用量记录的状态筛选。 |
|
string |
否 |
搜索账务交易 ID、来源 ID、支付订单号、支付渠道交易号或赠送原因,不区分大小写。 |
|
string |
否 |
q 的兼容参数,仅在 q 为空时使用。 |
|
integer |
否 |
每页数量,1–100;省略、非正数或大于 100 时使用 50。 |
|
string |
否 |
下一页标记。首次请求省略;后续使用响应的 |
成功响应¶
请求成功时返回 HTTP 200 和账户的交易流水。
{
"items": [
{
"transaction_id": "transaction_example",
"ledger_txn_id": "ledger_example",
"billing_account_id": "billing_account_example",
"billing_account_owner_id": "owner_example",
"billing_account_display_name": "Example account",
"created_at": 1788739200,
"entry_type": "consume",
"source_type": "rated_usage_record",
"source_id": "rated_record_example",
"description": "Example usage",
"amount": "0.900000000000",
"balance_delta": "-0.900000000000",
"currency": "CREDIT",
"after_balance": "99.100000000000",
"detail_available": true
}
],
"total": 1,
"next_page_token": ""
}
字段 |
类型 |
说明 |
|---|---|---|
|
array of object |
本次返回的记录。 |
|
string |
交易记录 ID。 |
|
string |
账务交易 ID。 |
|
string |
Billing 账户 ID。 |
|
string |
账户归属主体 ID,可能省略。 |
|
string |
账户显示名称,可能省略。 |
|
integer |
创建时间,Unix 秒。 |
|
string |
账务分录类型。 |
|
string |
交易来源类型。 |
|
string |
交易来源对象 ID。 |
|
string |
交易来源渠道,存在时返回。 |
|
string |
交易说明。 |
|
string |
交易金额的十进制字符串,单位由 currency 指定。 |
|
string |
余额变化量,收入为正,支出为负。 |
|
string |
交易单位;Credit 交易返回 |
|
string |
账务分录记录的变更后余额。 |
|
string |
关联充值订单号,存在时返回。 |
|
boolean |
是否有可用的交易来源明细。 |
|
integer |
符合筛选条件的总记录数。 |
|
string |
下一页标记;空字符串表示没有下一页。 |
字段路径中的 [] 表示数组中的每一项。例如,items[].transaction_id 表示数组中每一项的对应字段。
继续查询时,将响应中的 next_page_token 保存为 $NEXT_PAGE_TOKEN,保持筛选条件不变。标记为空时停止翻页。
curl -X GET \
"https://billing.moi.matrixorigin.cn/api/v1/billing/accounts/$ACCOUNT_ID/transactions?page_size=2&page_token=$NEXT_PAGE_TOKEN" \
-H "X-API-Key: $MOI_PERSONAL_ACCESS_TOKEN"
错误响应¶
缺少认证信息时返回 HTTP 401,请提供有效的个人访问令牌。
{
"code": "unauthenticated",
"message": "missing bearer token",
"error": "missing bearer token"
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
错误说明。 |
|
string |
兼容错误说明,与 message 内容相同。 |