Skip to content
nsin nsin nsin Docs

Look up a top-up payment result

GET
/wallet/topup-result
 
curl --request GET \
  --url 'https://api.nsin.ir/wallet/topup-result?authority=example' \
  --header 'Authorization: Bearer <token>'

The outcome of a wallet top-up, by payment gateway authority. Reading is allowed; starting a top-up is not available to API keys.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
authority
required
string

The payment gateway authority returned when the top-up started.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Payment outcome.

Media type application/json
object
status
string
ref_code
string
amount_rials
integer
Example generated
{
  "status": "example",
  "ref_code": "example",
  "amount_rials": 1
}

400

Section titled “400 ”

Missing authority.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

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

401

Section titled “401 ”

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"
}

404

Section titled “404 ”

No such payment on this account.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

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

429

Section titled “429 ”

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"
}