XS2A.api.connections

Get a list of all bank connections for a xs2a.api bank user

get/api/connections

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/connections?page=2",
  "prev_page_url": "https://api.xs2a.com/v1/connections?page=1",
  "from": 1,
  "to": 1,
  "data": [
    {
      "id": "bcn_BnB6mQLsHKZacYvC",
      "transaction": "10001-bcs-jLnP-HYGI",
      "bic": "TESTDE88XXX",
      "bank_name": "Testbank",
      "country_id": "DE",
      "sync_mode": "full",
      "sync_active": true,
      "last_synced": "2017-12-06 13:07:25",
      "consent_valid_until": "2020-12-06",
      "testmode": true,
      "created_at": "2018-03-16 11:14:58",
      "object": "bank_connection"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.