API explorerPay APIsData APIs
API explorer
Pay APIs
Data APIs

Theme switcher

List Accounts

Retrieves a list of bank accounts associated with a consent, with optional filtering. Each account includes the latest balances from the most recent data refresh job.

Consent status: If the consent is expired, revoked, failed, or suspended, this endpoint returns 400 with code consent_not_active.

Filtering

Accounts can be filtered by:

  • Currency
  • Account type (e.g., "Personal current account")
  • Account sub-type (e.g., "CurrentAccount")

Body Parameters

client_idstring Required

API client identifier

Max length
128
client_secretstring

API client secret for authentication. Required for internal (non-OAuth2) authentication mode (e.g., test-only). Not required when using OAuth2 (Bearer token) authentication.

Max length
128
consent_idstring Required

Consent ID to filter accounts

filterobject

Filter criteria for listing accounts. All filters are optional and combined with AND logic.

Show child attributes

Response

200
Object
Accounts retrieved successfully

Response Attributes

api_client_appstring

Name of the API client application

client_idstring

API client identifier

request_idstring

Unique identifier for the API request

consent_idstring

ID of the consent these accounts belong to

accountsarray

List of accounts matching the filter criteria, each with their latest balances

Show child attributes

400
Object
Validation error or invalid request

Response Attributes

error_idstring Required

Unique identifier for this error instance

request_idstring Required

Request identifier for tracking and correlation

codestring Required

Machine-readable error code for 400 errors:

  • bad_request: Generic validation or request error
  • validation_error: Request payload validation failed
  • invalid_input: Invalid input data provided
  • unprocessable_entity: Valid request but cannot be processed
  • cooldown_failed: Data refresh cooldown period not yet elapsed
  • consent_not_active: Consent is not usable...
Enum values:
bad_requestvalidation_errorinvalid_inputunprocessable_entitycooldown_failedconsent_not_activemethod_selection_errormethod_input_validation_errorlink_expired
messagestring Required

Human-readable error message

401
Object
Authentication failed

Response Attributes

error_idstring Required

Unique identifier for this error instance

request_idstring Required

Request identifier for tracking and correlation

codestring Required

Machine-readable error code for 401 errors:

  • unauthorized: Authentication failed or insufficient permissions
Enum values:
unauthorized
messagestring Required

Human-readable error message

404
Object
Resource not found

Response Attributes

error_idstring Required

Unique identifier for this error instance

request_idstring Required

Request identifier for tracking and correlation

codestring Required

Machine-readable error code for 404 errors:

  • not_found: Generic resource not found
  • consent_not_found: Specified consent does not exist
  • job_not_found: Specified job does not exist or outside accessible date range
Enum values:
not_foundconsent_not_foundjob_not_found
messagestring Required

Human-readable error message

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot