API Reference
Log In
API Reference

Retrieve specific balance by currency

Introduction

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

Definitions:

  • 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.
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
Language
Credentials
Bearer
JWT
URL
Click Try It! to start a request and see the response here!