The Balance object | Chargily Pay API - Edahabia API - Satim CIB Web API

Attributes

entity

string

A String representing the type of the object.

livemode

boolean

A “True” value means the request was made in Live Mode, while “False” indicates Test Mode.

wallets

array of objects

An array of available balances for each currency.

Show properties

wallets.currency

string

A lowercase ISO currency code.

wallets.balance

boolean

Total balance of the wallet.

wallets.ready_for_payout

boolean

The amount of money that is ready to be paid out.

wallets.on_hold

boolean

The amount of money that is on hold.

{
  "entity": "balance",
  "livemode": false,
  "wallets": [
    {
      "currency": "dzd",
      "balance": 50000,
      "ready_for_payout": "40000",
      "on_hold": 10000
    },
    {
      "currency": "usd",
      "balance": 2000,
      "ready_for_payout": "1800",
      "on_hold": 200
    },
    {
      "currency": "eur",
      "balance": 500,
      "ready_for_payout": "250",
      "on_hold": 250
    }
  ]
}

Retrieve balanceRetrieves the current account (based the API Secret Key employed in the request) balance for the three wallets (DZD, EUR, and USD).

{
  "entity": "balance",
  "livemode": false,
  "wallets": [
    {
      "currency": "dzd",
      "balance": 50000,
      "ready_for_payout": "40000",
      "on_hold": 10000
    },
    {
      "currency": "usd",
      "balance": 2000,
      "ready_for_payout": "1800",
      "on_hold": 200
    },
    {
      "currency": "eur",
      "balance": 500,
      "ready_for_payout": "250",
      "on_hold": 250
    }
  ]
}

​Attributes

Attributes