查询账单记录

需要 read_payment 权限点。

更多权限点使用信息,请参考:

[]

访问权限

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

[]

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

[]

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

查询参数

limit string
[]
查询数量限制，默认1000，不能超过10000
[]
Example: 1000
page_info string
[]
分页参数，在 link 响应头中获取，用于page_info模式（查询非第一页数据）。关于分页使用详情请参考分页机制。
[]
Example: eyJwYXlvdXRTdGF0dXMiOiJjb21wbGV0ZWQiLCJzaW5jZUlkIjoiMjAyMjA3MjkxNDUxMjIzODIwMDExMTMwMDAwIiwicGFnZVR5cGUiOiJORVhUIn0%3D
payout_id string
[]
提款记录id，筛选这笔提款对应的账单记录。备注：对于主体所属CN的店铺不支持这个字段的使用
[]
Example: 202208031899561700999905280
payout_status string
[]
提款状态，枚举值：in progress（处理中）；accepted by bank（银行已受理）；completed（已完成）；failed（打款失败）；retrying（重新打款中）；
[]
Example: in progress
since_id string
[]
账单记录的序号，筛选在这个序号之前发生的账单记录，用于since_id模式（查询第一页数据）。关于分页使用详情请参考分页机制。
[]
Example: 202206161756376480011100000

请求头

Content-Type required
[]
字段值固定为application/json; charset=utf-8
Authorization string required
[]
资源的访问令牌。请参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

响应

[]

更多状态码信息请参考 HTTP 状态码

响应头

link
[]
分页参数, 关于分页使用详情请参考分页机制
traceId
[]
traceId

响应体

transactionsobject[]
[]
账单记录列表
amount string
[]
交易金额，保留两位小数
[]
Example: 0.00
currency string
[]
交易币种，按ISO4217规范
[]
Example: USD
fee string
[]
交易手续费，保留两位小数
[]
Example: -0.76
id string
[]
每笔账单记录的序号
[]
Example: 202206161756376480011100000
net string
[]
交易净额，保留两位小数
[]
Example: 0.76
payout_id string
[]
提款序号
[]
Example: 202208031899561700999905280
payout_status string
[]
提款状态。枚举值：in progress（处理中）；accepted by bank（银行已受理）；completed（已完成）；failed（打款失败）；retrying（重新打款中）。对于主体所属CN的店铺该字段为空
[]
Example: in progress
processed_at string
[]
处理时间，按ISO8601规范
[]
Example: 2022-02-25T18:00:42+08:00
source_order_id string
[]
该笔账单记录来源的订单号码
[]
Example: 8545173391
source_order_transaction_id string
[]
该笔账单记录来源的交易序号，包括支付订单号/退款订单号等
[]
Example: 30010022516695225053195427840
source_payment_id string
[]
该笔交易的原支付订单号
[]
Example: 10010022516695213198582620160
source_type string
[]
该笔账单记录来源的交易类型，包括支付交易、退款交易、问题交易等。枚举值：payment；refund；dispute；adjustment；payout
[]
Example: refund
transaction_time string
[]
交易时间，按ISO8601规范
[]
Example: 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（提现）
[]
Example: fee_reversed

API Explorer

调试台

示例代码

Base URL

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

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/v20220601/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

查询店铺账单记录

Response

