查询结算明细列表
GET/openapi/2024-07/shoplazza-payment/settlements/details
分页返回结算明细记录,可按交易类型、币种、地区和结算时间范围过滤。
请求
Query参数
- payment: 支付结算。
- reserve_release: 备用金按计划释放。
- chargeback: 拒付扣款。
- chargeback_win: 拒付胜诉,资金返还。
- refund: 退款结算。
- refund_reversal: 退款冲正。
- ship_ins_comm_transfer: 运费险佣金转入。
- ship_ins_comm_reversal: 运费险佣金转入冲正。
- adjustment: 结算调整。
- debit_negative_balance: 负余额补扣。
- debit_negative_balance_reversal: 负余额补扣冲正。
分页游标。
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
按结算交易类型筛选。
结算账户的币种代码。默认使用商家的默认币种,且必须与所选地区相匹配。
筛选在该 Unix 时间及之后发起的结算记录(如 1730548810)。
筛选在该 Unix 时间及之前发起的结算记录(如 1730548810)。
响应
- 200
- 422
OK
- application/json
- 数据结构
- 示例
数据结构
- Array [
- payment: Funds received from a completed payment transaction.
- reserve_release: Release of funds previously held in reserve.
- chargeback: A reversal of funds due to a dispute initiated by the payer.
- chargeback_win: Recovered funds from a dispute that was won in favor of the merchant.
- refund: Funds returned to the payer due to a refund request.
- refund_reversal: Reversal of a previous refund, typically restoring funds to the merchant.
- ship_ins_comm_transfer: Transfer of commission fees related to shipping insurance.
- ship_ins_comm_reversal: Reversal of previously charged shipping insurance commission.
- adjustment: Manual or automatic adjustments to correct balances or transaction amounts.
- debit_negative_balance: Debit applied to offset a negative balance on the account.
- debit_negative_balance_reversal: Reversal of a previous debit that was applied to correct a negative balance.
- ]
error code
error message
data object
list object[]
结算明细记录列表。
Unique identifier for the store
Currency of the settlement account
Transaction type, (eg . "payment", "reserve_release", "chargeback", "chargeback_win", "refund", "refund_reversal","ship_ins_comm_transfer", "ship_ins_comm_reversal", "adjustment", "debit_negative_balance", "debit_negative_balance_reversal")
Transaction order number, applicable to all transaction types
Related fee amount
Amount settled in this transaction
Reserve amount for deposits
Time when the settlement occurred,(unix timestamp)
Merchant ID
是否有更多记录。
分页游标。
{
"code": "string",
"message": "string",
"data": {
"list": [
{
"store_id": "string",
"currency": "string",
"trans_type": "string",
"trans_id": "string",
"fee_amount": "string",
"settlement_amount": "string",
"reserve_amount": "string",
"settlement_time": "string",
"merchant_id": "string"
}
],
"has_more": true,
"cursor": "string"
}
}
invalid parameter
- application/json
- 数据结构
- 示例
- 示例
数据结构
error code
error message
{
"code": "string",
"message": "string"
}
{
"code": "InvalidParameter",
"message": "Currency is required."
}