/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
NameInTypeDescriptionFormatEnumDefault
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescriptionFormatEnumDefault
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": "105309.40",
            "created_at": "2018-04-18T12:30:39+00:00",
            "updated_at": "2019-02-22T08:55:03+00:00"
        },
        {
            "id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "80237.33",
            "created_at": "2018-04-18T12:30:40+00:00",
            "updated_at": "2019-08-01T14:45:02+00:00"
        },
        {
            "id": "3ef765f6-0a91-4deb-8077-dbfd869987e6",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "EUR",
            "amount": "107812.44",
            "created_at": "2018-04-18T12:30:41+00:00",
            "updated_at": "2019-07-22T08:20:11+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"
        },
        {
            "id": "840791c5-e24b-43b2-bd2e-ee905c676dae",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "AED",
            "amount": "2868.00",
            "created_at": "2018-08-21T16:44:58+00:00",
            "updated_at": "2018-08-29T02:32:54+00:00"
        },
        {
            "id": "c56da0eb-cac5-4428-943b-6fe2d2c6118c",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "SGD",
            "amount": "0.00",
            "created_at": "2018-09-20T13:48:24+00:00",
            "updated_at": "2018-09-20T13:48:24+00:00"
        },
        {
            "id": "4cfcb4fd-9831-4d98-b416-5a59b19eefa6",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "CNY",
            "amount": "0.00",
            "created_at": "2018-09-20T13:49:14+00:00",
            "updated_at": "2018-09-20T13:49:14+00:00"
        },
        {
            "id": "dec79759-5005-4bcb-bff3-e8f4013c6358",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "JPY",
            "amount": "0.00",
            "created_at": "2018-09-21T12:23:29+00:00",
            "updated_at": "2018-09-21T12:23:29+00:00"
        },
        {
            "id": "523b8690-9254-4e47-b0a2-383dbd96f2bc",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "AUD",
            "amount": "0.00",
            "created_at": "2018-10-11T07:38:06+00:00",
            "updated_at": "2018-10-11T07:38:06+00:00"
        },
        {
            "id": "126175fa-7b1c-40ad-acb4-e9842f6b3ed1",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "CHF",
            "amount": "0.00",
            "created_at": "2018-11-22T12:15:26+00:00",
            "updated_at": "2018-11-22T12:15:26+00:00"
        },
        {
            "id": "f9595ec5-bbaf-4dfe-985f-ea0fed888fa9",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "RON",
            "amount": "0.00",
            "created_at": "2019-01-30T09:49:08+00:00",
            "updated_at": "2019-01-30T09:49:08+00:00"
        },
        {
            "id": "2430a471-b4bc-402c-b623-dc356d8fdd38",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "SEK",
            "amount": "0.00",
            "created_at": "2019-04-16T13:11:46+00:00",
            "updated_at": "2019-04-16T13:11:46+00:00"
        },
        {
            "id": "f99e99d4-258b-4e1b-bbbe-3d1adc51e172",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "RUB",
            "amount": "0.00",
            "created_at": "2019-05-17T14:42:20+00:00",
            "updated_at": "2019-05-17T14:42:20+00:00"
        },
        {
            "id": "5d93f596-0808-47bd-9fb0-cdbbfa24435e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "CAD",
            "amount": "1723.60",
            "created_at": "2019-05-21T10:49:12+00:00",
            "updated_at": "2019-05-23T11:23:22+00:00"
        },
        {
            "id": "1d448174-8262-441e-aa3d-950014a2107a",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "NOK",
            "amount": "0.00",
            "created_at": "2019-06-13T07:49:49+00:00",
            "updated_at": "2019-06-13T07:49:49+00:00"
        },
        {
            "id": "f290c2a7-2d1b-4608-b611-76e5941da993",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "TRY",
            "amount": "0.00",
            "created_at": "2019-07-16T20:36:44+00:00",
            "updated_at": "2019-07-16T20:36:44+00:00"
        }
    ],
    "pagination": {
        "total_entries": 16,
        "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 Params
400 contact_not_found Contact was not found for this id
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
No

Start your borderless payments journey today

Talk to an expert

Cookies

This site uses cookies: Read our cookie policy