API v1

对账

用任务账单接口核对每个任务的预留、扣款、退款和应收。

查看 Markdown
本页内容

每个任务都有一份账单:一个汇总加一串不可变的账单事件。汇总回答「这个任务一共收了多少」,事件回答「钱是怎么动的」。

读取账单

curl --request GET "${CHENVOYA_BASE_URL}/v1/video/tasks/${TASK_ID}/billing" \
  --header "Authorization: Bearer ${CHENVOYA_API_KEY}"

汇总属于整个任务,不会因为事件分页变成当前页的小计。事件按 cursor 和 page_size 翻页,最后一页的 next_cursor 为 null。

汇总字段

字段含义
reserved_amount任务预留的金额。
charged_amount任务的计费金额。
funding_debit_amount实际从余额扣减的金额。
funding_refund_amount实际退回余额的金额。
outstanding_receivable尚未收取的应收金额。
final_actual_cost最终实际费用;结算确定前为 null。

账单事件

每次资金变动都记一条事件,例如创建预留的 hold_created、收取费用的 charge_captured、释放预留的 hold_released。预留的创建、增加、减少和释放本身不表示扣款、退款或应收变动,金额以各金额字段为准。全部事件类型见「状态与原因」。

需要核对时

少数任务的用量需要核对,这时 settlement_status 为 reconciliation_required,final_actual_cost 为 null,reconciliation 给出核对原因 reason_code、缺少的计量字段 missing_meters,以及是否需要你操作的 customer_action_required。核对完成后结算状态变为 settled 或 settled_with_receivable。

关联标识

request_id 和 billing_correlation_id 在任务、账单和回调里保持一致,可以用来把你的订单和我们的账单对上。

下一步