Public API - Deposits

Get deposit history

Returns paginated deposit history with aggregate totals.

get/v1/public/deposits/history

Request

  • Base URL: https://api.sms-virtual.net
  • URL: https://api.sms-virtual.net/v1/public/deposits/history
  • Auth: API key in header x-api-key

Query parameters

pagenumber

Page number (1-based). Defaults to 1.

pageSizenumber

Items per page. Defaults to 10.

startDatestring

Filter by createdAt >= startDate (ISO 8601, e.g. 2026-01-15T00:00:00Z).

endDatestring

Filter by createdAt <= endDate (ISO 8601, e.g. 2026-01-15T23:59:59Z).

searchstring

Case-insensitive substring match on invoice number.

statusnumber

Filter by deposit status. 0 = PENDING, 1 = SUCCESS, 2 = FAILED, 3 = EXPIRED, 4 = REFUNDED. Omit for all.

depositMethodIdstring

Filter by deposit method UUID (from GET /v1/public/deposits). Omit for all methods.

Response

Deposit history retrieved successfully. total*Deposit are sums of amounts; totalPending/totalSuccess/etc. are counts (wire format is string).

Changes

No recorded changes to this operation across all 1 revision of this API.