API Reference
HomeGuidesAPI ReferenceChangelogDiscussions
Log InAPI Reference
Guides

AIS options

Suggest Edits

To get the AIS options, you have to call the following endpoint of your docker:

/ob/ais/access/options/connector_id

In those options, you will find multiple informations.

See PIS API section > Get AIS options > HTTP 200 response for details.

If your code is adapted to the various options supplied here, it will be able to handle all the connectors we're proposing.

accessOption

This options tells you what the bank expect to receive for the account identification.

Customizable (0)

PSU can provide specific account numbers, granting access to balances and/or transactions for those accounts (via TransactionAccounts and BalanceAccounts properties). If no accounts are specified, depending on the consent types supported by the bank, either global consent or, if the bank allows it, the user will choose accounts during SCA authorization.

The IBANs list must be supplied in the TransactionAccounts and BalanceAccounts field of the request.

NotCustomizable (1)

Accounts can not be specified on the SDK level. Depending on the bank, PSU may have an option to choose accounts during Strong Customer Authentication on bank side.

SingleAccount (2)

PSU must specify only one single account to give access to in the SingleAccount field of the request.

Detailed (3)

This options works like Customizable, but the PSU must provide specific account identifier to give access to balances and/or transactions for them in the firld TransactionAccounts and BalanceAccounts of the request.

MultipleAccounts (4)

(Premium Connectors Only!!!) PSU must provide specific account numbers, to give access to balances and transactions for them (Accounts property).

LinkingOption

This option tells you if the bank only support one consent by PSU. if the value is 0 (linked), you must include all the accounts of the PSU already connected when you renew or add an account.

In Private mode, accounts not included won't be accessible anymore.

In Gateway mode, in addition to the requested accounts, we also ask consent renewal for the existing one(s), but your access to those existing one(s) will not be extended!! If you want to extend your access, you need to supply the existing one(s) in the request or request a global consent (not providing any IBAN), if bank allows it (check access option here above), to have access to all the accounts of the PSU. You should of course ask the permission of the PSU to do that.

Linked (0)

Only one consent, accounts access are linked

Separate (1)

Multiple consent allowed, no need to renew all the accounts

currencyOption

NA (0)

Not available

Optional (1)

The currency is not required when connecting an account

Required (2)

You must provide the account's currency when requesting access

additionalPropertiesRequested

see specific page

browserData

Indicate the data you can get from the browser and that are

  • Required (0) – The field is required.
  • Optional (1) – The field is optional.
  • Unused (2) – The field won't be transmitted to the bank
  • RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

It will simplify you life if you send the most you can for every connectors.

decoupledUpdate

For the connector using DECOUPLED result status, we have added an AIS and PIS option that allows you to know if you can, during the the time the user is completing this decoupled action, call the finalize to have a decoupled status update.
If the decoupled is still ongoing, we return a result status RETRY (8). You should then wait some hundreds milliseconds and try again.
if the decoupled is finished, you'll receive another result status that have to be processed as describe in the documentation.
Sadly, not all bank are supporting this decoupled status update. In this non-supported case, the only possibility is that you prompt the user to confirm the completion of the decoupled action with something like a button or a link.

The option field is "decoupledUpdate" at the root of the AIS options

{
  "MaxConsentDuration": 179,
  "AccessOption": 1,
  "CurrencyOption": 0,
  "LinkingOption": 1,
  "TransactionsSavingDateField": 0,
  "AccountSchemes": [
    20
  ],
  "BrowserData": {... },
  "AdditionalPropertiesRequested": [],
  "decoupleUpdate": 0

The values are:

  • Unused (0) - The result status Decouple is not used.
  • Auto (1) - You can call finalize in background to know if the decoupled is finished. A resultStatus of RETRY means that it's still ongoing, other statuses to be processed as described in the documentation.
  • Manual (2) - You cannot call finalize in background to know if the decoupled is finished. You should prompt the PSU to indicate when he has finished. Then you can call the finalize.

Updated 2 months ago