Skip to content

Balances

What you can pay out, per corridor.

Operations

Balance Info

Request

Get balance info

Security
bearerAuth
Query
countrystring(ApiCountry)required

Destination country

Enum:"BGD""IND""PAK""PHL""NPL""EGY""VNM""NGA"
curl -i -X GET \
  'https://docs.leanx.me/_mock/openapi/v2/balance?country=BGD' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
currencystring(Currency)required

The destination country's local currency; balance is in it.

balancenumber(Balance)required

What you can pay out to this country right now, in currency. Check it before a payout.

reserved_balancenumber or null(Reserved Balance)
Any of:

Held by payments still in progress, in wallet_currency. balance and wallet_balance already exclude it.

number
wallet_currencystring(Wallet Currency)

Your settlement wallet currency: USD, USDT or USDC.

Default:"USDT"
wallet_currency_ratenumber(Wallet Currency Rate)

Rate from wallet_currency to currency.

Default:0
wallet_balancenumber(Wallet Balance)

The same funds as balance, in wallet_currency, including any credit line.

Default:0
dealsDealBalanceInfo (object) or null
Any of:

The deal position for one corridor, in the wallet currency.

Summed over the organization's active deals there. Lives here because BalanceInfoResponse carries it and the v3 models import this module.

Response
{
  "balance": 848879.12,
  "currency": "INR",
  "reserved_balance": 250,
  "wallet_balance": 10000,
  "wallet_currency": "USDT",
  "wallet_currency_rate": 84.887912
}