List Reserved fund Details

GET 
/openapi/2024-07/shoplazza-payment/reserved-fund/details

Return the reserve details. Objects are sorted in descending order by creation date, with the most recently created objects shown first

Request

Query Parameters

created_at_min string

Settlement start time for reserve details (Unix timestamp)

created_at_max string

Settlement end time for reserve details (Unix timestamp)

limit int32

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

cursor string

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

currency string

Currency of the settlement account

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

has_moreboolean

Indicator of whether there is more data for pagination

list object[]

List of reserve details

Array [

store_idstring

Unique identifier for the store

pay_currencystring

Currency of payment amount.

transaction_idstring

Transaction order number, applicable to all transaction types

pay_amountstring

Transaction order amount, in currency

reserve_amountstring

Reserve amount for deposits

created_atstring

Creation time of payment related to reserve (unix timestamp)

merchant_idstring

Merchant ID

reserve_currencystring

Currency of reserve amount

]

cursorstring

cursor for pagination

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "has_more": true,
    "list": [
      {
        "store_id": "string",
        "pay_currency": "string",
        "transaction_id": "string",
        "pay_amount": "string",
        "reserve_amount": "string",
        "created_at": "string",
        "merchant_id": "string",
        "reserve_currency": "string"
      }
    ],
    "cursor": "string"
  }
}

422

invalid parameter

application/json

Schema

Schema

codestring

error code

messagestring

error message

Example

json

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

Example

json

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

500

invalid parameter

application/json

Schema

Schema

codestring

error code

messagestring

error message

Example

json

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

Example

json

{
  "code": "InvalidParameter",
  "message": "wrong cursor"
}