查询店铺交易记录

需要 read_payment 权限点。
更多权限点使用信息,请参考:
GET https://{handle}.myshopline.com/admin/openapi/v20250601/payments/store/transactions.json
handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。
查询店铺交易记录，包含支付、退款、争议等交易信息。
查询参数
  • date_max string
    指定要查询的交易的截止创建时间，在此日期之前创建的交易会被返回。date_min 和 date_max 参数必须同时指定，date_min 和 date_max 时间间隔最长不能超过 6 个月。格式：ISO 8601。
    Example: 2024-12-10T00:00:00+08:00
  • date_min string
    指定要查询的交易的起始创建时间，在此日期或此日期之后创建的交易会被返回。date_min 和 date_max 参数必须同时指定，date_min 和 date_max 时间间隔最长不能超过 6 个月。date_min 只能指定查询 12 个月内创建的交易记录。格式：ISO 8601。
    Example: 2024-12-10T00:00:00+08:00
  • limit string
    每页记录条数限制，不能超过 1000。默认值：100。
  • page_info string
    分页查询的唯一标识，用于定位特定页面。
    该字段值需要在你已经查询完分页信息后，在该接口响应头中的 link 字段值中获取。例如，你获取到的 link 的值为 <https://\{handle\}.myshopline.com/admin/openapi/\{version\}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next"，那么 page_info 的值为 eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9。
    关于更多如何使用分页信息，请参考 分页机制。
  • since_id string
    支付、退款或争议订单的唯一标识。筛选在这个订单号之前发生的交易记录，用于 since_id 模式（查询第一页数据）。关于分页使用详情请参考 分页机制。
    Example: 10020122431667364394911580160
  • status string
    交易状态。
    当 transaction_type = PAYMENT 时，可选值为：
    • CREATED：订单已创建。
    • CUSTOMER_ACTION：买家处理中。
    • PROCESSING：SHOPLINE Payments 内部处理中。
    • SUCCEEDED：订单处理成功。
    • FAILED：订单处理失败。
    • CANCELED：订单已取消。
    • EXPIRED：订单已过期。
    当 transaction_type = REFUND 时，可选值为：
    • CREATED：订单已创建。
    • PROCESSING：SHOPLINE Payments 内部处理中。
    • SUCCEEDED：订单处理成功。
    • FAILED：订单处理失败。
    当 transaction_type = DISPUTE 时的可选值有如下情况：
    当 dispute_type = CHARGEBACK 时，可选值为：
    • CREATED：争议已创建。
    • EVIDENCE_RETURNED：已退回。争议中间状态，商家需要重新提交抗辩材料。
    • EVIDENCE_REQUIRED：待提交审查资料。
    • MERCHANT_SUBMITTED：争议处理中（资料已提交）。
    • RESOLVED：已解决。争议中间状态，后续可能会变为 WON 或者 LOST。
    • CANCELED：已取消。争议中间状态，后续会变为 WON。
    • EVIDENCE_UNDER_REVIEW：争议处理中（资料审核中）。
    • LOST：争议成立。买家获得款项。
    • WON：争议不成立。卖家获得款项。
    • EXPIRED：争议已过期。争议中间状态，后续大概率变为 LOST。
    • SLP_EXPIRED：商家超时未提供抗辩资料。争议中间状态，后续会变为 EXPIRED。
    • ACCEPTED：商家已接受争议。争议中间状态，后面会变为 LOST。
    • MERCHANT_ACCEPTED：商家已接受争议。争议中间状态，后续会变为 ACCEPTED。
    当 dispute_type = PRE_CHARGEBACK 时，可选值为：
    • PRE_CHARGEBACK_CREATED：预拒付已创建。中间状态，产生了预拒付，系统没有协助进行自动退款，需要商家手动选择是否接受退款。
    • PRE_CHARGEBACK_IN_ACCEPT：商家已回复接受。中间状态，商家手动选择或者自动接受退款，后续变成 PRE_CHARGEBACK_ACCEPTED。
    • PRE_CHARGEBACK_IN_REJECT：商家已回复拒绝。中间状态，商家手动选择拒绝退款，后续会变成 PRE_CHARGEBACK_REJECTED。
    • PRE_CHARGEBACK_IN_EXPIRE：商家超时未回复。中间状态，产生了预拒付，商家超过时间没操作，后续可能变成 ACCEPTED 或 REJECTED。
    • PRE_CHARGEBACK_ACCEPTED：商家已接受。是终态，商家接受退款，退款已完成。
    • PRE_CHARGEBACK_REJECTED：商家已拒绝。是终态，商家拒绝退款，后续有可能演变为拒付。
    当 dispute_type = RETRIEVAL 时，可选值为：
    • RETRIEVAL_CREATED：调单发起。
    • RETRIEVAL_FINISHED：调单完成。
    • RETRIEVAL_CANCELED：调单撤销。
    当 dispute_type = FRAUD_NOTIFICATION 时，可选值为：
    • FRAUD_FINISHED：欺诈预警。建议商家先不发货并和买家商议，确认是不是真实的下单。如有必要可以退款。否则可能会变为拒付。
    Example: SUCCEEDED
  • trade_order_id string
    支付、退款或争议订单的唯一标识。精确查找指定的订单号的信息。
    Example: 10020122431667364394911580160
  • transaction_type string
    交易类型。包括以下几种类型：
    • PAYMENT：支付交易
    • REFUND：退款交易
    • DISPUTE：争议交易