{
  "transactions": [
    {
      "amount": "1.00",
      "currency": "USD",
      "fee": "0.33",
      "id": "202207310625596720011010000",
      "net": "0.67",
      "payout_id": "202102091116759120448919552",
      "payout_status": "failed",
      "processed_at": "2021-01-29T21:56:47+08:00",
      "source_order_id": "PA4724471486365876267",
      "source_order_transaction_id": "20210129215554467240132500000",
      "source_payment_id": "20210129215554467240132500000",
      "source_type": "payment",
      "transaction_time": "2021-01-29T21:56:47+08:00",
      "type": "payment"
    },
    {
      "amount": "1.00",
      "currency": "USD",
      "fee": "0.33",
      "id": "202207310625596970011010000",
      "net": "0.67",
      "payout_id": "202102091116759120448919552",
      "payout_status": "failed",
      "processed_at": "2021-01-29T23:34:53+08:00",
      "source_order_id": "PA4724570375236404289",
      "source_order_transaction_id": "20210129233408597240132500000",
      "source_payment_id": "20210129233408597240132500000",
      "source_type": "payment",
      "transaction_time": "2021-01-29T23:34:53+08:00",
      "type": "payment"
    },
    {
      "amount": "2.00",
      "currency": "USD",
      "fee": "0.36",
      "id": "202207310625597130011010000",
      "net": "1.64",
      "payout_id": "202102091116759120448919552",
      "payout_status": "failed",
      "processed_at": "2021-01-30T12:47:13+08:00",
      "source_order_id": "PA4725367833625411649",
      "source_order_transaction_id": "20210130124621055240132500000",
      "source_payment_id": "20210130124621055240132500000",
      "source_type": "payment",
      "transaction_time": "2021-01-30T12:47:13+08:00",
      "type": "payment"
    },
    {
      "amount": "1.00",
      "currency": "USD",
      "fee": "0.33",
      "id": "202207310625597310011010000",
      "net": "0.67",
      "payout_id": "202102091116759120448919552",
      "payout_status": "failed",
      "processed_at": "2021-02-01T10:01:41+08:00",
      "source_order_id": "PA4728099730973574193",
      "source_order_transaction_id": "20210201100015573240132500000",
      "source_payment_id": "20210201100015573240132500000",
      "source_type": "payment",
      "transaction_time": "2021-02-01T10:01:41+08:00",
      "type": "payment"
    },
    {
      "amount": "-1.00",
      "currency": "USD",
      "fee": "0.80",
      "id": "202207310625597470011010000",
      "net": "-1.80",
      "payout_id": "202102091116759120448919552",
      "payout_status": "failed",
      "processed_at": "2021-02-01T21:54:32+08:00",
      "source_order_id": "-3947729597669432356",
      "source_order_transaction_id": "30002011105881480770840576000",
      "source_payment_id": "20210201100015573240132500000",
      "source_type": "refund",
      "transaction_time": "2021-02-01T21:54:32+08:00",
      "type": "refund"
    },
    {
      "amount": "1.00",
      "currency": "USD",
      "fee": "0.33",
      "id": "202207310625597730011010000",
      "net": "0.67",
      "payout_id": "202102091116759120448919552",
      "payout_status": "failed",
      "processed_at": "2021-02-02T09:56:17+08:00",
      "source_order_id": "PA4729544586627433529",
      "source_order_transaction_id": "20210202095535416240581460000",
      "source_payment_id": "20210202095535416240581460000",
      "source_type": "payment",
      "transaction_time": "2021-02-02T09:56:17+08:00",
      "type": "payment"
    },
    {
      "amount": "1.00",
      "currency": "USD",
      "fee": "0.33",
      "id": "202207310625598090011010000",
      "net": "0.67",
      "payout_id": "202102091116759120448919552",
      "payout_status": "failed",
      "processed_at": "2021-02-02T10:07:57+08:00",
      "source_order_id": "PA4729556390137086034",
      "source_order_transaction_id": "20210202100718023240220800000",
      "source_payment_id": "20210202100718023240220800000",
      "source_type": "payment",
      "transaction_time": "2021-02-02T10:07:57+08:00",
      "type": "payment"
    },
    {
      "amount": "1.00",
      "currency": "USD",
      "fee": "0.33",
      "id": "202207310625598560011010000",
      "net": "0.67",
      "payout_id": "202102161126905912855435264",
      "payout_status": "failed",
      "processed_at": "2021-02-05T10:14:01+08:00",
      "source_order_id": "PA4733911151481242704",
      "source_order_transaction_id": "20210205101322457240391030000",
      "source_payment_id": "20210205101322457240391030000",
      "source_type": "payment",
      "transaction_time": "2021-02-05T10:14:01+08:00",
      "type": "payment"
    },
    {
      "amount": "1.00",
      "currency": "USD",
      "fee": "0.33",
      "id": "202207310625598710011010000",
      "net": "0.67",
      "payout_id": "202102161126905912855435264",
      "payout_status": "failed",
      "processed_at": "2021-02-05T12:07:48+08:00",
      "source_order_id": "PA4734025662859100160",
      "source_order_transaction_id": "20210205120708413240391030000",
      "source_payment_id": "20210205120708413240391030000",
      "source_type": "payment",
      "transaction_time": "2021-02-05T12:07:48+08:00",
      "type": "payment"
    },
    {
      "amount": "-2.49",
      "currency": "USD",
      "fee": "15.00",
      "id": "202207240715456280011130000",
      "net": "12.51",
      "payout_id": "202102091116759120448919552",
      "payout_status": "failed",
      "processed_at": "2021-02-09T10:00:30+08:00",
      "source_order_transaction_id": "202102091116759120448919552",
      "source_type": "payout",
      "transaction_time": "2021-02-09T10:00:30+08:00",
      "type": "payout"
    },
    {
      "amount": "-3.63",
      "currency": "USD",
      "fee": "15.00",
      "id": "202207240715456520011130000",
      "net": "11.37",
      "payout_id": "202102161126905912855435264",
      "payout_status": "failed",
      "processed_at": "2021-02-16T10:00:27+08:00",
      "source_order_transaction_id": "202102161126905912855435264",
      "source_type": "payout",
      "transaction_time": "2021-02-16T10:00:26+08:00",
      "type": "payout"
    },
    {
      "amount": "-3.63",
      "currency": "USD",
      "fee": "0.01",
      "id": "202207240715456680011130000",
      "net": "-3.62",
      "payout_id": "202102231137052720193673216",
      "payout_status": "completed",
      "processed_at": "2021-02-23T10:00:23+08:00",
      "source_order_transaction_id": "202102231137052720193673216",
      "source_type": "payout",
      "transaction_time": "2021-02-23T10:00:23+08:00",
      "type": "payout"
    }
  ]
}

这篇文章对你有帮助吗？

SHOPLINE

条款协议

Error loading component.