Welcome to Xendit’s latest documentation. For legacy content, access the previous documentation here or the previous API reference here.

Get balances of the merchant

Prev Next
Get
/balance

Balance is like your wallet since it will tell you how much money is available to you on Xendit. You can retrieve it to see the current balance on your Xendit cash account. Your balance is debited on any money out transaction, e.g. when performing disbursements or Xendit fees are charged. Your balance is credited when money comes into your account, e.g. invoices are paid or you deposit funds.

Security
HTTP
Type Basic
Header parameters
for-user-id
string

The sub-account user-id that you want to make this transaction for.

This header is only used if you have access to xenPlatform. See xenPlatform for more information

Query parameters
account_type
string

The selected balance type

Valid values[ "cash", "holding", "tax" ]
Default"cash"
at_timestamp
string

ISO 8601 date-time format

Balance returned in the response will be based on the timestamp provided

Example2024-01-01T00:00:00.000Z
currency
string

Currency filter for customers with multi currency accounts type. This field is only optional if you have only 1 currency. If you have more than 1 currency, please specify your desired currency.

Valid values[ "IDR", "PHP", "USD" ]
Responses
200

Successful operation

object
balance
integer (float)
Example1241231