Skip to main content
GET
List cash-ins

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Query Parameters

customerId
string

Filter to a single customer (cst_ prefix).

status
string

Filter by status.

type
enum<string>[]

Filter by type.

Direction of value across rails: cryptoToCrypto, fiatToCrypto, or cryptoToFiat. Retained for resources not yet on the SourceToDestination shape (onramp/cash-in, customer filters).

Available options:
cryptoToCrypto,
fiatToCrypto,
cryptoToFiat
createdAfter
string<date-time>

Inclusive lower bound on createdAt.

createdBefore
string<date-time>

Inclusive upper bound on createdAt.

Free-text search. Matches cash-in id, customer id, or customer email.

q
string

Alias for search.

limit
integer<int32>

Page size, supported range 1-100. The default and maximum are per-resource (see each endpoint's description; most endpoints default to 50) and are resolved at runtime from configuration. Values outside the range are clamped to the nearest bound rather than rejected. The range is published machine-readably via the x-minimum/x-maximum OpenAPI extensions below — deliberately NOT via @minValue/@maxValue, which emit JSON-Schema minimum/maximum and make the generated SDK (Zod) reject values the server accepts and clamps. See PaginatedList.limit for the effective value applied.

startingAfter
string
endingBefore
string

Response

The request has succeeded.

A paginated list of cash-ins.

object
string

Resource type discriminator.

limit
integer<int32>

The effective page size applied to this response, after clamping an out-of-range or unset requested limit into the supported bound.

hasMore
boolean

True when more rows exist beyond this page in the direction of travel (forward by default, backward when endingBefore was supplied).

nextCursor
string

Opaque cursor for the next page. Present when another page can be requested; pass it as startingAfter. hasMore=false signals no more pages forward.

previousCursor
string

Opaque cursor pointing at the first item in this page. Present when data is non-empty, except on a list documented as forward only. Pass as endingBefore to page backward; when this yields an empty response the client is at the start of the list.

data
object[]

The page of results.