请求头
  • Content-Type required
    字段值固定为application/json; charset=utf-8
  • Authorization string required
    资源的访问令牌。请参考 应用授权 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
响应
更多状态码信息请参考 HTTP 状态码
响应头
  • link
    提供分页数据的 URL 链接。你可以获取该字段值中的 page_info 信息用于下一次分页请求中。 当你请求的页面存在上一页或下一页的时候，该字段会被返回。关于更多如何使用分页信息，请参考 分页机制。
  • traceId
    traceId
响应体
  • transactionsobject[]
    交易记录列表。
  • additional_dataobject
    附加信息。
  • dispute_evidence_update_deadline string
    商家提交抗辩资料的截止时间。格式：ISO 8601。
  • is_settled boolean
    交易是否已结算。
    • true：已经结算
    • false：待结算
    Example: true
  • reserve_held string
    保证金。SHOPLINE Payments 可能对支付订单收取一定保证金，并将在持有期结束后转入商家的账户余额。保留 2 位小数。
    Example: 1.23
  • reserve_release_time string
    保证金释放时间，表示 SHOPLINE Payments 将该交易的保证金转入商家账户余额的时间。格式：ISO 8601。
    Example: 2024-12-10T00:00:00+08:00
  • settle_time string
    结算时间。格式：ISO 8601。
    Example: 2024-12-09T00:00:00+08:00
  • statement_time string
    综合对账产生时间。格式：ISO 8601。
  • amount string
    交易金额。保留 2 位小数。
    Example: 10.10
  • channel_deal_id string
    SHOPLINE Payments 所使用的支付渠道的订单流水号。
    Example: Z237HWV6LT7QCWX3
  • create_time string
    交易记录创建时间。格式：ISO 8601。
    Example: 2024-12-09T00:00:00+08:00
  • credit_cardobject
    信用卡信息。payment_method 为 CreditCard、Applepay、Googlepay 时，此字段有值。
  • auth_code string
    授权码。由发卡银行生成的一个唯一代码，表示该交易已被批准。
    Example: 123456
  • bin string
    卡 BIN。
    Example: 48068133
  • brand string
    卡品牌。
    Example: Visa
  • issuer_country string
    发卡国家。
    Example: US
  • last4 string
    卡号后四位。
    Example: 1234
  • type string
    卡类型。
    Example: CREDIT
  • currency string
    交易币种。该字段值为三位币种码，遵循 ISO 4217 国际标准，例如 CNY。
    Example: USD
  • customerobject
    买家信息。
  • personal_infoobject
    买家身份信息。
  • first_name string
    买家的名字。
    Example: demo
  • last_name string
    买家的姓氏。
    Example: payment
  • dispute_type string
    当 transaction_type = DISPUTE 时，此字段有值，问题交易类型包括以下几种：
    • CHARGEBACK：客户向其银行发起交易争议，导致资金逆转。
    • PRE_CHARGEBACK：这表示在完整 CHARGEBACK 之前的一个初步阶段。发卡银行正在调查争议。
    • RETRIEVAL：收单方要求商家提供有关该交易的更多信息。
    • FRAUD_NOTIFICATION：这表明有关该交易的潜在欺诈活动通知。
    Example: CHARGEBACK
  • exchangeobject
    换汇信息。
  • amount string
    基于实际支付金额进行换汇的金额，保留 2 位小数。
    Example: 10.10
  • currency string
    兑换币种。该字段值为三位币种码，遵循 ISO 4217 国际标准，例如 CNY。
    Example: USD
  • rate string
    换汇汇率。按 交易币种/兑换币种 @汇率 格式，汇率保留 10 位小数。例子：USD/USD @1.0000000000。
    Example: USD/USD @1.0000000000
  • fee string
    手续费。SHOPLINE Payments 收取商家手续费则显示为负，SHOPLINE Payments 退还商家手续费则显示为正。
    Example: -0.22
  • fee_type string
    手续费类型。可选值为：
    • domestic：本地交易手续费，接受国内银行卡片刷卡时的手续费。
    • international：跨境交易手续费，接受国外银行卡片刷卡时的手续费。
    Example: international
  • merchant_id string
    商家在 SHOPLINE Payments 的标识。
    Example: 2143350491097202688
  • paid_amount string
    实际支付金额，保留 2 位小数。
    Example: 10.10
  • payment_method string
    支付方式。
    Example: ApplePay
  • payment_method_optionobject
    支付方式的可选信息。
  • installmentobject
    支付方式的分期信息。
  • count string
    分期期数。
    Example: 12
  • payment_msgobject
    支付失败信息。当 transaction_type 为 PAYMENT 或 REFUND，并且状态为 FAILED 时，此字段有值。
  • code string
    错误码。
    Example: The payment has been declined for unspecificed reasons.
  • msg string
    错误描述。
    Example: 4600
  • reason string
    退款或争议的原因。
    当 transaction_type = DISPUTE 时，reason 的值有如下情况：
    当 dispute_type = CHARGEBACK 时，reason 的枚举值为：
    • fraudulent：欺诈交易。
    • unrecognized：不明交易。
    • duplicate：重复支付。
    • subscription canceled：取消交易。
    • product not received：未收到商品。
    • product unacceptable：对商品不满意。
    • credit not processed：未收到退款。
    • general：其他原因。
    当 dispute_type = PRE_CHARGEBACK 或 RETRIEVAL 或 FRAUD_NOTIFICATION 时，reason 的值为任意字符。
    当 TransactionType = REFUND 时，reason 的值为任意字符。
    当 TransactionType = PAYMENT 时，reason 的值为空。
  • seller_order_id string
    业务订单号。
    Example: 123456
  • status string
    交易状态，枚举值。该字段的详细说明，请参考查询入参中的 status 字段中的描述。
    Example: SUCCEEDED
  • sub_payment_method string
    支付子方式。对 payment_method 的详细分类，只有部分支付方式才有支付子方式。例如：Alipay 支付方式包含 AlipayQrCode 和 AlipayWap 这两种子支付方式。
  • sub_status string
    交易子状态。对 status 的详细分类，只有部分交易状态才有交易子状态。
    当 status = FAILED 时，可选值为：
    • CONFIRM_FAILED：在交易的 CONFIRM 阶段出现异常。
    • CAPTURE_FAILED：在交易的 CAPTURE 阶段出现异常。
    • PAYMENT_FAILED：在交易的 PAYMENT 阶段出现异常。
    • RISK_REJECTED： 交易因风控原因被拒绝。
  • trade_order_id string
    支付、退款或争议订单的唯一标识。
    Example: 10010062529029006852253184000
  • transaction_type string
    交易类型。包括以下几种类型：
    • PAYMENT：支付交易
    • REFUND：退款交易
    • DISPUTE：争议交易
  • update_time string
    交易记录更新时间。格式：ISO 8601。交易相关内容更新后，该字段都会更新，例如：交易状态、结算信息等变更，都会更新该字段。
    Example: 2024-12-09T01:00:00+08:00
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

— header required
— query
— query
— query
— query
— query
— query
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/payments/store/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
{
  "errors": "Required param: date_min"
}
这篇文章对你有帮助吗？
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
条款协议
隐私
条款
开发者协议
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.

Error loading component.

Error loading component.