To access a payment resource or the status of a related transaction several endpoints are available. The APIs are listed below. All specifications of these APIs can be found on the API page of this developer portal.

Note that to access payment resources, you don't need to provide an access token in requests if the payment has been initiated through a redirect Oauth2 workflow

The TPP can retrieve the payment resource using the API above.

The TPP can retrieve the transaction status of a given payment using the API above.

TPP can retrieve the list of all the authorizations linked to the payment resource using the API above.

The TPP can retrieve the status of an authorization linked to the consent resource using the API above.

For specific BerlinGroup Implementation on the Payment Initiation Service, please refer to specific implementation How To.

To access all AIS API, a valid consent established between the TPP, the PSU and the ASPSP is required. In addition, when TPP are using the REDIRECT workflow, they must also provide the access token related to the given consent. The APIs accessible with this consent are listed below. All specifications of these APIs can be found on the API page of this developer portal.

Returns all the accounts (at least payment accounts) that the ASPSP managed for the PSU.

Retrieve all the characteristics of a specific account Characteristics include - Balances (current, available) - Label - Account number - Type of the account.

Returns the balances linked to the account specified.

Returns the transactions linked to the account specified.

Specific behaviour for old transactions:

Retrieving transactions older than 90 days is authorised only if the consent is valid during 20 minutes after the SCA was performed.

In the case of a one-off consent, all accounts access are authorised within these 20 minutes.

In the case of a current consent, the access to the transactions prior to 90 days is restricted to the first request for the associated account after the SCA was performed.

Pagination mechanism:

If not all transactions can be returned in a single call, a pagination mechanism is included to manage the historical depth of transactions to return through a 'page' query parameter. Response body include navigation links for paginated account reports which allow redirection to first, next, previous or last page. By default the first page is indexed as 0. 

TPP can access each AIS resources at a maximum of rolling 4 times period per day. For example:

• GET ../accounts -> 1st call on accounts
• GET ../accounts/accountAAA/balances -> 1st call on Account AAA balances
• GET ../accounts -> 2nd call on accounts
• GET ../accounts/accountBBB/transactions -> 1st call on Account BBB transactions
• GET ../accounts/accountAAA/balances -> 2nd call on Account AAA balances

The counter is not incremented when calling the same endpoint with a different page number within 15 minutes. However, in case of a second call further in the day on the endpoint with the same query parameters (page excluded), the incrementation is applied. For example:

• Within 15 minutes of the same request: counter is not incremented
• GET ../accounts/accountAAA/transactions/ ?page 0 -> counted as same request
• GET ../accounts/accountAAA/transactions/ ?page 1 -> counted as same request
• GET ../accounts/accountAAA/transactions/ ?page 0 -> counted as same request
• ... more than 15 minutes later: counter is incremented
• GET ../accounts/accountAAA/transactions/ ?page 0 (More than 15 minutes after the last call) -> counted as new request

Example of response:

{
  "account": {
    "iban": "FR46123456785423658874"
  },
  "transactions": {
    "information": [
      {
        "transactionAmount": {
          "currency": "EUR",
          "amount": 256.67
        },
        "creditorName": "Example 1",
        "creditorAccount": {
          "iban": "DE43533700240123456900"
        },
        "remittanceInformationUnstructured": "Example",
        "additionalInformationStructured": {
          "standingOrderDetails": {
            "startDate": "2019-12-06",
            "endDate": "2020-01-06",
            "executionRule": "following",
            "frequency": "Annual",
            "dayOfExecution": "23"
          }
        }
      },
      {
        "transactionAmount": {
          "currency": "EUR",
          "amount": 25
        },
        "creditorName": "Example 1",
        "creditorAccount": {
          "iban": "NL354543123456900"
        },
        "remittanceInformationUnstructured": "Example",
        "additionalInformationStructured": {
          "standingOrderDetails": {
            "startDate": "2019-12-06",
            "endDate": "2020-02-06",
            "executionRule": "preceding",
            "frequency": "Monthly",
            "dayOfExecution": "21"
          }
        }
      }
    ]
  }
}

Retrieve the list of the trusted beneficiaries of all accounts.

Retrieve the list of the trusted beneficiaries of a specific account.

For specific BerlinGroup Implementation on the Account Information Service, please refer to the specific implementation How To.

For the purpose of carrying out a payment cancellation with the XS2A APIs, it is necessary for the TPP to ask for the cancellation to the ASPSP.

