Sign in
XS2A.api.accounts

Retrieve the list of bank accounts for a xs2a.api bank user

get/api/accounts

Query parameters

per_pageinteger

Items per page

pageinteger

Which page to display

Response

Request successfully processed

totalinteger

Total number of results.

per_pageinteger

Number of objects per page

current_pageinteger

Current page.

last_pageinteger

Last page, usually the total of available pages.

next_page_urlstring nullable

URI to next page.

prev_page_urlstring nullable

URI to previous page.

frominteger

Showing results from index element.

tointeger

Showing results to index element.

Example response

{
  "total": 1,
  "per_page": 15,
  "current_page": 1,
  "last_page": 1,
  "next_page_url": "https://api.xs2a.com/v1/accounts?page=2",
  "prev_page_url": "https://api.xs2a.com/v1/accounts?page=1",
  "from": 1,
  "to": 1,
  "data": [
    {
      "id": "bac_c8KYwjexO2iO5AE9",
      "bank_connection_id": "bcn_xxxxxxxxxxxxxxxx",
      "holder": "MUSTERMANN, HARTMUT",
      "iban": "DE62888888880012345678",
      "description": "Girokonto",
      "bic": "TESTDE88XXX",
      "account_number": "1234567890",
      "bank_code": "88888888",
      "bank_name": "Testbank",
      "country_id": "DE",
      "type": "giro",
      "transaction_possible": "1",
      "created_at": "2018-03-16 11:14:58",
      "object": "bank_account"
    }
  ]
}

Changes