Get a Balance | Redpin | Documentation

Get wallet balances for a single currency.

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

currency_codestringRequired

Three letter Currency Code (as specified by ISO4217).

Response

Ok. The response body contains balances for a single currency.

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	import requests
2
3	url = "https://sandbox.currenciesdirect.com/v1/customers/cust_123456789/balances/INR"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"currency": "INR",
3	"total_balance": 51749.42,
4	"available_balance": 50549.42,
5	"outstanding_balance": 1200
6	}

Authentication

Path parameters

Response

Errors