需要 read_payment 权限点。
更多权限点使用信息,请参考:
GET https://{handle}.myshopline.com/admin/openapi/v20260601/payments/store/balance_transactions.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handleopen001
查询 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 string
    SHOPLINE Payments 账户类型。有效枚举值包含:
    • PendingSettlementAccount:待结算账户。
    • PayoutAccount:可提现账户。
    • RevolvingMarginAccount:循环保证金账户。
    • FixedMarginAccount:固定保证金账户。
  • payout_id string
    提现交易序号。查询上一次提现交易发生时间(不包含)到本次 payout_id 对应交易时间(包含)之间的所有账单记录。
  • since_id string
    账单记录的 ID。传入该值后,会从指定的账单记录 ID 的创建时间(不包含该ID)开始查询账单记录。
  • start_time string
    指定要查询的账单的创建时间,在此日期或此日期之后发生的账单记录会被返回。如果没有指定 payout_id 参数,则start_timeend_time 参数必须同时指定,start_timeend_time 时间间隔不能超过 3 个月。格式:ISO 8601
    例子: 2025-04-30T00:00:00+08:00
  • end_time string
    指定要查询的账单的截止日期和时间,在此时间之前产生的账单会被返回。如果没有指定 payout_id 参数,则start_timeend_time 参数必须同时指定,start_timeend_time 时间间隔不能超过 3 个月。格式:ISO 8601
    例子: 2025-05-31T00:00:00+08:00
  • is_settlement_details string
    是否显示汇总结算记账的交易明细的账单记录。可选值为:
    • true:汇总结算记账时,只显示交易明细账单记录,不显示汇总结算记账的账单记录。
    • false:汇总结算记账时,只显示汇总结算记账的账单记录,不显示交易明细的账单记录。
    交易明细的账单是指 type 为以下枚举值的账单记录:
    • 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
    • TRANSFER
    汇总结算记账的账单是指 typeSETTLEMENT 的账单记录。
    默认值为:false
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
状态码
更多状态码信息,参考 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
    可提现账户冻结余额。显示为正数,数值保留到小数点后两位。
  • posting_time string
    SHOPLINE Payments 记账时间。格式:ISO 8601
    例子: 2025-05-31T10:00:00+08:00
  • 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
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260601

ParamOptions

header required
query
query
query
query
query
query
query
query

Language

curl --request GET \
--url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260601/payments/store/balance_transactions.json \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'accept: application/json'
Examples
根据 start_time 和 end_time 查询账单记录
Response
{
"transactions": [
{
"account_balance": "-21.85",
"account_currency": "AUD",
"account_identify_code": "106103602",
"account_type": "PayoutAccount",
"amount": "-0.10",
"exchange_rate": "0.0000000000",
"id": "2505290030107014918095689226834",
"interchange_fee": "0.00",
"net": "-0.10",
"payment_method_fee": null,
"payout_account_available_balance": "-24.22",
"payout_account_frozen_balance": "2.37",
"posting_time": "2025-05-29T00:30:07+08:00",
"revolving_margin_account_balance": "0.00",
"scheme_fee": "0.00",
"settlement_batch_id": "settlement_report_20250529_1",
"source_order_id": "21070058445751144992545567",
"source_order_transaction_id": "30012505287014075754036344870",
"transaction_amount": "-0.10",
"transaction_currency": "AUD",
"type": "REFUND_SUCCESS"
}
]
}
这篇文章对你有帮助吗?