/v2/reference/bank_details

GET

Returns the related bank details for the given account reference.

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
NameInTypeDescriptionEnum
X-Auth-Token header string Authentication token.
identifier_type query string The type of the idenitifier used to identify the account iban
bic_swift
sort_code
aba
bsb_code
routing_number
cnaps
identifier_value query string The value of the idenitifier of the account in the format of the identifier_type
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/reference/bank_details

Response

{
    "identifier_value": "GB19TCCL00997901654515",
    "identifier_type": "iban",
    "account_number": "GB19TCCL00997901654515",
    "bic_swift": "TCCLGB22XXX",
    "bank_name": "THE CURRENCY CLOUD LIMITED",
    "bank_branch": "",
    "bank_address": "12 STEWARD STREET  THE STEWARD BUILDING FLOOR 0",
    "bank_city": "LONDON",
    "bank_state": "LONDON",
    "bank_post_code": "E1 6FQ",
    "bank_country": "UNITED KINGDOM",
    "bank_country_ISO": "GB",
    "currency": null
}
Error Codes
HTTP Status Code Description Params
400 identifier_type_is_required identifier_type is required
identifier_type_not_in_range "identifier_type should be in range: iban, bic_swift, sort_code, aba, bsb_code, routing_number, cnaps { "range" => "iban, bic_swift, sort_code, aba, bsb_code, routing_number, cnaps" }
identifier_value_is_required identifier_value is required
identifier_value_is_empty identifier_value should not be empty { "type" => "not_empty_string" }
invalid_iban IBAN is invalid
invalid_bic BIC_SWIFT is invalid
invalid_aba ABA is invalid
invalid_sort_code SORT_CODE is invalid
invalid_bsb BSB_CODE is invalid
invalid_routing_number ROUTING_NUMBER is invalid
invalid_cnaps CNAPS is invalid
cannot_retrieve_bank_data Bank Details service is temporarily unavailable
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