List agency wallet transactions

POST 
/saas/companies/:companyId/wallet-transactions

Fetch paginated wallet transactions for an agency (company). Supports skip/limit pagination, date-range and charge-type filters, timezone normalization, and additional non-indexed filters in the request body.

Request

Version stringrequired

API Version

Available optionsv3

companyId stringrequired

Company ID to list transactions for

application/json

application/json

Body

Bodyrequired

skipnumber

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

Possible values: >= 0

limitnumber

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

Possible values: >= 0 and <= 1000

filtersobject

Transaction filters

timezonestring

Timezone for date normalization

usersarray[]

User identifiers to scope transaction results

additionalFilterobject

Additional non-indexed filters

Example (auto)

{
  "skip": 0,
  "limit": 100,
  "filters": {
    "locationId": "AUKAtFVo0lWezBsBQ3FE",
    "settlementTime": {
      "from": "2024-01-01T00:00:00.000Z",
      "to": "2024-03-31T23:59:59.999Z"
    },
    "chargeType": "Email"
  },
  "timezone": "UTC",
  "users": [
    null
  ],
  "additionalFilter": {
    "messageId": "msg_123"
  }
}

application/json

Wallet transactions retrieved successfully

application/json

Schema

Schema

transactionsarray[]required

Flat list of normalized wallet transaction records returned from blade-platform

Example (auto)

{
  "transactions": [
    null
  ]
}