Balance

Fields

• objectstringRequired

  Always balance.

  • Always balance
• as_ofstring (date-time)Required

  When the balance was read.

• availablestringRequired

  What new sends can use: balance minus held.

  • Matches ^\d+\.\d{4}$
• balancestringRequired

  All the money in your wallet, including what is held for messages in flight.

  • Matches ^\d+\.\d{4}$
• currencystringRequired

  Always NGN.

  • Always NGN
• heldstringRequired

  Money held for messages that are scheduled, queued or being sent, and for finished messages until they are settled, within about a minute.

  • Matches ^\d+\.\d{4}$
• low_balance_thresholdstringRequired

  Your low-balance alert threshold.

  • Matches ^\d+\.\d{4}$

Used by

• Get the wallet balance