List company wallet transactions

POST 
/wallet/company/transactions

Fetch paginated wallet transactions for the agency resolved from the access token. Returns the whole agency by default, or a single sub-account when locationId is supplied. Supports skip/limit pagination, date-range and charge-type filters, and timezone normalization.

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

locationIdstring

Narrow the read to one sub-account. Optional with an Agency access token, which otherwise returns the whole agency; ignored-by-contract with a Sub-Account token, which is already scoped to itself.

skipnumber

Number of records to skip for pagination. Defaults to 0.

Possible values: >= 0

limitnumber

Maximum number of records to return. Capped at 1000 per request.

Possible values: >= 0 and <= 1000

filtersobject

Transaction filters

timezonestring

IANA timezone used to normalize timestamps in the response

additionalFilterobject

Additional non-indexed filters applied after the primary query

Example (auto)

{
  "locationId": "AUKAtFVo0lWezBsBQ3FE",
  "skip": 0,
  "limit": 100,
  "filters": {
    "transactionType": "DEBIT",
    "chargeType": "Email",
    "settlementTime": {
      "from": "2024-03-01T00:00:00.000Z",
      "to": "2024-03-31T23:59:59.999Z"
    }
  },
  "timezone": "America/New_York",
  "additionalFilter": {
    "chargeDoc": {
      "messageType": "Email"
    }
  }
}

application/json

Wallet transactions retrieved successfully

application/json

Schema

Schema

transactionsarray[]required

Flat list of normalized wallet transaction records

Example (auto)

{
  "transactions": [
    {
      "_id": "6512bd43d9caa6e02c990b0a",
      "locationId": "AUKAtFVo0lWezBsBQ3FE",
      "chargeType": "Email",
      "amount": 0.00675,
      "currency": "USD",
      "settlementTime": "2024-03-14T09:21:00.000Z"
    }
  ]
}