Wallet

Wallet balance (balance / held / available)

get/wallet

Request

  • Base URL
    https://esahayak.io/api/v1
  • URL
    https://esahayak.io/api/v1/wallet
  • Auth
    HTTP bearer

Response

Current wallet balance.

mode'test' | 'live'

Which key mode produced this response.

simulatedboolean

true for sandbox (sk_test_) keys: the balance is a fake unlimited figure, not real money. Never gate a live flow on a simulated balance.

balancenumber

Total funded.

heldnumber

Reserved for in-flight orders.

availablenumber

balance − held; what new orders can draw.

lowBalanceThresholdnumber nullable
currencystring

Example response

{
  "currency": "INR"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.