Returns a JSON structure with details of the VANs for the specified accounts

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

X-Auth-Token header string Authentication token.
scope query string Scope allows the logged in account to search all VANs at all account levels. Defaults to all. Own - search for VANs on the main account Clients - search for VANs of account sub accounts
all - search for VANs of account and sub-accounts
account_id query string UUID of a specific account you want to see the IBAN 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
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/virtual_accounts/find


    "virtual_accounts": [],
    "pagination": {
        "total_entries": 0,
        "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 vans_not_found VANs were not found
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?