XSxs2a
XS2A.api.connections

Create a bank connection

Changed on

Create a bank connection and receive wizard session object

put/api/connections

Request

Request body

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

The mode how the bank connection is synced.

bicstring

The BIC of the bank, if known already.

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

The 2-letter country code

daysinteger

Number of days for collecting turnovers from bank account

limit_daysinteger

Number of days to limit the resulting account. After every sync the account will be limited to that amount of days.

account_selection'all' | 'multi' | 'single'

Mode of account selection. If "all" is given, all available accounts from this bankconnection will be used. If "single"/"multi" is given, the customer can pick single/multiple accounts from this connection which will be used.

language'de' | 'en'

Desired language in which the customer interface will be rendered with.

fints_product_idstring

The fints product ID can be enclosed in the initial request. If you have an eIDAS certificate, then you have to send it with every request.

Example request

{
  "sync_mode": "full",
  "bic": "TESTDE88XXX",
  "country_id": "DE",
  "days": 60,
  "limit_days": 60
}

Response

Request successfully processed

wizard_session_keystring

Using the wizard_session_key you can now initialize our Wizard which is running on your website

transactionstring

We suggest that you store the internally used XS2A transaction id transaction with your transaction data, because if you later have questions about a transaction, we need this number to be able to quickly assist you.

Example response

{
  "wizard_session_key": "m5A65Cy2lwI1rOXxuvwU4MM47b4tDaV0ME9By6It",
  "transaction": "10001-xv-LEz8-oct7"
}

Changes

  • ae5fbc5feee3Revision changes
    • breaking

      removed the enum value ES of the request property

    • breaking

      removed the enum value FR of the request property

    • breaking

      removed the enum value GB of the request property

    • breaking

      removed the enum value IT of the request property

    • breaking

      removed the enum value es of the request property

    • breaking

      removed the enum value fr of the request property

    • info

      the request property default value changed from de to en