Support

Create Consent - Account

In order to retrieve a user’s account data, explicit consent has to be created and confirmed by the user. User’s account data are provided only for valid consents. By following the below listed steps a valid consent would be created:

1st step: POST/consents - Create consent
This method creates a consent resource, defining access rights to dedicated accounts of a given PSU-ID. For details please see call parameters description. TPP is also required to redirect the user to the authorisation server with appropriate data that is received from a successful first call (POST Create Consent), redirect links are provided within the response.

Important: Consent can be created for account data, transaction data, balance data with a single method. To obtain only account data, “accounts” has to contain valid account data in this method. To obtain transactions data, “accounts” and “transactions” in the method Create consent has to contain valid account data. To obtain balance data, “accounts” and “balances” in the method Create consent has to contain valid account data.

2nd step: GET/consents/{consentId}/status - Consent status request
Read the status of an account information consent resource. Once the »Consent status request« returns the “consentStatus” “valid”, the consent was properly authorised by the user and can be used in further flows for retrieving account data.

Optional methods:
• GET/consents/{consentId} - Get Consent Request
• DELETE/consents/{consentId} - Delete Consent
• GET/consents/{consentId}/authorisations - Get Consent Authorisation Sub-Resources Request
• GET/consents/{consentId}/authorisations/{authorisationId} - Read the SCA status of the consent authorisation.

Get Account Details

Prerequisite: valid consent (see Create consent) with valid IBAN in “accounts” in the method Create consent.
Steps to get account data details:

1st step: GET/accounts - Read Account List
Read the identifiers (resource ID) of the available payment account together with booking balance information, depending on the consent granted. This method requires to provide the consentID as a header parameter, and will return the correct account according to the provided consent.

2nd step: GET/accounts/{account-id} - Read Account Details
Returns details about an account based on the provided resource ID, obtained with the method Read Account List, with balances where applicable.

Get Account Transaction List and/or Transaction details

Prerequisite: valid consent (see Create consent) with valid IBAN in “accounts” and “transactions” in the method Create consent.
Steps to get transaction list and details data:

1st step: GET/accounts - Read Account List
Read the identifiers (resource ID) of the available payment account together with booking balance information, depending on the consent granted. This method requires a consentID to be provided as a header parameter, according to which the correct account is returned.

2nd step: GET/accounts/{account-id}/transactions - Read Transaction List
Read transaction reports or transaction lists of a given account addressed by "account-id", depending on the steering parameter "bookingStatus" together with balances.
Important: The »Read Transaction List« call has some query parameters that can be used to narrow down the list of returned data, please check the specifications of this call for more details.

3rd step: GET/accounts/{account-id}/transactions/{transactionId} - Read Transaction Details
Reads transaction details from a given transaction addressed by "resourceId" on a given account addressed by "account-id". This call is only available on transactions as reported in a JSON format.

Read Account Balances

Prerequisite: valid consent (see Create consent) with valid IBAN in “accounts” and “balances” in the method Create consent.
Steps to get balance data:

1st step: GET/accounts - Read Account List
Read the identifiers (resource ID) of the available payment account together with booking balance information, depending on the consent granted. This method requires a consentID to be provided as a header parameter, according to which the correct account is returned.

2nd step: GET/accounts/{account-id}/balances Read Balance
Reads account balance data from a given account addressed by "account-id".

Check Funds Available
Prerequisite: valid consent (see Create consent) with valid IBAN in “accounts”, parameters “confirmationOfFundsAllowed” with the value “true” and “validUntil” has to be set to “9999-12-31”, in addition, “accounts” has to contain valid account data, “transactions” and “balances” have to be empty in the method Create consent.

Steps to check if funds are available for payment execution:

1st step: POST/funds-confirmations - Confirmation of Funds Request
Checks whether a specific amount is available at the time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by IBAN and TPP respectively.

Initiate Payment – SCA required

Steps to initiate a payment:

1st step: POST/{payment-service}/{payment-product} - Payment initiation request
This method is used to initiate a payment at the ASPSP. Parameters of this call are described in details under the method specification. 
Important: After the initial »Payment Initiation Request« the user needs to be redirected to the authorisation URL provided in »scaRedirect« of the response.

2nd step: GET/{payment-service}/{payment-product}/{paymentId}/status - Payment initiation status request
This call is optional, but gives essential information regarding the transaction status of a payment initiation.

