查询账单记录
GET https://{handle}.myshopline.com/admin/openapi/v20260601/payments/store/balance_transactions.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。查询 SHOPLINE Payments 账户的账单。
查询参数
- limit string每页记录条数限制。取值范围:1-100默认值:50
- page_info string分页查询的唯一标识,用于定位特定页面。该字段值需要在你已经查询完分页信息后,在该接口响应头中的
link字段值中获取。例如,你获取到的link的值为<https://{handle}.myshopline.com/admin/openapi/{version}/payments/store/balance_transactions.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next",那么page_info的值为eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9。关于更多如何使用分页信息,请参考 分页机制。 - account_type stringSHOPLINE Payments 账户类型。有效枚举值包含:
PendingSettlementAccount:待结算账户。PayoutAccount:可提现账户。RevolvingMarginAccount:循环保证金账户。FixedMarginAccount:固定保证金账户。
- payout_id string提现交易序号。查询上一次提现交易发生时间(不包含)到本次
payout_id对应交易时间(包含)之间的所有账单记录。 - since_id string账单记录的 ID。传入该值后,会从指定的账单记录 ID 的创建时间(不包含该ID)开始查询账单记录。
- start_time string指定要查询的账单的创建时间,在此日期或此日期之后发生的账单记录会被返回。如果没有指定
payout_id参数,则start_time和end_time参数必须同时指定,start_time和end_time时间间隔不能超过 3 个月。格式:ISO 8601。例子:2025-04-30T00:00:00+08:00 - end_time string指定要查询的账单的截止日期和时间,在此时间之前产生的账单会被返回。如果没有指定
payout_id参数,则start_time和end_time参数必须同时指定,start_time和end_time时间间隔不能超过 3 个月。 格式:ISO 8601。例子:2025-05-31T00:00:00+08:00 - is_settlement_details string是否显示汇总结算记账的交易明细的账单记录。可选值为:
true:汇总结算记账时,只显示交易明细账单记录,不显示汇总结算记账的账单记录。false:汇总结算记账时,只显示汇总结算记账的账单记录,不显示交易明细的账单记录。
交易明细的账单是指type为以下枚举值的账单记录:ADJUSTMENTCHARGEBACK_FEECHARGEBACK_FEE_FROZENCHARGEBACK_FEE_UNFROZENCHARGEBACK_FROZENCHARGEBACK_INITIATEDCHARGEBACK_LOSTCHARGEBACK_UNFROZENCHARGEBACK_WONFIXED_RESERVE_COLLECTEDFIXED_RESERVE_RELEASEDPAYMENTPAYMENT_FEE_RETURNEDPAYOUTPAYOUT_FAILEDPAYOUT_FEEPAYOUT_FEE_FROZENPAYOUT_FEE_UNFROZENPAYOUT_FROZENPAYOUT_RETURNEDPAYOUT_UNFROZENPRE_CHARGEBACK_ACCEPTEDPRE_CHARGEBACK_FEEPRE_CHARGEBACK_FEE_FROZENPRE_CHARGEBACK_FEE_UNFROZENPRE_CHARGEBACK_FROZENPRE_CHARGEBACK_REJECTEDPRE_CHARGEBACK_UNFROZENREFUNDREFUND_FAILEDREFUND_FEEREFUND_FEE_FROZENREFUND_FEE_UNFROZENREFUND_FROZENREFUND_INITIATEDREFUND_UNFROZENROLLING_RESERVE_COLLECTEDROLLING_RESERVE_SETTLED_TO_FIXED_RESERVEROLLING_RESERVE_SETTLED_TO_PAYOUT_ACCOUNTTRANSFER
汇总结算记账的账单是指type为SETTLEMENT的账单记录。默认值为:false。
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应 用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
状态码
- 200
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
link
提供分页数据的 URL 链接。你可以获取该字段值中的page_info信息用于下一次分页请求中。当你请求的页面存在上一页或下一页的时候,该字段会被返回。关于更多如何使用分页信息,请参考 分页机制。traceId
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
transactionsobject[]
商家的SHOPLINE Payments 账户的账单详情。account_balance string账户余额。数值保留到小数点后两位。account_currency string账户币种。该字段值为三位币种码,遵循 ISO 4217 国际标准,例如CNY。account_identify_code string账户识别码。account_type string账户类型。有效枚举值包含:PendingSettlementAccount:待结算账户。PayoutAccount:可提现账户。RevolvingMarginAccount:循环保证金账户。FixedMarginAccount:固定保证金账户。
amount string结算金额。数值保留到小数点后两位。SHOPLINE Payments 收取商家费用则显示为负数,SHOPLINE Payments 退还商家费用则显示为正数。exchange_rate string结算汇率。结算汇率=交易金额/结算金额。数值保留到小数点后 10 位,显示为正数。id string账单记录的唯一标识。interchange_fee string发卡行费用 。数值保留到小数点后两位。取值为负数,表示收取商家手续费。net string交易净额。交易净额=结算金额+发卡行费用+卡组织费用+支付方式费用+循环保证金金额。数值保留到小数点后两位。payment_method_fee string支付方式手续费。数值保留到小数点后两位。SHOPLINE Payments 收取商家手续费则显示为负数,SHOPLINE Payments 退还商家手续费则显示为正数。payout_account_available_balance string可提现账户可用余额。数值保留到小数点后两位。payout_account_frozen_balance string可提现账户冻结余额。显示为正数,数值保留到小数点后两位。revolving_margin_account_balance string循环保证金金额。数值保留到小数点后两位。SHOPLINE Payments 扣除商家循环保证金则显示为负数,SHOPLINE Payments 退还商家循环保证金则显示为正数。scheme_fee string卡组织费用。数值保留到小数点后两位。显示为负数,表示SHOPLINE Payments 收取商家手续费。settlement_batch_id string结算批次序号。source_order_id string该笔账单记录来源的订单号码。source_order_transaction_id string该笔账单记录来源的交易序号。例如,支付订单号、退款订单号等。transaction_amount string交易金额。数值保留到小数点后两位。transaction_currency string交易币种。该字段值为三位币种码,遵循 ISO 4217 国际标准,例如CNY。type string账单类型。有效枚举值包括:ADJUSTMENT:调账CHARGEBACK_FEE:因拒付产生的手续费CHARGEBACK_FEE_FROZEN:拒付手续费冻结CHARGEBACK_FEE_UNFROZEN:拒付手续费解冻CHARGEBACK_FROZEN:拒付冻结CHARGEBACK_INITIATED:拒付发起CHARGEBACK_LOST:拒付败诉CHARGEBACK_UNFROZEN:拒付解冻CHARGEBACK_WON:拒付胜诉FIXED_RESERVE_COLLECTED:固定保证金收取FIXED_RESERVE_RELEASED:固定保证金释放PAYMENT:支付成功PAYMENT_FEE_RETURNED:支付手续费退回PAYOUT:提现PAYOUT_FAILED:提现失败PAYOUT_FEE:提现手续费PAYOUT_FEE_FROZEN:提现手续费冻结PAYOUT_FEE_UNFROZEN:提现手续费解冻PAYOUT_FROZEN:提现冻结PAYOUT_RETURNED:提现退回PAYOUT_UNFROZEN:提现解冻PRE_CHARGEBACK_ACCEPTED:预拒付接受PRE_CHARGEBACK_FEE:预拒付手续费PRE_CHARGEBACK_FEE_FROZEN:预拒付手续费冻结PRE_CHARGEBACK_FEE_UNFROZEN:预拒付手续费解冻PRE_CHARGEBACK_FROZEN:预拒付冻结PRE_CHARGEBACK_REJECTED:预拒付拒绝PRE_CHARGEBACK_UNFROZEN:预拒付解冻REFUND:退款成功REFUND_FAILED:退款失败REFUND_FEE:退款手续费REFUND_FEE_FROZEN:退款手续费冻结REFUND_FEE_UNFROZEN:退款手续费解冻REFUND_FROZEN:退款冻结REFUND_INITIATED:退款发起REFUND_UNFROZEN:退款解冻ROLLING_RESERVE_COLLECTED:循环保证金收取ROLLING_RESERVE_SETTLED_TO_FIXED_RESERVE:循环保证金释放到固定保证金账户ROLLING_RESERVE_SETTLED_TO_PAYOUT_ACCOUNT:循环保证金释放到可提现账户SETTLEMENT:结算TRANSFER:充值WITHHOLDING_PAYMENT:消费WITHHOLDING_PAYMENT_RETURNED:消费退回
API Explorer
调试台
示例代码
这篇文章对你有帮助吗?