Find Funding Accounts - Currencycloud API Documentation

Home > Find Funding Accounts

/v2/funding_accounts/find

GET

Gets details of the SSIs that can be used to settle and collect funds in each available 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

Name	In	Type	Description	Enum	Default
X-Auth-Token	header	string	Authentication token.
currency	query	string	The currency of the account details required. ISO 4217 standard.
Optional
Name	In	Type	Description	Enum	Default
payment_type	query	string	The type of SSI to be returned e.g. priority (SWIFT) or regular. Defaults to all.	all priority regular	all
account_id	query	string	UUID of a specific account you want to see the SSIs for
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/funding_accounts/find

Response

{
    "funding_accounts": [
        {
            "id": "3ecf2020-1503-48d2-b996-eba3b6ac1044",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_number": "54082403",
            "account_number_type": "account_number",
            "account_holder_name": "Currency Cloud Dev Centre",
            "bank_name": "Starling",
            "bank_address": "3rd floor, 2 Finsbury Avenue, London, EC2M 2PP, GB",
            "bank_country": "GB",
            "currency": "GBP",
            "payment_type": "regular",
            "routing_code": "123456",
            "routing_code_type": "sort_code",
            "created_at": "2019-09-26T13:33:30+00:00",
            "updated_at": "2019-09-26T13:33:30+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	payment_type_not_in_range	payment_type should be in range: priority, regular	`{ "range" => "priority, regular" }`
	currency_is_in_invalid_format	currency is not a valid ISO 4217 currency code	`{ "type" => "currency" }`
	currency_is_not_supported	currency is not supported
	account_id_is_not_valid_uuid	account_id should be in UUID format
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/funding_accounts/find

GET

API parameters

Required

Optional

Response

Error Codes

Start your borderless payments journey today

Cookies