Optional methods:
• GET/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId} - Read the SCA Status of the payment authorisation
• GET/{payment-service}/{payment-product}/{paymentId} - Get Payment Information
• GET/{payment-service}/{payment-product}/{paymentId}/authorisations - Get Payment Initiation Authorisation Sub-Resources Request

Initiate Payment – SCA not required
Steps to initiate a payment:

1st step: POST/{payment-service}/{payment-product} - Payment initiation request
This method is used to initiate a payment at the ASPSP. Parameters of this call are described in details under the method specification.

2nd step: GET/{payment-service}/{payment-product}/{paymentId}/status - Payment initiation status request
This call is optional, but gives essential information regarding the transaction status of a payment initiation.

Optional methods:
• GET/{payment-service}/{payment-product}/{paymentId} - Get Payment Information
• GET/{payment-service}/{payment-product}/{paymentId}/authorisations - Get Payment Initiation Authorisation Sub-Resources Request

Log in on this developer porta and click the “Apps” section in menu.

Click the »Create new App« button.

Enter the »Title« of your application and optional »Description and »OAuth Redirect URI« and past in your certificate (in case the API requires one). Click on »Save« button to complete the registration of your application.

Now that you've registered your application, you can browse the APIs and subscribe on them. Client ID and Client Secred Id are generate automatically. Make sure you save the data.

Before using test cases below, please read the API documentation and swagger definitions under API product tab.
In Bankart API portal mandatory PSD2 APIs are available.
API specification is available as a Swagger file, under »Explore our API« button.
All APIs follow Berlin standard, JSON format is supported.
APIs published on the portal are sandbox versions.
APIs published on the portal return static answers.
All data in the tables below is intended for testing and has no relation to real data.
Data in tables can change at any time without prior notice.

Payment Instrument Issuing

Account Information Service

Payment Initiation Service API

Consents Service API

By definition certain crucial PSD2 APIs require OAuth2. These are marked accordingly in our API documentation and swagger definitions. Here are some examples:

- consent APIs (all within PSD2 Account Information product)

- payment APIs (e.g. payment initiation request) 

On top of that, these APIs in principle (when there is no exemption defined by business rules) also require an SCA (strong customer authentication) post step. 

3.1 OAuth2

We are using the authorization code flow. As a first step you need to open the GET /oauth2/authorize link in a browser with the URL parameters response_type, client_id, redirect_uri, scope and IBAN (optional).

Possible values for scope are:

- for Account Information: psd2:acc

- for Payment Initiation: psd2:pay

Please mind scope used in this sandbox differs from scope that should be used in production environment. Check production swagger for more information as to production values.

Example:

.../oauth2/authorize?response_type=code&client_id=db...&redirect_uri=https://www.xyztpp.si&scope=acc&iban=SI56XXXXXXXXXXXXXXX

Of course you need to use your own i.e. you subscribed applications client_id and redirect URI. You can also achieve this redirect by selecting the "Authorize" button in the documentation of the protected API. As the authorization page opens, enter any username and password combination and select "Allow Access" on the second page. This will send you to the redirect URI with a newly generated access code as an URL parameter. You need to extract this code from this URL to get the token. To exchange the access code for the token you need some tool that can do a simple POST request, for example curl. You need to pass grant_type, client_id and code as x-www-form-urlencoded data. Here is an example:

curl -d "grant_type=authorization_code&client_id=dbe...&code=AAL7lhdq6k..." -H "Content-Type: application/x-www-form-urlencoded" -H "accept:application/json" -X POST https://api.bankart.si/psd2/delavska-hranilnica/sandbox/oauth2/token

This will return a JSON object with the token, which you can then use to call the OAuth2 protected APIs (insert the token value prefixed with "Bearer " in the "authorization" header field) or simply paste it in the "Acces token" field in the developer portal and call the API this way. For details (URLs , parameters etc.) please also see the published swagger documents. 

3.2 SCA (Strong Customer Authentication)

According to PSD2 Berlin Group standard a SCA step is required after certain crucial i.e. sensitive API calls. We are using an implicit flow with a simple redirect (not OAuth2) for this purpose. Please check the API response header for ASPSP/PISP-SCA-Approach value and when present send i.e. redirect the end user to the URL provided in the _links/scaRedirect response element. There is no direct return of information from this redirect to your app, but certain crucial calls are made in the background to complete the authorization and process the payment or create a consent object. In our sandbox environment you can even omit this step, but for production APIs it is critical for the client to be redirected to the SCA link (when provided) if you wish the entire API flow to complete as intended. You are able to check the outcome of SCA with corresponding .../status API calls (for their details please see the API documentation i.e. swagger definition) from your application.