Skip to content

Balances

What you can pay out, per corridor.

Operations

Get Balance

Request

Balance info

Security
bearerAuth
Query
countrystring(ApiCountry)required

Payment country

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

Responses

Successful Response

Bodyapplication/json
currencystring(Currency)required

The corridor's local currency; available, reserved and total are in it.

availablenumber(Available)required

What you can pay out now, in currency. Already net of reserved and of any deal hold.

reservednumber(Reserved)

Held by payments still in progress, on either API version, in currency.

Default:0
totalnumber(Total)required

available plus reserved plus the amount held for active deals, in currency.

walletobject(WalletBalanceInfo)required

The same position in your wallet currency.

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
{
  "currency": "string",
  "available": 0,
  "reserved": 0,
  "total": 0,
  "wallet": {
    "currency": "USD",
    "rate": 0,
    "balance": 0
  },
  "deals": {
    "committed": 0,
    "settled": 0
  }
}