Public API

Get balance mutation history

Returns paginated balance mutation log with totals. API key authentication only.

get/v1/public/balance/history

Request

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

Query parameters

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).

type0 | 1

Filter by mutation direction. 0 = addition (credit, e.g. deposit/refund), 1 = deduction (debit, e.g. order). Omit for both.

categorystring

Filter by mutation category. Common values: DEPOSIT, ORDER, REFUND, CLAIM_VOUCHER, ADJUSTMENT. Omit for all.

pageSizenumber

Items per page. Defaults to 10.

pagenumber

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

Response

Balance history retrieved successfully. category is numeric: 0 ORDER, 1 CANCEL_ORDER, 2 REFUND_ORDER, 3 REACTIVATE_ORDER, 4 DEPOSIT, 5 REVOKE_DEPOSIT, 6 CLAIM_VOUCHER, 7 TRANSFER_BALANCE, 8 WITHDRAW, 9 REFUND_DEPOSIT, 10 REQUEST_BALANCE.

Changes

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