查询账单记录

需要 read_payment 权限点。

更多权限点使用信息，请参考：

GET https://{handle}.myshopline.com/admin/openapi/v20260301/payments/store/balance_transactions.json

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

查询SHOPLINE Payments账户的账单记录，支持分页查询。暂不支持POS业务

查询参数

limit string

查询数量限制，默认1000，不能超过10000

例子: 1000
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

提款记录id，筛选这笔提款对应的账单记录。备注：对于主体所属CN的店铺不支持这个字段的使用

例子: 202208031899561700999905280
payout_status string

提款状态，枚举值：in progress（处理中）；accepted by bank（银行已受理）；completed（已完成）；failed（打款失败）；retrying（重新打款中）；

例子: in progress
since_id string

账单记录的序号，筛选在这个序号之前发生的账单记录，用于since_id模式（查询第一页数据）。关于分页使用详情请参考分页机制。

例子: 202206161756376480011100000

请求头

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[]

账单记录列表。
source_order_transaction_id string

该笔账单记录来源的交易序号，包括支付订单号/退款订单号等
例子: 30010022516695225053195427840
currency string

交易币种，按ISO4217规范。
例子: USD
fee string

交易手续费，保留2位小数
例子: -0.76
net string

交易净额，保留两位小数
例子: 0.76
settlement_amount string

结算金额，保留 2 位小数。
例子: 1.00
processed_at string

处理时间，按ISO8601规范
例子: 2022-02-25T18:00:42+08:00
type string

账单类型。枚举值：payment （支付成功）；refund （退款发起）；refund_failure（退款失败）；chargeback（chargeback发起）；chargeback_won（chargeback胜诉）；reserve_held（保证金收取）；reserve_released（保证金释放）；accounting_adjustment（调账，涉及到可提现账户的调账数据）；transfer_in（充值成功）；payout（提现）
例子: fee_reversed
source_payment_id string

该笔交易的原支付订单号
例子: 10010022516695213198582620160
amount string

交易金额，保留2位小数。
例子: 1.00
exchange_rate string

换汇汇率。保留 10 位小数。示例：1.3000000000。
例子: 1.3000000000
payout_id string

提款序号
例子: 202208031899561700999905280
settlement_currency string

结算币种。该字段值为三位币种码，遵循 ISO 4217 国际标准。示例：CNY。
例子: USD
source_type string

该笔账单记录来源的交易类型，包括支付交易、退款交易、问题交易等。枚举值：payment；refund；dispute；adjustment；payout
例子: refund
transaction_time string

交易时间，按ISO8601规范
例子: 2022-02-25T18:00:42+08:00
id string

每笔账单记录的序号
例子: 202206161756376480011100000
payout_status string

提款状态。枚举值：in progress（处理中）；accepted by bank（银行已受理）；completed（已完成）；failed（打款失败）；retrying（重新打款中）。对于主体所属CN的店铺该字段为空
例子: in progress
source_order_id string

该笔账单记录来源的订单号码
例子: 8545173391

API Explorer

调试台

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

limit — query

page_info — query

payout_id — query

payout_status — query

since_id — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/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'

这篇文章对你有帮助吗？

SHOPLINE

条款协议