For archived content, access the previous documentation here or the previous API reference here.

Get balance

  • Updated on Jul 31, 2025
  • Published on Jul 23, 2025
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.

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 (date-time)

ISO 8601 date-time format (URI encoded)

Balance returned in the response will be based on the timestamp provided. The timestamp value must be URI encoded when passed as a query parameter.

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

Currency filter for customers with multi-currency accounts. Only the following currencies are supported for balance and balance history:

  • IDR, PHP, USD, VND, THB, MYR, SGD, EUR, GBP, HKD, AUD
Valid values[ "IDR", "PHP", "USD", "VND", "THB", "MYR", "SGD", "EUR", "GBP", "HKD", "AUD" ]
Responses
200

Successful operation

object
balance
integer (float)
Example1241231
400

Inputs are failing validation. The errors field contains details about which fields are violating validation.

object
error_code
string
Valid values[ "API_VALIDATION_ERROR", "FEATURE_NOT_AVAILABLE" ]
message
string
errors
Array
OneOf
string
string
object
object