v1

latestOpenAPI 3.0.32026-07-2650226215.9 KB
CashIns

List cash-ins

Returns a paginated list of cash-ins, optionally filtered by customer, status, type, date range, or free-text search. Results are ordered newest-first. Date filters createdAfter and createdBefore are inclusive, matching GET /transactions.

get/cash-ins

Query parameters

customerIdstring

Filter to a single customer (cst_ prefix).

statusstring

Filter by status.

typeTransferType[]

Filter by type.

createdAfterstring date-time

Inclusive lower bound on createdAt.

createdBeforestring date-time

Inclusive upper bound on createdAt.

searchstring

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

qstring

Alias for search.

limitinteger

Maximum number of results per page.

cursorstring

Opaque pagination cursor from a previous response; omit for the first page.

Response

The request has succeeded.

hasMoreboolean required

Whether more results exist beyond this page.

nextCursorstring

Cursor for the next page; null when there are no more results.

Example response

{
  "data": [
    {
      "id": "ci_44vxe2xk8gfsjehfcw3npt5bg8",
      "object": "cashIn",
      "type": "fiatToCrypto",
      "status": "pending",
      "subStatus": "order_reserved",
      "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
      "source": {
        "asset": "usd",
        "indicatedAmount": "200.00",
        "amountGross": "200.00",
        "amountNet": "200.00",
        "feesDeducted": {
          "total": "0.00",
          "developer": "0.00",
          "oms": "0.00",
          "gas": "0.00"
        }
      },
      "destination": {
        "asset": "usdc",
        "network": "polygon",
        "amountGross": "200.00",
        "amountNet": "200.00",
        "feesDeducted": {
          "total": "0.00",
          "developer": "0.00",
          "oms": "0.00",
          "gas": "0.00"
        },
        "wallet": {
          "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
          "blockchainAddress": "0x7B3a9F2c4D1eA8bF6390cE5d2B7fA104C8e3D9b1"
        }
      },
      "cash": {
        "locationId": "loc_01H9Xd",
        "locationReference": "R1JFRU5ET1QtMjQzNA=="
      },
      "location": {
        "name": "CVS Pharmacy #4521",
        "address": "123 Main St, San Francisco, CA 94105"
      },
      "rates": {
        "pair": "usd/usdc",
        "exchangeRate": "1.0000",
        "effectiveRate": "1.0000"
      },
      "depositInstructions": {
        "code": "483 291",
        "expiresAt": "2026-05-15T18:32:48Z",
        "locationName": "CVS Pharmacy #4521",
        "locationAddress": "123 Main St, San Francisco, CA 94105"
      },
      "fixedAmountSide": "source",
      "sponsorGas": true,
      "sponsorGasCost": "0",
      "createdAt": "2026-05-15T17:32:48Z",
      "updatedAt": "2026-05-15T17:32:48Z"
    }
  ]
}