/v2/ibans

GET

Get a list of International Bank Account Numbers attached to the authenticating user's account.

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.
on_behalf_of formData string Contact UUID.
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

Response

{
    "ibans": [
        {
            "id": "286ee37a-7962-4663-afde-ee81e1ed50d6",
            "account_id": "39d0bcf6-9ea1-4147-b846-f773a6566bca",
            "iban_code": "GB19TCCL00997901654515",
            "currency": "EUR",
            "account_holder_name": "Currency Cloud Dev Centre (Settlements)",
            "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-19T09:36:18+00:00",
            "updated_at": "2018-04-19T09:36:18+00:00"
        }
    ],
    "pagination": {
        "total_entries": 1,
        "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 ibans_not_found IBANs were not found
iban_not_found_for_currency IBAN was not found for the selected currency
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