GET
List external bank accounts
ENDPOINT/v1/external-bank-accounts
Returns linked external bank accounts in the program, newest first. Filter by issuing wallet, owner type, lifecycle state, and verification state. Objects include last_four and routing_number, never the full account number. This operation is program-scoped.
Authentication & Headers
| Header | Type | Requirement | Description |
|---|---|---|---|
| Authorization | string | REQUIRED | API key passed as an HTTP Bearer token: Bearer rk_live_... |
| X-Program-ID | UUID | PROGRAM-SCOPED | Program boundary UUID that scopes the issuing card, wallet, or transfer. |
Query Parameters
| Parameter | Type | Requirement | Description |
|---|---|---|---|
| wallet_id | string(uuid) | OPTIONAL | Return only external bank accounts linked to this issuing wallet.
|
| owner_type | string | OPTIONAL | Return only external bank accounts with this owner type.
Allowed: PERSONBUSINESS |
| state | string | OPTIONAL | Return only external bank accounts in this lifecycle state.
Allowed: ENABLEDCLOSEDPAUSED |
| verification_state | string | OPTIONAL | Return only external bank accounts in this verification state.
Allowed: PENDINGENABLEDFAILED_VERIFICATIONINSUFFICIENT_FUNDS |
| page | integer | OPTIONAL | 1-based page index. Default 1. Values below 1 are treated as 1.
|
| page_size | integer | OPTIONAL | Number of objects to return in the page. Minimum 1, maximum 100, default
10. Also accepted as `page-size`. Values below 1 fall back to the default;
values above 100 are capped at 100.
|
| order_by | string | OPTIONAL | Field to sort by. When omitted, the endpoint uses its default order.
Also accepted as `order-by`. Valid fields are endpoint-specific
(`created_at`, `updated_at`, …).
|
| ascending | boolean | OPTIONAL | Sort direction. Default true (ascending). Pass `false` for descending.
Invalid values are ignored and the default is used.
|
Response Codes & Schemas
200A page of external bank accounts.
application/json{
"data": [
{
"id": "1b6d8f20-4c53-4a87-9e2d-0f5a7c8b3914",
"object": "external_bank_account",
"wallet_id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
"financial_account_id": "c8e2a4b6-1d3f-4a70-9c5e-7b0d2f4a6813",
"type": "CHECKING",
"owner": "Jane Doe",
"owner_type": "PERSON",
"nickname": "Jane Doe Checking",
"user_defined_id": "bank_jane_checking_001",
"address": {
"line_1": "100 Main St",
"line_2": null,
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "US"
},
"last_four": "6789",
"routing_number": "021000021",
"state": "ENABLED",
"verification_state": "ENABLED",
"verification_method": "MICRO_DEPOSIT",
"verification_attempts": 1,
"verification_failed_reason": null,
"created_at": "2026-08-12T12:00:00Z",
"updated_at": "2026-08-14T13:30:00Z"
}
],
"total_count": 1
}400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.
application/json{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "invalid order by: foo. Valid options are: [created_at updated_at]",
"param": "order_by",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/invalid_request"
}
}401Unauthorized: missing, malformed, or unknown API key.
application/json{
"error": {
"type": "authentication_error",
"code": "authentication_error",
"message": "A valid API key is required.",
"param": null,
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/authentication_error"
}
}403Forbidden: the API key is denied by RBAC, or it cannot access this
program. A resource that exists on another program or organization
returns `404 not_found`, not `403`.
application/json{
"error": {
"type": "permission_error",
"code": "permission_denied",
"message": "The API key cannot access this program.",
"param": "X-Program-ID",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/permission_denied"
}
}404Not Found: unknown id, or the resource is not visible to this API key.
application/json{
"error": {
"type": "not_found_error",
"code": "not_found",
"message": "No card found for the given id.",
"param": "card_id",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/not_found"
}
}429Too Many Requests: the API key exceeded its rate limit.
application/json{
"error": {
"type": "rate_limit_error",
"code": "rate_limited",
"message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
"param": null,
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/rate_limited"
}
}500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.
application/json{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
"param": null,
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/internal_error"
}
}