In this approach, the PISP has to proceed with an OAuth2 authorization. The cancellation request is established and validated thanks to a redirection of the PSU towards the ASPSP Authentication platform.
See How to Perform a Strong Customer Authentication for details.

Asks for payment cancellation at the ASPSP for a given payment (giving id, service and product). Specificities for this API and available services and products are listed in the dedicated HowTo.

Creates an authorisation sub-resource of the payment resource for its cancellation and start the authorisation process.

Requests an authorisation from a PSU following the OAuth2 protocol. Details of the authentication workflow and user interfaces are described in the dedicated HowTo section.
Our specificities regarding the OAuth2 protocol are listed below.

response_type : code
code_challenge_method : S256

After successful authorisation, the user will be redirected to the redirect URI provided in the request with the following parameters :

For specific BerlinGroup Implementation on the Payment Initiation Service, please refer to specific implementation How To.

For the purpose of carrying out a payment initiation with the XS2A APIs, it is necessary to establish a consent between the TPP, the PSU and the ASPSP.

In this approach, the PISP has to proceed with an OAuth2 authorization. The consent is established and validated thanks to a redirection of the PSU towards the ASPSP Authentication platform.
See How to Perform a Strong Customer Authentication for details.

Note that to access payment resources, you don't need to provide an access token in requests if the payment has been initiated through a redirect Oauth2 workflow

Creates a payment resource at the ASPSP for a given payment service and product. Specificities for this API and available services and products are listed in the dedicated HowTo.

Create an authorisation sub-resource of the payment resource and start the authorisation process.

The usage of this access method is only necessary if the TPP has asked to start the authorisation process separately from the payment initiation (using the “TPP-Explicit-Authorisation-Preferred” Header).

Requests an authorisation from a PSU following the OAuth2 protocol. Details of the authentication workflow and user interfaces are described in the dedicated HowTo section.
Our specificities regarding the OAuth2 protocol are listed below.

response_type : code
code_challenge_method : S256

After successful authorisation, the user will be redirected to the redirect URI provided in the request with the following parameters :

The PIS with no IBAN / Combined Service is a feature of the AIS consent. It allows a PISP to retrieve the list of account through an AIS request when it should not be able to do so.

Thanks to this feature, a PISP can offer a smooth PIS workflow where the PSU select a debtor IBAN from his/her account list instead of entering the IBAN manually.

TPPs with only the PISP role can only use the global consent scope availableAccounts: allAccounts.

An AIS Combined Service Consent can be one-off.

The property combinedServiceIndicator has to be set to true in the body of the request.

The combined service AIS consent is not supported for a multi authorization payment.

For specific BerlinGroup Implementation on the Payment Initiation Service, please refer to specific implementation How To.

To access all AIS APIs, it is necessary to establish a consent between the TPP, the PSU and the ASPSP.

In this approach, the AISP has to proceed with an OAuth2 authorization in order to retrieve a time-limited access token.
This access token is mandatory to access all the AIS PSD2 APIs. It is associated to the consent established and validate thanks to a redirection of the PSU towards the ASPSP Authentication platform.
See How to Perform a Strong Customer Authentication for details.

Creates a consent resource at the ASPSP regarding access to accounts specified in this request. Specificities for this API are listed in the dedicated HowTo.

Creates an authorisation sub-resource of the consent resource and start the authorisation process.

The usage of this access method is only necessary if the TPP has asked to start the authorisation process separately from the consent establishment (using the “TPP-Explicit-Authorisation-Preferred” Header)

Requests an authorisation from a PSU following the OAuth2 protocol. Details of the authentication workflow and user interfaces are described in the dedicated HowTo section.
Our specificities regarding the OAuth2 protocol are listed below.

response_type : code
code_challenge_method : S256

After successful authorisation, the user will be redirected to the redirect URI provided in the request with the following parameters :

Requests an access token using the authorization code retrieved from the PSU authorization. This Access Token can be refreshed. The duration of access token is 1 hour, and the duration of refresh token is 180 days.

The TPP can retrieve the consent resource using the API above.

The TPP can retrieve the consent's status using the API above.

The TPP can retrieve the list of all the autorisations linked to the consent resource using the API above.

The TPP can retrieve the status of an autorisation linked to the consent resource using the API above.

The TPP can use this API to terminate a consent.

Submitting a POST /consents request with the property recurringIndicator=false and frequencyPerDay=1 allows you to create a one-off consent.

In this particular case, all AIS accounts access are authorised for a period of 20 minutes

For specific BerlinGroup Implementation on the Account Information Service, please refer to the specific implementation How To.