/v2/ibans/subaccounts/find

GET

Get a list of IBANS for all sub-accounts owned by the authenticating user. Optionally returns the IBANs of bank accounts that hold money in a specified currency.

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
NameInTypeDescriptionEnumDefault
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescriptionEnumDefault
currency query string Currency in which the balance is held. Three-digit currency code.
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.
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/ibans/subaccounts/find

Response

{
    "ibans": [
        {
            "id": "126e3b82-2444-4275-9869-45d4c66a0f11",
            "account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "iban_code": "GB62TCCL00997973594179",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-26T15:05:01+00:00",
            "updated_at": "2018-04-26T15:05:01+00:00"
        },
        {
            "id": "7e56a996-d191-4d3f-80a8-ee0d313f2f71",
            "account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "iban_code": "GB49TCCL00997930436882",
            "currency": "EUR",
            "account_holder_name": "Test Sub Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-26T15:42:01+00:00",
            "updated_at": "2018-04-26T15:42:01+00:00"
        },
        {
            "id": "6a55cbe0-0d60-4ff7-a838-e01097719731",
            "account_id": "e514c9ba-3524-4882-9eca-d79b44756d33",
            "iban_code": "GB29TCCL00997950145023",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-26T18:28:57+00:00",
            "updated_at": "2018-04-26T18:28:57+00:00"
        },
        {
            "id": "4f27155b-7f6e-47b1-befe-c5e04c275450",
            "account_id": "34353af0-1f6a-49c5-9cd6-8007b09b4efb",
            "iban_code": "GB41TCCL00997939639610",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-26T18:47:11+00:00",
            "updated_at": "2018-04-26T18:47:11+00:00"
        },
        {
            "id": "5673b118-bfd7-4294-9d83-d69c620431c9",
            "account_id": "cc053753-3b41-44d1-93d1-a0650dc8ec1a",
            "iban_code": "GB04TCCL00997944164162",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-26T18:50:14+00:00",
            "updated_at": "2018-04-26T18:50:14+00:00"
        },
        {
            "id": "763fe875-0298-4bba-b77d-e7c1e4124395",
            "account_id": "d09017b3-4c55-4fd5-abff-689df3d50971",
            "iban_code": "GB47TCCL00997933254380",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-26T19:01:17+00:00",
            "updated_at": "2018-04-26T19:01:17+00:00"
        },
        {
            "id": "7ae3b150-ddb9-4143-9fe4-575d3c9b57ef",
            "account_id": "d55f2b22-8a31-4fe9-83cb-8b5dd6f1d209",
            "iban_code": "GB55TCCL00997984759296",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-26T19:10:54+00:00",
            "updated_at": "2018-04-26T19:10:54+00:00"
        },
        {
            "id": "eed21828-12d7-4f03-8ddf-d0e1d636184e",
            "account_id": "0dea83b1-194a-49e6-9121-31fbd845e5e1",
            "iban_code": "GB16TCCL00997997642956",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-26T19:16:33+00:00",
            "updated_at": "2018-04-26T19:16:33+00:00"
        },
        {
            "id": "c2b2d4a3-1fb3-47cc-85af-80d29f60432e",
            "account_id": "175ab36b-5fc8-4f99-bf2e-0d25466a454f",
            "iban_code": "GB77TCCL00997916648119",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-27T07:02:58+00:00",
            "updated_at": "2018-04-27T07:02:58+00:00"
        },
        {
            "id": "483bac02-a453-4080-9669-b6a69b077ede",
            "account_id": "fafe9390-23e6-4800-8925-da8edffe3aba",
            "iban_code": "GB56TCCL00997928589585",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-27T10:07:31+00:00",
            "updated_at": "2018-04-27T10:07:31+00:00"
        },
        {
            "id": "6b8f9588-b6e3-4d62-a647-3c63e045280c",
            "account_id": "5d2bd175-9091-47bf-8872-f9c25699f930",
            "iban_code": "GB48TCCL00997908033198",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-27T10:39:27+00:00",
            "updated_at": "2018-04-27T10:39:27+00:00"
        },
        {
            "id": "ca7f4767-f984-488e-b82c-75efdc0ecbb4",
            "account_id": "cd4173fe-bc9c-4016-a01f-7883d9354dff",
            "iban_code": "GB70TCCL00997969525661",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-27T10:45:20+00:00",
            "updated_at": "2018-04-27T10:45:20+00:00"
        },
        {
            "id": "17bdf6cd-8555-4f71-b368-ba837c5649cf",
            "account_id": "52220286-e7db-4ca9-960f-b18f59696c6a",
            "iban_code": "GB09TCCL00997987583891",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-27T10:49:14+00:00",
            "updated_at": "2018-04-27T10:49:14+00:00"
        },
        {
            "id": "0ba45a63-bfbc-47cc-9534-2312558ea67b",
            "account_id": "e05da15b-512b-4462-84e7-729f53108d15",
            "iban_code": "GB61TCCL00997938108299",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-27T10:55:42+00:00",
            "updated_at": "2018-04-27T10:55:42+00:00"
        },
        {
            "id": "7d5d488d-2cf2-4df1-82ef-849053512dee",
            "account_id": "6bc9b249-4e28-4928-a913-fbf954f659e4",
            "iban_code": "GB24TCCL00997934946571",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-27T10:57:54+00:00",
            "updated_at": "2018-04-27T10:57:54+00:00"
        },
        {
            "id": "91475d62-c3ad-4ae4-9295-22d6690c91d4",
            "account_id": "db872306-05c9-4a39-a90c-09c736dde018",
            "iban_code": "GB08TCCL00997979545616",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-27T11:00:21+00:00",
            "updated_at": "2018-04-27T11:00:21+00:00"
        },
        {
            "id": "a9da98d8-5f8f-4407-be96-7c9358ac9e04",
            "account_id": "6c2ec4fc-f825-438b-bb77-e7696de6fc4c",
            "iban_code": "GB57TCCL00997951517069",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-27T13:04:33+00:00",
            "updated_at": "2018-04-27T13:04:33+00:00"
        },
        {
            "id": "616d6f58-7a74-4d12-9edf-0805454d1a17",
            "account_id": "fa76aade-25f5-4100-9bf4-601a0ecea105",
            "iban_code": "GB22TCCL00997910679341",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-27T13:57:27+00:00",
            "updated_at": "2018-04-27T13:57:27+00:00"
        },
        {
            "id": "3c6402f8-eb12-42bc-95df-d33f892f2c4c",
            "account_id": "e41b686b-cc98-4364-bed5-30b3ae9bf77e",
            "iban_code": "GB22TCCL00997980917914",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-27T14:16:04+00:00",
            "updated_at": "2018-04-27T14:16:04+00:00"
        },
        {
            "id": "26ebd227-b6d7-49de-9dc8-6f58f958a286",
            "account_id": "d25d84b2-ac72-41c5-8afc-c367fff6ffa5",
            "iban_code": "GB16TCCL00997979649941",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-27T15:28:00+00:00",
            "updated_at": "2018-04-27T15:28:00+00:00"
        },
        {
            "id": "8d4dada7-bdcd-4bbd-bc95-18cefc609435",
            "account_id": "8991bbc7-50e1-41f1-be5e-96b4ef43f7d9",
            "iban_code": "GB94TCCL00997981789715",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-30T11:33:53+00:00",
            "updated_at": "2018-04-30T11:33:53+00:00"
        },
        {
            "id": "d4ac2dff-c344-44df-8d04-1eec8e16ffd6",
            "account_id": "51b67ff1-f93a-4c66-96fa-a574be60e69a",
            "iban_code": "GB49TCCL00997913090566",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-30T14:24:52+00:00",
            "updated_at": "2018-04-30T14:24:52+00:00"
        },
        {
            "id": "10482dcc-3179-496c-8774-05e35feb7f92",
            "account_id": "74e5c8d8-9d0e-4951-bbca-060c8f881b83",
            "iban_code": "GB53TCCL00997900612996",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-04-30T15:01:39+00:00",
            "updated_at": "2018-04-30T15:01:39+00:00"
        },
        {
            "id": "b1ea7c68-bc77-4ed7-ac8d-c8a5b7158836",
            "account_id": "5d9f7e4b-9dc9-4241-a43b-5a21d0e93a8b",
            "iban_code": "GB02TCCL00997992359909",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-05-01T11:05:27+00:00",
            "updated_at": "2018-05-01T11:05:27+00:00"
        },
        {
            "id": "11148a2c-2fb8-4a56-b5b5-db444865cb40",
            "account_id": "878b31bd-550d-4fe6-bd6d-e582aa7ff62c",
            "iban_code": "GB06TCCL00997938508056",
            "currency": "EUR",
            "account_holder_name": "My Example Account",
            "bank_institution_name": "The Currency Cloud",
            "bank_institution_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
            "bank_institution_country": "United Kingdom",
            "bic_swift": "TCCLGB31",
            "created_at": "2018-05-02T09:02:05+00:00",
            "updated_at": "2018-05-02T09:02:05+00:00"
        }
    ],
    "pagination": {
        "total_entries": 161,
        "total_pages": 7,
        "current_page": 1,
        "per_page": 25,
        "previous_page": -1,
        "next_page": 2,
        "order": "created_at",
        "order_asc_desc": "asc"
    }
}
Error Codes
HTTP Status Code Description Params
400 ibans_not_found IBANs were not found
currency_is_in_invalid_format currency is not a valid ISO 4217 currency code { "type" => "currency" }
currency_is_not_supported currency is not supported
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