Get one wallet transaction

GET

/wallet/transactions/{id}

const url = 'https://api.nsin.cloud/wallet/transactions/1';
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.cloud/wallet/transactions/1 \
  --header 'Authorization: Bearer <token>'

The ledger row, plus — for a traffic charge — the per-domain byte and cost breakdown of that billing window. A traffic charge is billed once per account per window, summed across all your domains, so by_domain is how you attribute it.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

required

integer

Responses

200

Transaction detail.

application/json

object

integer

wallet_id

integer

user_id

integer

type

string

Allowed values: topup purchase refund admin_adjust

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

created_at

string format: date-time

domain_id

Set on traffic charges.

integer

domain_name

Set on traffic charges.

string

node

string

billing_window_key

Identifies the billing window a traffic charge covers.

string

by_domain

Per-domain contribution to this charge. Traffic charges only.

Array<object>

One domain’s share of a single traffic charge.

object

domain_id

integer

domain_name

string

cached_bytes

integer

proxied_bytes

integer

direct_bytes

integer

bypass_bytes

Legacy two-tier column, on historical rows only.

integer

charged_rials

integer

cached_bytes

Total across by_domain.

integer

proxied_bytes

Total across by_domain.

integer

direct_bytes

Total across by_domain.

integer

bypass_bytes

Total across by_domain.

integer

Example

{
  "type": "topup"
}

401

Missing, malformed, revoked or expired API key, or a key whose owning user row is gone. A key whose owning account has merely been deactivated is not this: that is 403 with code: account_suspended, because the credential itself is intact and re-issuing it changes nothing.

application/json

The error shape used by every endpoint. error is always present. code is present only on the failures that have one — do not require it, and do not parse error to recover it.

object

error

required

Human-readable description of what went wrong.

string

code

Stable machine-readable reason. Present on some failures only; the wording of error may change, this will not.

account_suspended — 403. The account behind the credential has been switched off, by an admin or by its provider. Every authenticated route answers this, so treat it as terminal rather than retrying.
domain_disabled — 409, not 403. You have every right to the operation; the domain is simply switched off and is not being served, so its configuration cannot change. It stays readable, and writes work again once it is enabled.
managed_by_reseller — 403. The account is a reseller’s client and this surface belongs to its provider. See If your account is managed by a reseller.
invite_email_mismatch — 403 from POST /invites/{token}/accept. The invitation was addressed to a different email; the body also carries invited_email, masked.

A panel session — not an API key — can additionally see session_check_failed on a 503, which means the session could not be verified, not that it is invalid. Retry it; do not discard the token.

string

Examples

invalidKey

{
  "error": "invalid API key"
}

404

No such transaction on this account.

application/json

The error shape used by every endpoint. error is always present. code is present only on the failures that have one — do not require it, and do not parse error to recover it.

object

error

required

Human-readable description of what went wrong.

string

code

Stable machine-readable reason. Present on some failures only; the wording of error may change, this will not.

account_suspended — 403. The account behind the credential has been switched off, by an admin or by its provider. Every authenticated route answers this, so treat it as terminal rather than retrying.
domain_disabled — 409, not 403. You have every right to the operation; the domain is simply switched off and is not being served, so its configuration cannot change. It stays readable, and writes work again once it is enabled.
managed_by_reseller — 403. The account is a reseller’s client and this surface belongs to its provider. See If your account is managed by a reseller.
invite_email_mismatch — 403 from POST /invites/{token}/accept. The invitation was addressed to a different email; the body also carries invited_email, masked.

string

Example

{
  "error": "read-only API key"
}

429

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

application/json

The error shape used by every endpoint. error is always present. code is present only on the failures that have one — do not require it, and do not parse error to recover it.

object

error

required

Human-readable description of what went wrong.

string

code

Stable machine-readable reason. Present on some failures only; the wording of error may change, this will not.

account_suspended — 403. The account behind the credential has been switched off, by an admin or by its provider. Every authenticated route answers this, so treat it as terminal rather than retrying.
domain_disabled — 409, not 403. You have every right to the operation; the domain is simply switched off and is not being served, so its configuration cannot change. It stays readable, and writes work again once it is enabled.
managed_by_reseller — 403. The account is a reseller’s client and this surface belongs to its provider. See If your account is managed by a reseller.
invite_email_mismatch — 403 from POST /invites/{token}/accept. The invitation was addressed to a different email; the body also carries invited_email, masked.

string

Examples

limited

{
  "error": "rate limit exceeded"
}