API Reference
Log In

Retrieve specific balance by currency


This endpoint will provide you available and pending balances in specified currency.


  • Available balance - is the amount of funds available in the balance, minus any transactions that have not been fully processed.

  • Pending balance - is the current balance without any deductions.

PRO TIP: When making a new payment we advise to rely on the available balance.

Data Requirements

Provide the following data requirements when sending a GET request to the Balance By Currency endpoint.

Additional Header parameter:

Parameter Required? Description Type
Client-Id No Unique identifier of Child Account (required only for Partner). See Authentication Page to learn more. String

The url of this request should contain the following path parameter:

Parameter Required? Description Type
currency Yes Three letter currency code that you wish to retrieve balance in. E.g. JPY for Japanese Yen. String
Click Try It! to start a request and see the response here!