Skip to main content

Get Balance Details

GET 
/v1/balances/detail

Retrieve detailed information on the various balance types available for transactions in your account. This API provides insights into different balances, which help in tracking funds across distinct states. The following balance types are included:

  • available_balance: The amount currently available for any transaction, representing funds that can be used immediately.
  • incoming_balance: Funds that are in the process of being credited from successful payments but are yet to be paid out by the third-party provider (e.g., credit card processor).
  • outgoing_balance: Funds that are pending deduction from the available balance, set aside to process future actions such as refunds, disputes, or payouts.
  • rolling_reserve_balance: A reserved amount held as a buffer by the merchant; typically used for security against chargebacks or other potential liabilities. This is an optional feature that can be activated by contacting technical support.
  • withdrawable_balance: The portion of the available balance that can be withdrawn, which excludes rolling reserve funds.

Note: This API currently supports only AUD (Australian Dollar) balances. Support for additional currencies is under development.

Responses​

OK