跳到主要内容
版本:202201

查询支付订单列表

GET 

/openapi/2024-07/shoplazza-payment/payment-orders

分页返回支付订单列表,可按状态和创建时间范围过滤。

请求

Query参数

    cursor string

    分页游标。

    limit int32

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    created_at_min string

    筛选在该 Unix 时间及之后创建的支付订单(如 1730548810)。

    created_at_max string

    筛选在该 Unix 时间及之前创建的支付订单(如 1730548810)。

    status string

    按状态筛选支付订单。

    • succeeded: 支付成功,资金已确认到账。
    • failed: 支付失败,资金未被处理。
    • requires_action: 需要额外操作才能完成支付(如 3D Secure 验证)。
    • init: 支付订单已创建但尚未处理。
    • canceled: 支付订单已取消,资金未被处理或已退回。
    • processing: 支付处理中,最终结果待确认。

响应

OK

数据结构
    codestring

    error code

    messagestring

    error message

    data object

    Response: Payment order list

    has_moreboolean

    是否有更多记录。

    list object[]

    支付订单记录列表。

  • Array [
  • idstring

    支付订单 ID。

    fee_details object

    此支付订单的交易费用明细。

    trans_fee_amountstring

    Acquiring fee amount

    fee_currencystring

    Fee currency

    foreign_settlement_feestring

    Foreign settlement fee

    created_atstring

    支付订单的创建时间(如 2018-11-02T12:30:10Z)。

    finished_atstring

    支付订单完成的时间(如 2018-11-02T12:30:10Z)。

    payment_statusstring

    订单当前的支付状态。

    • succeeded: 支付成功,资金已确认到账。
    • failed: 支付失败,资金未被处理。
    • requires_action: 需要额外操作才能完成支付(如 3D Secure 验证)。
    • init: 支付订单已创建但尚未处理。
    • canceled: 支付订单已取消,资金未被处理或已退回。
    • processing: 支付处理中,最终结果待确认。
    payment_methodstring

    支付订单所使用的支付方式(如信用卡、PayPal)。

    card_brandstring

    支付所使用信用卡的品牌(如 Visa、Mastercard)。

    pay_currencystring

    消费者实际支付所使用的币种代码(如 USD、EUR)。

    pay_amountstring

    Transaction amount in the original currency

    converted_amountstring

    支付金额折算为店铺基础币种后的数值。

    reserve_amountstring

    预留金额。

    order_idstring

    与此次支付关联的订单标识符。

  • ]
  • cursorstring

    分页游标。