IranRouter
Docs contents

Docs

Credits

GET /v1/credits — wallet balance, held amount, and what is spendable.

GEThttps://iranrouter.com/v1/credits

The wallet balance of the account this key belongs to.

json
{
  "object": "credits",
  "balance_rial": 4500000,
  "held_rial": 120000,
  "available_rial": 4380000,
  "lifetime_deposit_rial": 20000000,
  "currency": "IRR"
}
FieldMeaning
balance_rialTotal balance.
held_rialHeld for in-flight requests. Temporary; released at settlement.
available_rialWhat is actually spendable — branch on this one.

How hold and settle work →