XS2A.api.connections

Get a specific bank connection

get/api/connections/{connection-id}

Path parameters

connection-idstring required

The connection-id for the connection to be retrieved. You can also pass transaction id here, which you get when you create a bank connection.

Response

Request successfully processed

idstring

Bank Connection ID

transactionstring

Internally used XS2A transaction id.

bicstring

BIC of the bank of the bank connection

bank_namestring

The name of the bank of the bank connection

country_id'DE' | 'AT' | 'CH'

The 2-letter country code

sync_mode'full' | 'shared' | 'none'

The mode how the bank connection is synced.

sync_activeboolean

Indicates whether the sync is active

sync_messagestring

???

sync_fail_counterinteger

A counter of failed syncs for this connection

last_syncedstring

The date when the connection was last synced

consent_valid_untilstring

The consent is valid until the given date (Format: YYYY-MM-DD).

testmodeboolean

Indicates whether this bank connection is in test mode

created_atstring

Date of creation

objectstring

The value bank_connection

Example response

{
  "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.