Skip to content

Get wallet balance

GET
/wallet
curl --request GET \
--url https://api.nsin.ir/wallet \
--header 'Authorization: Bearer <token>'

negative_since is set while the balance is below zero. If it stays negative past the grace window, paid domains are suspended; it clears as soon as the balance is non-negative again.

Wallet.

Media type application/json
object
wallet
object
id
integer
user_id
integer
balance_rials
integer
negative_since

When the balance first went below zero in the current debt cycle. Absent while non-negative. Staying negative past the grace window suspends paid domains.

string format: date-time
created_at
string format: date-time
updated_at
string format: date-time
Example generated
{
"wallet": {
"id": 1,
"user_id": 1,
"balance_rials": 1,
"negative_since": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}
}

Missing, malformed, revoked or expired API key — or the owning account is inactive.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example invalidKey
{
"error": "invalid API key"
}

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

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example limited
{
"error": "rate limit exceeded"
}