Get Balances | Redpin | Documentation

Get wallet balances for all of your activated currencies.

Authentication: Bearer token required

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the Authentication section for detailed information on how to obtain and use your OAuth credentials.

Path parameters

customer_idstringRequired

Unique Customer Identifier

Response

Ok. The response body contains an array of wallets' balances.

currencystring

Three letter Currency Code (ISO4217).

total_balancedouble

Total balance is the amount of cleared funds in your account and includes any pending payments.

available_balancedouble

Available balance is the cleared funds minus any funds which are committed to an outgoing payment.

outstanding_balancedouble

Outstanding balance is the amount which you are expected to pay for pending orders.

1	[
2	{
3	"currency": "EUR",
4	"total_balance": 14302.5,
5	"available_balance": 14280,
6	"outstanding_balance": 22.5
7	},
8	{
9	"currency": "GBP",
10	"total_balance": 5000,
11	"available_balance": 2500,
12	"outstanding_balance": 7375.73
13	},
14	{
15	"currency": "NZD",
16	"total_balance": 2554.19,
17	"available_balance": 2554.19,
18	"outstanding_balance": 0
19	},
20	{
21	"currency": "USD",
22	"total_balance": 17040,
23	"available_balance": 17000,
24	"outstanding_balance": 40
25	}
26	]

1	curl https://sandbox.currenciesdirect.com/v1/customers/cust_123456789/balances \
2	-H "Authorization: Bearer <token>"

Authentication

Path parameters

Response

Errors