查询账单记录
GET https://{handle}.myshopline.com/admin/openapi/v20260901/payments/store/balance_transactions.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。查询 SHOPLINE Payments 账户的账单。
查询参数
- account_type stringSHOPLINE Payments 账户类型。有效枚举值包含:
PendingSettlementAccount:待结算账户。PayoutAccount:可提现账户。RevolvingMarginAccount:循环保证金账户。FixedMarginAccount:固定保证金账户。
- merchant_id stringSHOPLINE Payments 商户的唯一标识符 ID。
- 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。关于更多如何使用分页信息,请参考 分页机制。例子:eyJwYXlvdXRTdGF0dXMiOiJjb21wbGV0ZWQiLCJzaW5jZUlkIjoiMjAyMjA3MjkxNDUxMjIzODIwMDExMTMwMDAwIiwicGFnZVR5cGUiOiJORVhUIn0%3D - payout_id string提现交易序号。查询上一次提现交易发生时间(不包含)到本次
payout_id对应交易时间(包含)之间的所有账单记录。例子:202208031899561700999905280 - 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:汇总结算记账时,只显示汇总结算记账的账单记录,不显示交易明细的账单记录。
默认值为:false汇总结算记账的账单是指type为SETTLEMENT的账单记录。交易明细的账单是指type字段取值为各交易场景下对应枚举值的账单记录:-
支付交易
PAYMENTPAYMENT_FEE_RETURNED
-
退款交易
REFUNDREFUND_FEEREFUND_FROZENREFUND_UNFROZENREFUND_FEE_FROZENREFUND_FEE_UNFROZEN
-
预拒付
PRE_CHARGEBACK_FROZENPRE_CHARGEBACK_UNFROZENPRE_CHARGEBACK_FEE_FROZENPRE_CHARGEBACK_FEE_UNFROZENPRE_CHARGEBACK_ACCEPTEDPRE_CHARGEBACK_FEE
-
拒付
CHARGEBACK_INITIATEDCHARGEBACK_FEECHARGEBACK_WONCHARGEBACK_LOSTCHARGEBACK_FROZENCHARGEBACK_UNFROZENCHARGEBACK_FEE_FROZENCHARGEBACK_FEE_UNFROZENCHARGEBACK_LOST_FROZENCHARGEBACK_LOST_UNFROZENCHARGEBACK_WON_FUND_RETURNCHARGEBACK_LOST_FUND_RETURN
-
预仲裁
PRE_ARBITRATION_INITIATEDPRE_ARBITRATION_FEEPRE_ARBITRATION_INITIATED_FUND_RETURNPRE_ARBITRATION_WONPRE_ARBITRATION_WON_FUND_RETURNPRE_ARBITRATION_LOSTPRE_ARBITRATION_FROZENPRE_ARBITRATION_UNFROZENPRE_ARBITRATION_FEE_FROZENPRE_ARBITRATION_FEE_UNFROZENPRE_ARBITRATION_LOST_FROZENPRE_ARBITRATION_LOST_UNFROZENPRE_ARBITRATION_LOST_FUND_RETURN
-
仲裁
ARBITRATION_INITIATEDARBITRATION_FEEARBITRATION_WONARBITRATION_WON_FEE_RETURNEDARBITRATION_LOSTARBITRATION_FROZENARBITRATION_UNFROZENARBITRATION_FEE_FROZENARBITRATION_FEE_UNFROZENARBITRATION_INITIATED_FUND_RETURN
-
保证金
FIXED_RESERVE_COLLECTEDFIXED_RESERVE_RELEASEDROLLING_RESERVE_COLLECTEDROLLING_RESERVE_RELEASED_TO_FIXED_RESERVEROLLING_RESERVE_RELEASED_TO_PAYOUT_ACCOUNT
-
提现
PAYOUTPAYOUT_FAILEDPAYOUT_RETURNEDPAYOUT_FEEPAYOUT_FROZENPAYOUT_UNFROZENPAYOUT_FEE_FROZENPAYOUT_FEE_UNFROZEN
-
财务
TRANSFERPLATFORM_TRANSFERPLATFORM_TRANSFER_FEEADJUSTMENT
-
- limit string每页账单记录的条数限制。取值范围:1-100默认值:50
- since_id string账单记录的 ID。传入该值后,会从指定的账单记录 ID 的创建时间(不包含该 ID)开始查询账单记录。例子:
202206161756376480011100000 - start_time string指定要查询的账单的创建日期和时间,在此时间或此时间之后发生的账单记录会被返回。如果没有指定
payout_id参数,则start_time和end_time参数必须同时指定,start_time和end_time时间间隔不能超过 3 个月。格式:ISO 8601。例子:2025-04-30T00:00:00+08:00
请求头
- 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账户余额。数值保留到小数点后两位。例子:1000.00account_currency string账户币种。该字段值为三位币种码,遵循 ISO 4217 国际标准,例如CNY。account_identify_code string账户识别码。例子:100001account_type string账户类型。有效枚举值包含:PendingSettlementAccount:待结算账户。PayoutAccount:可提现账户。RevolvingMarginAccount:循环保证金账户。FixedMarginAccount:固定保证金账户。
amount string结算金额。数值保留到小数点后两位。SHOPLINE Payments 收取商家费用则显示为负数,SHOPLINE Payments 退还商家费用则显示为正数。例子:0.24exchange_rate string结算汇率。结算汇率=交易金额/结算金额。数值保留到小数点后 10 位,显示为正数。例子:1.3000000000id string账单记录的唯一标识。例子:202206161756376480011100000interchange_fee string发卡行费用。数值保留到小数点后两位。取值为负数,表示收取商家手续费。例子:-0.09net string交易净额。交易净额=结算金额+发卡行费用+卡组织费用+支付方式费用+循环保证金金额。数值保留到小数点后两位。例子:0.24other_fee string其他手续费。数值保留到小数点后两位。例子:-0.51payment_method_fee string支付方式手续费。数值保留到小数点后两位。SHOPLINE Payments 收取商家手续费则显示为负数,SHOPLINE Payments 退还商家手续费则显示为正数。例子:-0.06payout_account_available_balance string可提现账户可用余额。数值保留到小数点 后两位。例子:100.01payout_account_frozen_balance string可提现账户冻结余额。显示为正数,数值保留到小数点后两位。例子:0.01revolving_margin_account_balance string循环保证金金额。数值保留到小数点后两位。SHOPLINE Payments 扣除商家循环保证金则显示为负数,SHOPLINE Payments 退还商家循环保证金则显示为正数。例子:0.01scheme_fee string卡组织费用。数值保留到小数点后两位。显示为负数,表示SHOPLINE Payments 收取商家手续费。例子:-0.11settlement_batch_id string结算批次序号。source_order_id string该笔账单记录来源的订单号码。例子:30010022516695225053195427840source_order_transaction_id string该笔账单记录来源的交易序号。例如,支付订单号、退款订单号等。例子:10010022516695213198582620160total_fee string总手续费。数值保留到小数点后两位。例子:-0.76transaction_amount string交易金额。数值保留到小数点后两位。例子:1.01transaction_currency string交易币种。该字段值为三位币种码,遵循 ISO 4217 国际标准,例如CNY。type string账单类型。有效枚举值按交易场景分类如下:- 支付交易
PAYMENT:支付成功,交易资金入账待结算账户。PAYMENT_FEE_RETURNED:支付手续费退还,可提现账户资金增加。SETTLEMENT:资金结算完成,待结算账户资金转入可提现账户。
- 退款交易
REFUND:退款成功,可提现账户资金扣减。REFUND_FEE:退款手续费扣除,可提现账户资金扣减。REFUND_FROZEN:退款金额冻结,可提现账户资金冻结,冻结账户资金增加。REFUND_UNFROZEN:退款金额解冻,冻结账户资金减少,可提现账户资金解冻。REFUND_FEE_FROZEN:退款手续费冻结,可提现账户资金冻结,冻结账户资金增加。REFUND_FEE_UNFROZEN:退款手续费解冻,冻结账户资金减少,可提现账户资金解冻。
- 预拒付
PRE_CHARGEBACK_FROZEN:预拒付金额冻结,可提现账户资金冻结,冻结账户资金增加。PRE_CHARGEBACK_UNFROZEN:预拒付金额解冻,冻结账户资金减少,可提现账户资金解冻。PRE_CHARGEBACK_FEE_FROZEN:预拒付手续费冻结,可提现账户资金冻结,冻结账户资金增加。PRE_CHARGEBACK_FEE_UNFROZEN:预拒付手续费解冻,冻结账户资金减少,可提现账户资金解冻。PRE_CHARGEBACK_ACCEPTED:预拒付接受,可提现账户资金扣减。PRE_CHARGEBACK_FEE:预拒付手续费扣除,可提现账户资金扣减。
- 拒付
CHARGEBACK_INITIATED:拒付发起,可提现账户资金扣减。CHARGEBACK_FEE:拒付手续费扣除,可提现账户资金扣减。CHARGEBACK_WON:拒付胜诉,可提现账户资金增加。CHARGEBACK_LOST:拒付败诉,可提现账户资金扣减。CHARGEBACK_FROZEN:拒付金额冻结,可提现账户资金冻结,冻结账户资 金增加。CHARGEBACK_UNFROZEN:拒付金额解冻,冻结账户资金减少,可提现账户资金解冻。CHARGEBACK_FEE_FROZEN:拒付手续费冻结,可提现账户资金冻结,冻结账户资金增加。CHARGEBACK_FEE_UNFROZEN:拒付手续费解冻,冻结账户资金减少,可提现账户资金解冻。CHARGEBACK_LOST_FROZEN:拒付败诉金额冻结,可提现账户资金冻结,冻结账户资金增加。CHARGEBACK_LOST_UNFROZEN:拒付败诉金额解冻,冻结账户资金减少,可提现账户资金解冻。CHARGEBACK_WON_FUND_RETURN:拒付胜诉资金返还,可提现账户资金增加。CHARGEBACK_LOST_FUND_RETURN:拒付败诉资金返还,可提现账户资金增加。
- 预仲裁
PRE_ARBITRATION_INITIATED:预仲裁发起,可提现账户资金扣减。PRE_ARBITRATION_FEE:预仲裁手续费扣除,可提现账户资金扣减。PRE_ARBITRATION_INITIATED_FUND_RETURN:预仲裁发起资金返还,可提现账户资金增加。PRE_ARBITRATION_WON:预仲裁胜诉,可提现账户资金增加。PRE_ARBITRATION_WON_FUND_RETURN:预仲裁胜诉资金返还,可提现账户资金增加。PRE_ARBITRATION_LOST:预仲裁败诉,可提现账户资金扣减。PRE_ARBITRATION_FROZEN:预仲裁金额冻结,可提现账户资金冻结,冻结账户资金增加。PRE_ARBITRATION_UNFROZEN:预仲裁金额解冻,冻结账户资金减少,可提现账户资金解冻。PRE_ARBITRATION_FEE_FROZEN:预仲裁手续费冻结,可提现账户资金冻结,冻结账户资金增加。PRE_ARBITRATION_FEE_UNFROZEN:预仲裁手续费解冻,冻结账户资金减少 ,可提现账户资金解冻。PRE_ARBITRATION_LOST_FROZEN:预仲裁败诉金额冻结,可提现账户资金冻结,冻结账户资金增加。PRE_ARBITRATION_LOST_UNFROZEN:预仲裁败诉金额解冻,冻结账户资金减少,可提现账户资金解冻。PRE_ARBITRATION_LOST_FUND_RETURN:预仲裁败诉资金返还,可提现账户资金增加。
- 仲裁
ARBITRATION_INITIATED:仲裁发起,可提现账户资金扣减。ARBITRATION_FEE:仲裁手续费扣除,可提现账户资金扣减。ARBITRATION_WON:仲裁胜诉,可提现账户资金增加。ARBITRATION_WON_FEE_RETURNED:仲裁胜诉手续费返还,可提现账户资金增加。ARBITRATION_LOST:仲裁败诉,可提现账户资金扣减。ARBITRATION_FROZEN:仲裁金额冻结,可提现账户资金冻结,冻结账户资金增加。ARBITRATION_UNFROZEN:仲裁金额解冻,冻结账户资金减少,可提现账户资金解冻。ARBITRATION_FEE_FROZEN:仲裁手续费冻结,可提现账户资金冻结,冻结账户资金增加。ARBITRATION_FEE_UNFROZEN:仲裁手续费解冻,冻结账户资金减少,可提现账户资金解冻。ARBITRATION_INITIATED_FUND_RETURN:仲裁发起资金返还,可提现账户资金增加。
- 保证金
FIXED_RESERVE_COLLECTED:固定保证金缴存,固定保证金账户资金增加。FIXED_RESERVE_RELEASED:固定保证金释放,固定保证金账户资金释放至可提现账户。ROLLING_RESERVE_COLLECTED:循环保证金缴存,循环保证金账户资金增加。ROLLING_RESERVE_RELEASED_TO_FIXED_RESERVE:循环保证金划转至固定 保证金账户,固定保证金账户资金增加,循环保证金账户资金减少。ROLLING_RESERVE_RELEASED_TO_PAYOUT_ACCOUNT:循环保证金结算至可提现账户,可提现账户资金增加,循环保证金账户资金减少。
- 提现
PAYOUT:提现成功,可提现账户资金扣减。PAYOUT_FAILED:提现失败,冻结资金解冻,可提现账户资金解冻。PAYOUT_RETURNED:提现退回,可提现账户资金增加。PAYOUT_FEE:提现手续费扣除,可提现账户资金扣减。PAYOUT_FROZEN:提现金额冻结,可提现账户资金冻结,冻结账户资金增加。PAYOUT_UNFROZEN:提现金额解冻,冻结账户资金减少,可提现账户资金解冻。PAYOUT_FEE_FROZEN:提现手续费冻结,可提现账户资金冻结,冻结账户资金增加。PAYOUT_FEE_UNFROZEN:提现手续费解冻,冻结账户资金减少,可提现账户资金解冻。
- 财务
TRANSFER:账户内资金划转,转出账户资金减少,转入账户资金增加。PLATFORM_TRANSFER:平台间资金划转,转出账户资金减少,转入账户资金增加。PLATFORM_TRANSFER_FEE:平台划转手续费扣除,可提现账户资金扣减。ADJUSTMENT:系统调账,对应账户资金增加或减少。
API Explorer
调试台
示例代码
这篇文章对你有帮助吗?