获取收支明细列表

最近更新时间:2020-03-04 17:46:35

1. 接口描述

接口请求域名: billing.tencentcloudapi.com 。

获取收支明细列表,支持翻页和参数过滤

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBillList。
Version String 公共参数,本接口取值:2018-07-09。
Region String 公共参数,本接口不需要传递此参数。
StartTime String 查询范围的起始时间(包含)
EndTime String 查询范围的结束时间(包含)
Offset Integer 翻页偏移量,初始值为0
Limit Integer 每页的限制数量
PayType.N Array of String 交易类型: all所有交易类型,recharge充值,return退款,unblock解冻,agentin资金转入,advanced垫付,cash提现,deduct扣费,block冻结,agentout资金转出,repay垫付回款,repayment还款(仅国际信用账户),adj_refund调增(仅国际信用账户),adj_deduct调减(仅国际信用账户)
SubPayType.N Array of String 扣费模式,当所选的交易类型中包含扣费deduct时有意义: all所有扣费类型,trade预付费支付,hour_h按量小时结,hour_d按量日结,hour_m按量月结,decompensate调账扣费,other其他扣费
WithZeroAmount Integer 是否返回0元交易金额的交易项,取值:0-不返回,1-返回。不传该参数则不返回

3. 输出参数

参数名称 类型 描述
TransactionList Array of BillTransactionInfo 收支明细列表
Total Integer 总条数
ReturnAmount Float 退费总额,单位(分)
RechargeAmount Float 充值总额,单位(分)
BlockAmount Float 冻结总额,单位(分)
UnblockAmount Float 解冻总额,单位(分)
DeductAmount Float 扣费总额,单位(分)
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询账户收支明细

输入示例

https://billing.tencentcloudapi.com/?Action=DescribeBillListV2
&StartTime="2019-07-31 00:00:00"
&EndTime="2019-07-31 00:00:00"
&Offset=0
&Limit=20
&PayType.0="all"
&SubPayType.0="all"
&WithZeroAmount=1
&<公共请求参数>

输出示例

{
  "Response": {
    "Total": 120,
    "ReturnAmount": 1930,
    "DeductAmount": -11154,
    "RechargeAmount": 123,
    "BlockAmount": -11154,
    "UnblockAmount": 123254,
    "TransactionList": [
      {
        "OperationTime": "2020-01-15 14:30:36.669",
        "ActionType": "return",
        "OperationInfo": "调账补偿",
        "BillId": "20200226000000004873325998792782",
        "OutAmount": "253",
        "Balance": "-9412",
        "Cash": "0",
        "Incentive": "0",
        "Freezing": "0"
      }
    ],
    "RequestId": "541fe9dd-1dbb-4f85-96e2-0fd3"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误
目录