Skip to main content

14. How to Create and Authorise a Confirmation of Funds Consent

  • Updated

Creation and Authorisation of a Confirmation of Funds Consent in Steps

This article gives an example of creation and authorisation of a consent that will allow a TPP request confirmation of available funds on a single account of a PSU.

Learn more about funds confirmation service 06. How to Request Information about Available Funds.

In this example, embedded SCA approach is used. Learn more about SCA approaches that are supported in XS2A 02.XS2A - Embedded SCA Approach with Selection of SCA Methods.

 

Prerequisites

Your certificate must contain the PSP role = PSP_IC.

 

Step 1 Consent creation

On this step request to create a consent with consent data is sent to XS2A.

XS2A validates the role from the certificate, PSU-ID and request syntax. If all the validations have been completed successfully, XS2A returns a consentId.

It means that a consent resource has been created and must be authorised by PSU.

Created consent resource will be accessible under given consentId during 30 minutes from the moment of creation. Authorisation of given consent must be completed within this time.

If a consent is not authorised and its validity time is over the access to this resource will be cancelled and consent creation flow will be terminated.

Request

  1. Go to /v2/consents/confirmation-of-funds
  2. Fill in mandatory data
  3. Fill in consent data according to the consent model
Example

{"account":
{ "iban": "DE40100100103307118608" }
}
  1. Execute the request.

Response

HTTP status code: 201 Created

Example

{
"consentStatus": "received",
"consentId": "{consentId}",
"_links": {"startAuthorisation": {"v2/consents/confirmation-of-funds/{consentId}/authorisations"}
}

 

Step 2 Consent authorisation initiation

On this step consent authorisation is initiated.

XS2A validates the role from the certificate, consentId and request syntax. If all the validations have been completed successfully, XS2A returns an authorisationId inside the "updatePsuAuthentication" link.

It means that an authorisation sub-resource has been created for given consentId.

Created authorisation sub-resource will be accessible under given authorisationId during 30 minutes from the moment of creation. Authorisation of given consent must be completed within this time.

If a consent is not authorised and its validity time is over the access to this resource will be cancelled and consent creation flow will be terminated.

Request

  1. Go to /v2/consents/confirmation-of-funds/{consentId}/authorisations or follow the "startAuthorisation" link from the response in Step 1.
  2. Fill in mandatory data
    • Method: POST
    • PSU-ID: same as in Step 1
    • X-Request-ID: valid UUID
    • consentId: consentId received in response in Step 1
    • body: no body
  3. Execute the request.

Response

HTTP status code: 200 Ok

Example

{"scaStatus": "received",
"_links": {"updatePsuAuthentication": "/v2/consents/confirmation-of-funds/{consentId}/authorisations/{authorisationId}"}
}

 

Step 3 Provide PSU password

On this step PSU password must be provided.

Please, use correspondent password from 09. Sandbox Test Accounts and Test Data.

Request

  1. Go to /v2/consents/confirmation-of-funds/{consentId}/authorisations/{authorisationId} or follow the "updatePsuAuthentication" link from the response in Step 2.
  2. Fill in mandatory data
    • Method: PUT
    • PSU-ID: same as in Step 1
    • X-Request-ID: valid UUID
    • authorisationId:authorisationId received in response in Step 2
    • consentId: consentId received in response in Step 1
  3. Fill in psuData
Example

{"psuData": {"password": "string"}
}
  1. Execute the request.

Response

HTTP status code: 200 Ok

Example

{
"scaStatus": "psuAuthenticated",
"scaMethods": [
{
"authenticationType": "SMS_OTP",
"authenticationMethodId": "sms",
"name": "Device name"
},
{
"authenticationType": "CHIP_OTP",
"authenticationMethodId": "chip",
"name": "Device name"
}
],
"_links": {"selectAuthenticationMethod": "/v2/consents/confirmation-of-funds/{consentId}/authorisations/{authorisationId}",
"scaStatus": "/v2/consents/confirmation-of-funds/{consentId}/authorisations/{authorisationId}"}
}

 

Step 4 Select SCA method

PSU was authenticated successfully with its PSU-ID and password in the previous step and now XS2A offers selection of authentication methods.

An authentication method is a format of the 2nd factor that must be provided by PSU in order to complete the authorisation of a consent.

To trigger Decoupled SCA please use authenticationMethodId where "authenticationType" =  "PUSH_OTP” in the response in the Step 3.

Request

  1. Go to /v2/consents/confirmation-of-funds/{consentId}/authorisations/{authorisationId} or follow the "selectAuthenticationMethod" link from the response in Step 3.
  2. Fill in mandatory data
    • Method: PUT
    • PSU-ID: same as in Step 1
    • X-Request-ID: valid UUID
    • authorisationId:authorisationId received in response in Step 2
    • consentId: consentId received in response in Step 1
  3. Fill in authenticationMethodId 
Example

{"authenticationMethodId": "chip"
}
  1. Execute the request.

Response

HTTP status code: 200 Ok

Note: "authoriseTransaction" link will only be returned if EMBEDDED SCA has been chosen.

Example

{
"scaStatus": "scaMethodSelected",
"chosenScaMethod": {
"authenticationType": "CHIP_OTP",
"authenticationMethodId": "chip",
"name": "Device name"
},
"_links": {"scaStatus": "/v2/consents/confirmation-of-funds/{consentId}/authorisations/{authorisationId}",
"authoriseTransaction": "/v2/consents/confirmation-of-funds/{consentId}/authorisations/{authorisationId}"}
}

 

Step 5 Provide 2nd factor

This is the final step where PSU completes consent authorisation through providing the 2nd factor.

In real-live operations a bank will generate and send the 2nd factor to PSU.

In the Sandbox the behaviour of a bank is simulated: XS2A doesn't generate and sent any 2nd factors but offers default format of authentication data. Please, see 09. Sandbox Test Accounts and Test Data

Request

  1. Go to /v2/consents/confirmation-of-funds/{consentId}/authorisations/{authorisationId} or  follow the "authoriseTransaction" link from the response in Step 4.
  2. Fill in mandatory attributes
    • Method: PUT
    • PSU-ID: same as in Step 1
    • X-Request-ID: valid UUID
    • authorisationId:authorisationId received in response in Step 2
    • consentId: consentId received in response in Step 1
  3. Fill in scaAuthenticationData according to the authentication method selected in the previous step. Please, see 09. Sandbox Test Accounts and Test Data.
Example

{ "scaAuthenticationData": "string" }
  1. Execute the request.

Response

HTTP status code: 200 Ok

Example

{
"scaStatus": "finalised",
"_links": {"scaStatus": "/v2/consents/confirmation-of-funds/{consentId}/authorisations/{authorisationId}"}
}

a

Powered by Zendesk