List Settlement Details

GET 
/openapi/2024-07/shoplazza-payment/settlements/details

Returns a list of settled details. Objects are sorted in descending order by creation date, with the most recently created objects shown first

Request

Query Parameters

cursor string

cursor for pagination, use the cursor from the response for pagination

limit int32

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

trans_type string

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")

currency string

Currency of the settlement account

settlement_time_min string

Filter option: settle initiation begin time (unix timestamp)

settlement_time_max string

Filter option: settle refund initiation end time (unix timestamp)

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

list object[]

List of settlement details

Array [

store_idstring

Unique identifier for the store

currencystring

Currency of the settlement account

trans_typestring

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")

1. payment: Funds received from a completed payment transaction.
2. reserve_release: Release of funds previously held in reserve.
3. chargeback: A reversal of funds due to a dispute initiated by the payer.
4. chargeback_win: Recovered funds from a dispute that was won in favor of the merchant.
5. refund: Funds returned to the payer due to a refund request.
6. refund_reversal: Reversal of a previous refund, typically restoring funds to the merchant.
7. ship_ins_comm_transfer: Transfer of commission fees related to shipping insurance.
8. ship_ins_comm_reversal: Reversal of previously charged shipping insurance commission.
9. adjustment: Manual or automatic adjustments to correct balances or transaction amounts.
10. debit_negative_balance: Debit applied to offset a negative balance on the account.
11. debit_negative_balance_reversal: Reversal of a previous debit that was applied to correct a negative balance.

trans_idstring

Transaction order number, applicable to all transaction types

fee_amountstring

Related fee amount

settlement_amountstring

Amount settled in this transaction

reserve_amountstring

Reserve amount for deposits

settlement_timestring

Time when the settlement occurred，(unix timestamp)

merchant_idstring

Merchant ID

]

has_moreboolean

Indicator of whether there is more data for pagination

cursorstring

cursor for pagination

Example

{
  "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"
  }
}

422

invalid parameter

application/json

Schema

Schema

codestring

error code

messagestring

error message

Example

{
  "code": "string",
  "message": "string"
}

Example

{
  "code": "InvalidParameter",
  "message": "Currency is required."
}