Confirmation BG API Flow

Funds Confirmation API Flow

Onboarding PSU

Before your first call to Funds Confirmation API PSU should authorize you to access his personal data.

1. Register Consent

1.1. Your application initiates the flow by directing PSU’s browser to the authorization endpoint. Initiation is carried out by making a GET /oauth2/authorize request with scope for CISP = "PSP_IC"

1.2. The bank authenticates PSU and establishes whether he grants or denies your access request.

1.3. Assuming PSU grants access, the bank server redirects his browser back to your application using the redirection URI provided during your application registration. The redirection URI includes an authorization code.

1.4. Your application requests an access token from the bank server's token endpoint by including the authorization code received in the previous step. The authorization code exchange is carried out by making a POST /oauth2/token request.

1.5. The bank server authenticates your application, validates the authorization code, and ensures that the redirection URI received matches the URI used to redirect your application in step 3. If it is valid, the bank responds back with an access token and a refresh token.

Refresh token will be valid for 24 hours in Sandbox environment.

Access token is generated for 300 seconds for TPP application with scope for PSP_IC for all accounts available to the PSU (according to Sandbox data).

2. Get Funds Confirmation

2.1. Your application initiate POST /funds-confirmation request with valid access token.

2.2. The bank server validates access token and transaction details. If all data in the request are correct, bank will return response TRUE (for sufficient balance) or FALSE (for insufficient balance)

If instructedAmount = OR < balance, then respond with 200 OK, "fundsAvailable": true. If instructedAmount > balance, then respond with 200 OK, "fundsAvailable": false.

3. Refresh Expired Access Token

When an access token obtained through an authorization code grant expires, your application should attempt to get a new access token by calling POST /oauth2/token. For more information see Section 6 Refreshing an Access Token in of the OAuth 2.0 specification.  If your application fails to get an access token using a refresh token (ie due to removed consent by the user), you need start consent flow from Step 1 again.