/v2/virtual_accounts/subaccounts/{id}

GET

Get a list of VANs attached to a sub-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.
id path string Sub-account ID.
Optional
NameInTypeDescriptionEnumDefault
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/virtual_accounts/subaccounts/{id}

Response

{
  "virtual_accounts": [{
    "id": "00d272ee-fae5-4f97-b425-993a2d6e3a46",
    "account_id": "2090939e-b2f7-3f2b-1363-4d235b3f58af",
    "virtual_account_number": "8303723297",
    "account_holder_name": "Account-ZXOANNAMKPRQ",
    "bank_institution_name": "Community Federal Savings Bank",
    "bank_institution_address": "Seventh Avenue, New York, NY 10019, US",
    "bank_institution_country": "United States",
    "routing_code": "026073150",
    "created_at": "2014-01-12T00:00:00+00:00",
    "updated_at": "2014-01-12T00:00:00+00:00"
  }],
  "pagination": {
    "total_entries": 1,
    "total_pages": 1,
    "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 vans_not_found VANs were not found
account_not_found Account was not found for this id
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