List wallet transactions

GET

/wallet/transactions

const url = 'https://api.nsin.ir/wallet/transactions?limit=50&offset=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.nsin.ir/wallet/transactions?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

The wallet ledger, newest first. amount_rials is signed: positive is a credit, negative a debit. Traffic charges carry the domain they are attributed to.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Query Parameters

limit

integer

default: 50 >= 1 <= 200

offset

integer

Responses

200

Ledger rows.

application/json

Array<object>

object

integer

wallet_id

integer

user_id

integer

type

topup — money added. purchase — a plan bought or renewed. refund. admin_adjust — a correction by NSIN support. traffic_usage — a traffic charge. signup_bonus — the credit granted at signup.

string

Allowed values: topup purchase refund admin_adjust traffic_usage signup_bonus

amount_rials

Signed — positive credits, negative debits.

integer

balance_after

integer

description

string

ref_type

What the row refers to — payment, subscription, traffic or manual.

string

ref_id

integer

ref_code

Payment gateway reference, for top-ups.

string

origin_node

Internal — set on rows replicated from another NSIN region. Clients can ignore it.

string

sync_key

Internal — the replication idempotency key of a replicated row. Clients can ignore it.

string

created_at

string format: date-time

domain_id

The domain a traffic charge is attributed to. Only on rows of GET /wallet/transactions.

integer

domain_name

That domain’s name. Only on rows of GET /wallet/transactions.

string

Example

[
  {
    "type": "topup"
  }
]

401

Missing, malformed, revoked or expired API key. (A valid key whose account has been deactivated gets 403 account is inactive instead.)

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

invalidKey

{
  "error": "invalid API key"
}

429

The key exceeded its request budget (300 requests per minute by default).

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

limited

{
  "error": "rate limit exceeded"
}