Find Balances - Currencycloud API Documentation

Home > Manage > Balances > Find Balances

/v2/balances/find

GET

Search for currency balances in the main account or a sub-account owned by the authenticating user.

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

Required

Name	In	Type	Description	Format	Enum	Default
X-Auth-Token	header	string	Authentication token.
Optional
Name	In	Type	Description	Format	Enum	Default
on_behalf_of	query	string	Contact UUID.
amount_from	query	number	Minimum balance amount.
amount_to	query	number	Maximum balance amount.
as_at_date	query	string	Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".	date-time
scope	query	string	"Own" account, "clients" sub-accounts, or "all" accounts.		clients own all	own
page	query	integer	Page number.
per_page	query	integer	Number of results per page.
order	query	string	Any field name to change the sort order.			created_at
order_asc_desc	query	string	Sort records in ascending or descending order.		asc desc	asc

curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/balances/find

Response

{
    "balances": [
        {
            "id": "209ca23c-6ac3-442f-a666-aacd98b33c8b",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "USD",
            "amount": "100150.00",
            "created_at": "2018-04-18T12:30:39+00:00",
            "updated_at": "2018-06-27T11:02:01+00:00"
        },
        {
            "id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "96673.46",
            "created_at": "2018-04-18T12:30:40+00:00",
            "updated_at": "2018-08-10T16:35:05+00:00"
        },
        {
            "id": "3ef765f6-0a91-4deb-8077-dbfd869987e6",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "EUR",
            "amount": "98800.00",
            "created_at": "2018-04-18T12:30:41+00:00",
            "updated_at": "2018-08-03T10:50:02+00:00"
        },
        {
            "id": "45ddc72f-68bc-4f2b-b5ee-5f9ecdbe3e02",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "PLN",
            "amount": "0.00",
            "created_at": "2018-06-28T12:19:28+00:00",
            "updated_at": "2018-06-28T12:19:28+00:00"
        }
    ],
    "pagination": {
        "total_entries": 4,
        "total_pages": 1,
        "current_page": 1,
        "per_page": 25,
        "previous_page": -1,
        "next_page": -1,
        "order": "created_at",
        "order_asc_desc": "asc"
    }
}

Error Codes

HTTP Status	Code	Description
400	contact_not_found	Contact was not found for this id
400	on_behalf_of_self	You cannot act on behalf of your own Contact
401	invalid_supplied_credentials	Authentication failed with the supplied credentials
429	too_many_requests	Too many requests have been made to the api. Please refer to the Developer Center for more information
500	internal_server_error	Internal server error
503	service_unavailable	Service is temporary unavailable

Was this page helpful?

Yes

/v2/balances/find

GET

API parameters

Required

Optional

Response

Error Codes

Start your borderless payments journey today

Cookies