Skip to main content
GET
List Wallet Holds

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

wallet_id
string<uuid>
required

The wallet whose hold history you want.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Query Parameters

currency
string
default:USD

ISO 4217 currency code of the wallet to read.

Required string length: 3

Response

The wallet's freeze / spend / unfreeze history, newest first.

Standard response wrapper for list responses.

Declare ListResponse[list[SomeModel]] to render the real data array schema in OpenAPI/Swagger; a bare ListResponse leaves data untyped.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.

row_count
integer
required

Total rows matching the request filters (not just this page).

Required range: x >= 0
limit
integer | null

Page size used for this response. Null for cursor-paginated endpoints.

Required range: x >= 1
current_page
integer | null

1-indexed page number for this response. Null for cursor-paginated endpoints.

Required range: x >= 1
total_page_number
integer | null

Total number of pages given the current limit. Null for cursor-paginated endpoints.

Required range: x >= 0
next_cursor
string | null

Cursor for the next page, if available.