/v2/withdrawal_accounts/find

GET

Lists all withdrawal accounts assigned to an 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
NameInTypeDescription
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescription
account_id query string The UUID of a sub-account you want to see the withdrawal accounts for. If omitted the withdrawal accounts for the house account and all sub-accounts are returned
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/withdrawal_accounts/find

Response

{
    "withdrawal_accounts": [
        {
            "id": "0886ac00-6ab6-41a6-b0e1-8d3faf2e0de2",
            "account_name": "currencycloud",
            "account_holder_name": "The Currency Cloud",
            "account_holder_dob": null,
            "routing_code": "123456789",
            "account_number": "01234567890",
            "currency": "USD",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f"
        }
    ],
    "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 account_id_is_not_valid_uuid account_id should be in UUID format
401 invalid_supplied_credentials Authentication failed with the supplied credentials
403 permission_denied permission_denied
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