Skip to main content
Version: 202506

List reserved funds

GET 

/openapi/2025-06/shoplazza-payment/reserved-fund/details

Returns a paginated list of reserved-fund detail records, optionally filtered by currency, region, and creation time range.

Request

Query Parameters

    cursor string

    Cursor for pagination

    page_size int32

    Page size (1-100, default 10)

    currency string

    Currency of the reserved-fund account. Defaults to the merchant's default currency. Must match the specified region

    created_at_min string

    Filter reserved-fund records created at or after this Unix timestamp (e.g., 1730548810)

    created_at_max string

    Filter reserved-fund records created at or before this Unix timestamp (e.g., 1730548810)

    region string

    Region of the merchant account (e.g., US, HK). Defaults to the merchant's default region

Responses

OK

Schema
    codestring

    error code

    messagestring

    error message

    data object
    list object[]

    List of reserved-fund detail records

  • Array [
  • store_idstring

    Store ID associated with the reserve fund

    pay_currencystring

    Currency of payment amount

    transaction_idstring

    Transaction ID for the reserve fund

    pay_amountstring

    Payment amount associated with the reserve

    reserve_amountstring

    Amount reserved for the transaction

    pay_created_atstring

    Creation time of payment related to reserve (unix timestamp)

    merchant_idstring

    Merchant ID associated with the reserve

    reserve_currencystring

    Currency of reserve amount

    settlement_atstring

    Settlement time of reserve (unix timestamp)

  • ]
  • cursorstring

    Cursor for pagination

    has_moreboolean

    Whether there are more records