Account Information API (AIS)

AIS and Consents API

createAuthorisation

Start the authorisation process for a consent

Create an authorisation sub-resource and start the authorisation process of a consent. The message might in addition transmit authentication and authorisation related data. his method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the consent. The ASPSP might make the usage of this access method unnecessary, since the related authorisation resource will be automatically created by the ASPSP after the submission of the consent data with the first POST consents call. The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource. This applies in the following scenarios: * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment initiation response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms: * 'startAuthorisationWithPsuIdentfication', * 'startAuthorisationWithPsuAuthentication' * 'startAuthorisationWithEncryptedPsuAuthentication' * 'startAuthorisationWithAuthentciationMethodSelection' * The related payment initiation cannot yet be executed since a multilevel SCA is mandated. * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding payment cancellation response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above. * The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation. * The signing basket needs to be authorised yet.


/api/v1/consents/{consentId}/authorisations

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*,application/problem+json"\
"//api/v1/consents/{consentId}/authorisations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        String tPPRedirectURI = tPPRedirectURI_example; // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification. 
        String tPPNokRedirectURI = tPPNokRedirectURI_example; // String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            CreateAuthorisationResponse result = apiInstance.createAuthorisation(xRequestID, consentId, tPPRedirectURI, tPPNokRedirectURI, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#createAuthorisation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        String tPPRedirectURI = tPPRedirectURI_example; // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification. 
        String tPPNokRedirectURI = tPPNokRedirectURI_example; // String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            CreateAuthorisationResponse result = apiInstance.createAuthorisation(xRequestID, consentId, tPPRedirectURI, tPPNokRedirectURI, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#createAuthorisation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *consentId = consentId_example; // ID of the corresponding consent object as returned by an account information consent request. 
String *tPPRedirectURI = tPPRedirectURI_example; // URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification.  (optional)
String *tPPNokRedirectURI = tPPNokRedirectURI_example; // If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.  (optional)
String *pSUIPAddress = pSUIPAddress_example; // The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Start the authorisation process for a consent
[apiInstance createAuthorisationWith:xRequestID
    consentId:consentId
    tPPRedirectURI:tPPRedirectURI
    tPPNokRedirectURI:tPPNokRedirectURI
    pSUIPAddress:pSUIPAddress
              completionHandler: ^(CreateAuthorisationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var consentId = consentId_example; // {{String}} ID of the corresponding consent object as returned by an account information consent request. 
var opts = { 
  'tPPRedirectURI': tPPRedirectURI_example, // {{String}} URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification. 
  'tPPNokRedirectURI': tPPNokRedirectURI_example, // {{String}} If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. 
  'pSUIPAddress': pSUIPAddress_example // {{String}} The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAuthorisation(xRequestID, consentId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAuthorisationExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var consentId = consentId_example;  // String | ID of the corresponding consent object as returned by an account information consent request. 
            var tPPRedirectURI = tPPRedirectURI_example;  // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification.  (optional) 
            var tPPNokRedirectURI = tPPNokRedirectURI_example;  // String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.  (optional) 
            var pSUIPAddress = pSUIPAddress_example;  // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional) 

            try
            {
                // Start the authorisation process for a consent
                CreateAuthorisationResponse result = apiInstance.createAuthorisation(xRequestID, consentId, tPPRedirectURI, tPPNokRedirectURI, pSUIPAddress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.createAuthorisation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
$tPPRedirectURI = tPPRedirectURI_example; // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification. 
$tPPNokRedirectURI = tPPNokRedirectURI_example; // String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. 
$pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 

try {
    $result = $api_instance->createAuthorisation($xRequestID, $consentId, $tPPRedirectURI, $tPPNokRedirectURI, $pSUIPAddress);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->createAuthorisation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $consentId = consentId_example; # String | ID of the corresponding consent object as returned by an account information consent request. 
my $tPPRedirectURI = tPPRedirectURI_example; # String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification. 
my $tPPNokRedirectURI = tPPNokRedirectURI_example; # String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. 
my $pSUIPAddress = pSUIPAddress_example; # String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 

eval { 
    my $result = $api_instance->createAuthorisation(xRequestID => $xRequestID, consentId => $consentId, tPPRedirectURI => $tPPRedirectURI, tPPNokRedirectURI => $tPPNokRedirectURI, pSUIPAddress => $pSUIPAddress);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->createAuthorisation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
consentId = consentId_example # String | ID of the corresponding consent object as returned by an account information consent request. 
tPPRedirectURI = tPPRedirectURI_example # String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification.  (optional)
tPPNokRedirectURI = tPPNokRedirectURI_example # String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.  (optional)
pSUIPAddress = pSUIPAddress_example # String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

try: 
    # Start the authorisation process for a consent
    api_response = api_instance.create_authorisation(xRequestID, consentId, tPPRedirectURI=tPPRedirectURI, tPPNokRedirectURI=tPPNokRedirectURI, pSUIPAddress=pSUIPAddress)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->createAuthorisation: %s\n" % e)

Parameters

Path parameters
Name Description
consentId*
String
ID of the corresponding consent object as returned by an account information consent request.
Required
Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required
TPP-Redirect-URI
String
URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. **Remark for Future:** This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI
String
If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
PSU-IP-Address
String
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getAccount

Read account details

Reads details about an account, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed details of this account depends then on the stored consent addressed by consentId, respectively the OAuth2 access token. **NOTE:** The account-id can represent a multicurrency account. In this case the currency code is set to "XXX". Give detailed information about the addressed account. Give detailed information about the addressed account together with balance information


/api/v1/accounts/{account-resource-id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*,application/problem+json"\
"//api/v1/accounts/{account-resource-id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
        String accountResourceId = accountResourceId_example; // String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            AccountResponse result = apiInstance.getAccount(xRequestID, consentID, accountResourceId, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
        String accountResourceId = accountResourceId_example; // String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            AccountResponse result = apiInstance.getAccount(xRequestID, consentID, accountResourceId, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *consentID = consentID_example; // This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
String *accountResourceId = accountResourceId_example; // This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
String *pSUIPAddress = pSUIPAddress_example; // The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Read account details
[apiInstance getAccountWith:xRequestID
    consentID:consentID
    accountResourceId:accountResourceId
    pSUIPAddress:pSUIPAddress
              completionHandler: ^(AccountResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var consentID = consentID_example; // {{String}} This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
var accountResourceId = accountResourceId_example; // {{String}} This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
var opts = { 
  'pSUIPAddress': pSUIPAddress_example // {{String}} The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccount(xRequestID, consentID, accountResourceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var consentID = consentID_example;  // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
            var accountResourceId = accountResourceId_example;  // String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
            var pSUIPAddress = pSUIPAddress_example;  // String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU.  (optional) 

            try
            {
                // Read account details
                AccountResponse result = apiInstance.getAccount(xRequestID, consentID, accountResourceId, pSUIPAddress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.getAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$consentID = consentID_example; // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
$accountResourceId = accountResourceId_example; // String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
$pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 

try {
    $result = $api_instance->getAccount($xRequestID, $consentID, $accountResourceId, $pSUIPAddress);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->getAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $consentID = consentID_example; # String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
my $accountResourceId = accountResourceId_example; # String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
my $pSUIPAddress = pSUIPAddress_example; # String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 

eval { 
    my $result = $api_instance->getAccount(xRequestID => $xRequestID, consentID => $consentID, accountResourceId => $accountResourceId, pSUIPAddress => $pSUIPAddress);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->getAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
consentID = consentID_example # String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
accountResourceId = accountResourceId_example # String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
pSUIPAddress = pSUIPAddress_example # String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

try: 
    # Read account details
    api_response = api_instance.get_account(xRequestID, consentID, accountResourceId, pSUIPAddress=pSUIPAddress)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->getAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account-resource-id*
String
This identification is denoting the addressed (card) account. The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
Required
Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required
Consent-ID*
String
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Required
PSU-IP-Address
String
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getAccountTransactions

Read transaction list of an account

Read transaction reports or transaction lists of a given account ddressed by "account-id", depending on the steering parameter "bookingStatus" together with balances. For a given account, additional parameters are e.g. the attributes "dateFrom" and "dateTo". The ASPSP might add balance information, if transaction lists without balances are not supported.


/api/v1/accounts/{account-resource-id}/transactions

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*,application/problem+json"\
"//api/v1/accounts/{account-resource-id}/transactions?bookingStatus=&dateFrom=&dateTo=&itemsPerPage=&pageIndex="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
        String accountResourceId = accountResourceId_example; // String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
        String bookingStatus = bookingStatus_example; // String | Permitted codes are    * "booked",   * "pending",  and    * "both". "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend. If supported, "both" means to request transaction reports of transaction of bookingStatus either "pending" or "booked". 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 
        date dateFrom = 2013-10-20; // date | Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information".  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP. 
        date dateTo = 2013-10-20; // date | End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.   Might be ignored if a delta function is used.  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP. 
        Integer itemsPerPage = 56; // Integer | This data attribute is indicating current transaction items on one page.  Optional if supported by API provider. 
        Integer pageIndex = 56; // Integer | This data attribute is indicating current transaction page.  Optional if supported by API provider. 
        try {
            AccountTransactionResponse result = apiInstance.getAccountTransactions(xRequestID, consentID, accountResourceId, bookingStatus, pSUIPAddress, dateFrom, dateTo, itemsPerPage, pageIndex);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getAccountTransactions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
        String accountResourceId = accountResourceId_example; // String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
        String bookingStatus = bookingStatus_example; // String | Permitted codes are    * "booked",   * "pending",  and    * "both". "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend. If supported, "both" means to request transaction reports of transaction of bookingStatus either "pending" or "booked". 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 
        date dateFrom = 2013-10-20; // date | Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information".  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP. 
        date dateTo = 2013-10-20; // date | End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.   Might be ignored if a delta function is used.  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP. 
        Integer itemsPerPage = 56; // Integer | This data attribute is indicating current transaction items on one page.  Optional if supported by API provider. 
        Integer pageIndex = 56; // Integer | This data attribute is indicating current transaction page.  Optional if supported by API provider. 
        try {
            AccountTransactionResponse result = apiInstance.getAccountTransactions(xRequestID, consentID, accountResourceId, bookingStatus, pSUIPAddress, dateFrom, dateTo, itemsPerPage, pageIndex);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getAccountTransactions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *consentID = consentID_example; // This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
String *accountResourceId = accountResourceId_example; // This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
String *bookingStatus = bookingStatus_example; // Permitted codes are    * "booked",   * "pending",  and    * "both". "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend. If supported, "both" means to request transaction reports of transaction of bookingStatus either "pending" or "booked". 
String *pSUIPAddress = pSUIPAddress_example; // The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU.  (optional)
date *dateFrom = 2013-10-20; // Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information".  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP.  (optional)
date *dateTo = 2013-10-20; // End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.   Might be ignored if a delta function is used.  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP.  (optional)
Integer *itemsPerPage = 56; // This data attribute is indicating current transaction items on one page.  Optional if supported by API provider.  (optional)
Integer *pageIndex = 56; // This data attribute is indicating current transaction page.  Optional if supported by API provider.  (optional)

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Read transaction list of an account
[apiInstance getAccountTransactionsWith:xRequestID
    consentID:consentID
    accountResourceId:accountResourceId
    bookingStatus:bookingStatus
    pSUIPAddress:pSUIPAddress
    dateFrom:dateFrom
    dateTo:dateTo
    itemsPerPage:itemsPerPage
    pageIndex:pageIndex
              completionHandler: ^(AccountTransactionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var consentID = consentID_example; // {{String}} This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
var accountResourceId = accountResourceId_example; // {{String}} This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
var bookingStatus = bookingStatus_example; // {{String}} Permitted codes are    * "booked",   * "pending",  and    * "both". "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend. If supported, "both" means to request transaction reports of transaction of bookingStatus either "pending" or "booked". 
var opts = { 
  'pSUIPAddress': pSUIPAddress_example, // {{String}} The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 
  'dateFrom': 2013-10-20, // {{date}} Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information".  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP. 
  'dateTo': 2013-10-20, // {{date}} End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.   Might be ignored if a delta function is used.  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP. 
  'itemsPerPage': 56, // {{Integer}} This data attribute is indicating current transaction items on one page.  Optional if supported by API provider. 
  'pageIndex': 56 // {{Integer}} This data attribute is indicating current transaction page.  Optional if supported by API provider. 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountTransactions(xRequestID, consentID, accountResourceId, bookingStatus, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountTransactionsExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var consentID = consentID_example;  // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
            var accountResourceId = accountResourceId_example;  // String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
            var bookingStatus = bookingStatus_example;  // String | Permitted codes are    * "booked",   * "pending",  and    * "both". "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend. If supported, "both" means to request transaction reports of transaction of bookingStatus either "pending" or "booked". 
            var pSUIPAddress = pSUIPAddress_example;  // String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU.  (optional) 
            var dateFrom = 2013-10-20;  // date | Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information".  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP.  (optional) 
            var dateTo = 2013-10-20;  // date | End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.   Might be ignored if a delta function is used.  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP.  (optional) 
            var itemsPerPage = 56;  // Integer | This data attribute is indicating current transaction items on one page.  Optional if supported by API provider.  (optional) 
            var pageIndex = 56;  // Integer | This data attribute is indicating current transaction page.  Optional if supported by API provider.  (optional) 

            try
            {
                // Read transaction list of an account
                AccountTransactionResponse result = apiInstance.getAccountTransactions(xRequestID, consentID, accountResourceId, bookingStatus, pSUIPAddress, dateFrom, dateTo, itemsPerPage, pageIndex);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.getAccountTransactions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$consentID = consentID_example; // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
$accountResourceId = accountResourceId_example; // String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
$bookingStatus = bookingStatus_example; // String | Permitted codes are    * "booked",   * "pending",  and    * "both". "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend. If supported, "both" means to request transaction reports of transaction of bookingStatus either "pending" or "booked". 
$pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 
$dateFrom = 2013-10-20; // date | Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information".  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP. 
$dateTo = 2013-10-20; // date | End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.   Might be ignored if a delta function is used.  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP. 
$itemsPerPage = 56; // Integer | This data attribute is indicating current transaction items on one page.  Optional if supported by API provider. 
$pageIndex = 56; // Integer | This data attribute is indicating current transaction page.  Optional if supported by API provider. 

try {
    $result = $api_instance->getAccountTransactions($xRequestID, $consentID, $accountResourceId, $bookingStatus, $pSUIPAddress, $dateFrom, $dateTo, $itemsPerPage, $pageIndex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->getAccountTransactions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $consentID = consentID_example; # String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
my $accountResourceId = accountResourceId_example; # String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
my $bookingStatus = bookingStatus_example; # String | Permitted codes are    * "booked",   * "pending",  and    * "both". "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend. If supported, "both" means to request transaction reports of transaction of bookingStatus either "pending" or "booked". 
my $pSUIPAddress = pSUIPAddress_example; # String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 
my $dateFrom = 2013-10-20; # date | Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information".  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP. 
my $dateTo = 2013-10-20; # date | End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.   Might be ignored if a delta function is used.  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP. 
my $itemsPerPage = 56; # Integer | This data attribute is indicating current transaction items on one page.  Optional if supported by API provider. 
my $pageIndex = 56; # Integer | This data attribute is indicating current transaction page.  Optional if supported by API provider. 

eval { 
    my $result = $api_instance->getAccountTransactions(xRequestID => $xRequestID, consentID => $consentID, accountResourceId => $accountResourceId, bookingStatus => $bookingStatus, pSUIPAddress => $pSUIPAddress, dateFrom => $dateFrom, dateTo => $dateTo, itemsPerPage => $itemsPerPage, pageIndex => $pageIndex);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->getAccountTransactions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
consentID = consentID_example # String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
accountResourceId = accountResourceId_example # String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
bookingStatus = bookingStatus_example # String | Permitted codes are    * "booked",   * "pending",  and    * "both". "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend. If supported, "both" means to request transaction reports of transaction of bookingStatus either "pending" or "booked". 
pSUIPAddress = pSUIPAddress_example # String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU.  (optional)
dateFrom = 2013-10-20 # date | Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information".  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP.  (optional)
dateTo = 2013-10-20 # date | End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.   Might be ignored if a delta function is used.  For booked transactions, the relevant date is the booking date.   For pending transactions, the relevant date is the entry date, which may not be transparent  neither in this API nor other channels of the ASPSP.  (optional)
itemsPerPage = 56 # Integer | This data attribute is indicating current transaction items on one page.  Optional if supported by API provider.  (optional)
pageIndex = 56 # Integer | This data attribute is indicating current transaction page.  Optional if supported by API provider.  (optional)

try: 
    # Read transaction list of an account
    api_response = api_instance.get_account_transactions(xRequestID, consentID, accountResourceId, bookingStatus, pSUIPAddress=pSUIPAddress, dateFrom=dateFrom, dateTo=dateTo, itemsPerPage=itemsPerPage, pageIndex=pageIndex)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->getAccountTransactions: %s\n" % e)

Parameters

Path parameters
Name Description
account-resource-id*
String
This identification is denoting the addressed (card) account. The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
Required
Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required
Consent-ID*
String
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Required
PSU-IP-Address
String
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
Query parameters
Name Description
bookingStatus*
String
Permitted codes are * "booked", * "pending", and * "both". "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend. If supported, "both" means to request transaction reports of transaction of bookingStatus either "pending" or "booked".
Required
dateFrom
date (date)
Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information". For booked transactions, the relevant date is the booking date. For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.
dateTo
date (date)
End date (inclusive the data dateTo) of the transaction list, default is "now" if not given. Might be ignored if a delta function is used. For booked transactions, the relevant date is the booking date. For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.
itemsPerPage
Integer (int32)
This data attribute is indicating current transaction items on one page. Optional if supported by API provider.
pageIndex
Integer (int32)
This data attribute is indicating current transaction page. Optional if supported by API provider.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getAccounts

Read account list

Read the identifiers of the available payment account together with booking balance information, depending on the consent granted. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed list of accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the OAuth2 access token. Returns all identifiers of the accounts, to which an account access has been granted to through the /consents endpoint by the PSU. In addition, relevant information about the accounts and hyperlinks to corresponding account information resources are provided if a related consent has been already granted. Remark: Note that the /consents endpoint optionally offers to grant an access on all available payment accounts of a PSU. In this case, this endpoint will deliver the information about all available payment accounts of the PSU at this ASPSP.


/api/v1/accounts

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*,application/problem+json"\
"//api/v1/accounts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            array[AccountResponse] result = apiInstance.getAccounts(xRequestID, consentID, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getAccounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            array[AccountResponse] result = apiInstance.getAccounts(xRequestID, consentID, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getAccounts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *consentID = consentID_example; // This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
String *pSUIPAddress = pSUIPAddress_example; // The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Read account list
[apiInstance getAccountsWith:xRequestID
    consentID:consentID
    pSUIPAddress:pSUIPAddress
              completionHandler: ^(array[AccountResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var consentID = consentID_example; // {{String}} This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
var opts = { 
  'pSUIPAddress': pSUIPAddress_example // {{String}} The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccounts(xRequestID, consentID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var consentID = consentID_example;  // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
            var pSUIPAddress = pSUIPAddress_example;  // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional) 

            try
            {
                // Read account list
                array[AccountResponse] result = apiInstance.getAccounts(xRequestID, consentID, pSUIPAddress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.getAccounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$consentID = consentID_example; // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
$pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 

try {
    $result = $api_instance->getAccounts($xRequestID, $consentID, $pSUIPAddress);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->getAccounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $consentID = consentID_example; # String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
my $pSUIPAddress = pSUIPAddress_example; # String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 

eval { 
    my $result = $api_instance->getAccounts(xRequestID => $xRequestID, consentID => $consentID, pSUIPAddress => $pSUIPAddress);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->getAccounts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
consentID = consentID_example # String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
pSUIPAddress = pSUIPAddress_example # String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

try: 
    # Read account list
    api_response = api_instance.get_accounts(xRequestID, consentID, pSUIPAddress=pSUIPAddress)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->getAccounts: %s\n" % e)

Parameters

Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required
Consent-ID*
String
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Required
PSU-IP-Address
String
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Status: 200 - OK. In case, no account is accessible, the ASPSP shall return an empty array. As this is also considered a positive response, the Response code must still be 200.

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getAccountsList

Get list of Accounts

Allows to request the list of all PSU’s accounts without PSU’s consent. This request needs specific OAuth authentication scope to be granted – account.lists.


/api/v1/account-list

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*,application/problem+json"\
"//api/v1/account-list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            array[AccountListResponse] result = apiInstance.getAccountsList(xRequestID, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getAccountsList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            array[AccountListResponse] result = apiInstance.getAccountsList(xRequestID, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getAccountsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *pSUIPAddress = pSUIPAddress_example; // The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Get list of Accounts
[apiInstance getAccountsListWith:xRequestID
    pSUIPAddress:pSUIPAddress
              completionHandler: ^(array[AccountListResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var opts = { 
  'pSUIPAddress': pSUIPAddress_example // {{String}} The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsList(xRequestID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsListExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var pSUIPAddress = pSUIPAddress_example;  // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional) 

            try
            {
                // Get list of Accounts
                array[AccountListResponse] result = apiInstance.getAccountsList(xRequestID, pSUIPAddress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.getAccountsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 

try {
    $result = $api_instance->getAccountsList($xRequestID, $pSUIPAddress);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->getAccountsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $pSUIPAddress = pSUIPAddress_example; # String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 

eval { 
    my $result = $api_instance->getAccountsList(xRequestID => $xRequestID, pSUIPAddress => $pSUIPAddress);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->getAccountsList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
pSUIPAddress = pSUIPAddress_example # String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

try: 
    # Get list of Accounts
    api_response = api_instance.get_accounts_list(xRequestID, pSUIPAddress=pSUIPAddress)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->getAccountsList: %s\n" % e)

Parameters

Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required
PSU-IP-Address
String
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getBalances

Read balance

Reads account data from a given account addressed by "account-id". **Remark:** This account-id can be a tokenised identification due to data protection reason since the path information might be logged on intermediary servers within the ASPSP sphere. This account-id then can be retrieved by the "Get account list" call. The account-id is constant at least throughout the lifecycle of a given consent.


/api/v1/accounts/{account-resource-id}/balances

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*,application/problem+json"\
"//api/v1/accounts/{account-resource-id}/balances"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
        String accountResourceId = accountResourceId_example; // String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            AccountBalanceResponse result = apiInstance.getBalances(xRequestID, consentID, accountResourceId, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getBalances");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
        String accountResourceId = accountResourceId_example; // String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            AccountBalanceResponse result = apiInstance.getBalances(xRequestID, consentID, accountResourceId, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getBalances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *consentID = consentID_example; // This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
String *accountResourceId = accountResourceId_example; // This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
String *pSUIPAddress = pSUIPAddress_example; // The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Read balance
[apiInstance getBalancesWith:xRequestID
    consentID:consentID
    accountResourceId:accountResourceId
    pSUIPAddress:pSUIPAddress
              completionHandler: ^(AccountBalanceResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var consentID = consentID_example; // {{String}} This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
var accountResourceId = accountResourceId_example; // {{String}} This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
var opts = { 
  'pSUIPAddress': pSUIPAddress_example // {{String}} The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBalances(xRequestID, consentID, accountResourceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBalancesExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var consentID = consentID_example;  // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
            var accountResourceId = accountResourceId_example;  // String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
            var pSUIPAddress = pSUIPAddress_example;  // String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU.  (optional) 

            try
            {
                // Read balance
                AccountBalanceResponse result = apiInstance.getBalances(xRequestID, consentID, accountResourceId, pSUIPAddress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.getBalances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$consentID = consentID_example; // String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
$accountResourceId = accountResourceId_example; // String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
$pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 

try {
    $result = $api_instance->getBalances($xRequestID, $consentID, $accountResourceId, $pSUIPAddress);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->getBalances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $consentID = consentID_example; # String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
my $accountResourceId = accountResourceId_example; # String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
my $pSUIPAddress = pSUIPAddress_example; # String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU. 

eval { 
    my $result = $api_instance->getBalances(xRequestID => $xRequestID, consentID => $consentID, accountResourceId => $accountResourceId, pSUIPAddress => $pSUIPAddress);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->getBalances: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
consentID = consentID_example # String | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. 
accountResourceId = accountResourceId_example # String | This identification is denoting the addressed (card) account.  The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call.  The account-id is the "resourceId" attribute of the account structure.  Its value is constant at least throughout the lifecycle of a given consent. 
pSUIPAddress = pSUIPAddress_example # String | The forwarded IP Address header field consists of the corresponding HTTP request  IP Address field between PSU and TPP.  It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

try: 
    # Read balance
    api_response = api_instance.get_balances(xRequestID, consentID, accountResourceId, pSUIPAddress=pSUIPAddress)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->getBalances: %s\n" % e)

Parameters

Path parameters
Name Description
account-resource-id*
String
This identification is denoting the addressed (card) account. The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
Required
Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required
Consent-ID*
String
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Required
PSU-IP-Address
String
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getConsent

Get consent request

Returns the content of an account information consent object. This is returning the data for the TPP especially in cases, where the consent was directly managed between ASPSP and PSU e.g. in a redirect SCA Approach.


/api/v1/consents/{consentId}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*,application/problem+json"\
"//api/v1/consents/{consentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            InitiateConsentResponse result = apiInstance.getConsent(xRequestID, consentId, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getConsent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            InitiateConsentResponse result = apiInstance.getConsent(xRequestID, consentId, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getConsent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *consentId = consentId_example; // ID of the corresponding consent object as returned by an account information consent request. 
String *pSUIPAddress = pSUIPAddress_example; // The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Get consent request
[apiInstance getConsentWith:xRequestID
    consentId:consentId
    pSUIPAddress:pSUIPAddress
              completionHandler: ^(InitiateConsentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var consentId = consentId_example; // {{String}} ID of the corresponding consent object as returned by an account information consent request. 
var opts = { 
  'pSUIPAddress': pSUIPAddress_example // {{String}} The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsent(xRequestID, consentId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsentExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var consentId = consentId_example;  // String | ID of the corresponding consent object as returned by an account information consent request. 
            var pSUIPAddress = pSUIPAddress_example;  // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional) 

            try
            {
                // Get consent request
                InitiateConsentResponse result = apiInstance.getConsent(xRequestID, consentId, pSUIPAddress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.getConsent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
$pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 

try {
    $result = $api_instance->getConsent($xRequestID, $consentId, $pSUIPAddress);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->getConsent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $consentId = consentId_example; # String | ID of the corresponding consent object as returned by an account information consent request. 
my $pSUIPAddress = pSUIPAddress_example; # String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 

eval { 
    my $result = $api_instance->getConsent(xRequestID => $xRequestID, consentId => $consentId, pSUIPAddress => $pSUIPAddress);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->getConsent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
consentId = consentId_example # String | ID of the corresponding consent object as returned by an account information consent request. 
pSUIPAddress = pSUIPAddress_example # String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

try: 
    # Get consent request
    api_response = api_instance.get_consent(xRequestID, consentId, pSUIPAddress=pSUIPAddress)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->getConsent: %s\n" % e)

Parameters

Path parameters
Name Description
consentId*
String
ID of the corresponding consent object as returned by an account information consent request.
Required
Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required
PSU-IP-Address
String
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getConsentAuthorisationStatus

Get consent authorisation sub-resources request

Return a list of all authorisation subresources IDs which have been created. This function returns an array of hyperlinks to all generated authorisation sub-resources.


/api/v1/consents/{consentId}/authorisations/{authorisationId}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*,application/problem+json"\
"//api/v1/consents/{consentId}/authorisations/{authorisationId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        String authorisationId = authorisationId_example; // String | Resource identification of the related SCA.
        try {
            GetConsentAuthorisationStatusResponse result = apiInstance.getConsentAuthorisationStatus(xRequestID, consentId, authorisationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getConsentAuthorisationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        String authorisationId = authorisationId_example; // String | Resource identification of the related SCA.
        try {
            GetConsentAuthorisationStatusResponse result = apiInstance.getConsentAuthorisationStatus(xRequestID, consentId, authorisationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getConsentAuthorisationStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *consentId = consentId_example; // ID of the corresponding consent object as returned by an account information consent request. 
String *authorisationId = authorisationId_example; // Resource identification of the related SCA.

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Get consent authorisation sub-resources request
[apiInstance getConsentAuthorisationStatusWith:xRequestID
    consentId:consentId
    authorisationId:authorisationId
              completionHandler: ^(GetConsentAuthorisationStatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var consentId = consentId_example; // {{String}} ID of the corresponding consent object as returned by an account information consent request. 
var authorisationId = authorisationId_example; // {{String}} Resource identification of the related SCA.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsentAuthorisationStatus(xRequestID, consentId, authorisationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsentAuthorisationStatusExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var consentId = consentId_example;  // String | ID of the corresponding consent object as returned by an account information consent request. 
            var authorisationId = authorisationId_example;  // String | Resource identification of the related SCA.

            try
            {
                // Get consent authorisation sub-resources request
                GetConsentAuthorisationStatusResponse result = apiInstance.getConsentAuthorisationStatus(xRequestID, consentId, authorisationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.getConsentAuthorisationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
$authorisationId = authorisationId_example; // String | Resource identification of the related SCA.

try {
    $result = $api_instance->getConsentAuthorisationStatus($xRequestID, $consentId, $authorisationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->getConsentAuthorisationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $consentId = consentId_example; # String | ID of the corresponding consent object as returned by an account information consent request. 
my $authorisationId = authorisationId_example; # String | Resource identification of the related SCA.

eval { 
    my $result = $api_instance->getConsentAuthorisationStatus(xRequestID => $xRequestID, consentId => $consentId, authorisationId => $authorisationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->getConsentAuthorisationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
consentId = consentId_example # String | ID of the corresponding consent object as returned by an account information consent request. 
authorisationId = authorisationId_example # String | Resource identification of the related SCA.

try: 
    # Get consent authorisation sub-resources request
    api_response = api_instance.get_consent_authorisation_status(xRequestID, consentId, authorisationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->getConsentAuthorisationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
consentId*
String
ID of the corresponding consent object as returned by an account information consent request.
Required
authorisationId*
String
Resource identification of the related SCA.
Required
Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getConsentAuthorisations

Get consent authorisation sub-resources request

Return a list of all authorisation subresources IDs which have been created. This function returns an array of hyperlinks to all generated authorisation sub-resources.


/api/v1/consents/{consentId}/authorisations

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*,application/problem+json"\
"//api/v1/consents/{consentId}/authorisations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        try {
            GetConsentAuthorisationsResponse result = apiInstance.getConsentAuthorisations(xRequestID, consentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getConsentAuthorisations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        try {
            GetConsentAuthorisationsResponse result = apiInstance.getConsentAuthorisations(xRequestID, consentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getConsentAuthorisations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *consentId = consentId_example; // ID of the corresponding consent object as returned by an account information consent request. 

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Get consent authorisation sub-resources request
[apiInstance getConsentAuthorisationsWith:xRequestID
    consentId:consentId
              completionHandler: ^(GetConsentAuthorisationsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var consentId = consentId_example; // {{String}} ID of the corresponding consent object as returned by an account information consent request. 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsentAuthorisations(xRequestID, consentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsentAuthorisationsExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var consentId = consentId_example;  // String | ID of the corresponding consent object as returned by an account information consent request. 

            try
            {
                // Get consent authorisation sub-resources request
                GetConsentAuthorisationsResponse result = apiInstance.getConsentAuthorisations(xRequestID, consentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.getConsentAuthorisations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 

try {
    $result = $api_instance->getConsentAuthorisations($xRequestID, $consentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->getConsentAuthorisations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $consentId = consentId_example; # String | ID of the corresponding consent object as returned by an account information consent request. 

eval { 
    my $result = $api_instance->getConsentAuthorisations(xRequestID => $xRequestID, consentId => $consentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->getConsentAuthorisations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
consentId = consentId_example # String | ID of the corresponding consent object as returned by an account information consent request. 

try: 
    # Get consent authorisation sub-resources request
    api_response = api_instance.get_consent_authorisations(xRequestID, consentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->getConsentAuthorisations: %s\n" % e)

Parameters

Path parameters
Name Description
consentId*
String
ID of the corresponding consent object as returned by an account information consent request.
Required
Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getStatus

Get consent request

Returns the content of an account information consent object. This is returning the data for the TPP especially in cases, where the consent was directly managed between ASPSP and PSU e.g. in a redirect SCA Approach.


/api/v1/consents/{consentId}/status

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*,application/problem+json"\
"//api/v1/consents/{consentId}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            InitiateConsentResponse result = apiInstance.getStatus(xRequestID, consentId, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
        try {
            InitiateConsentResponse result = apiInstance.getStatus(xRequestID, consentId, pSUIPAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#getStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *consentId = consentId_example; // ID of the corresponding consent object as returned by an account information consent request. 
String *pSUIPAddress = pSUIPAddress_example; // The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Get consent request
[apiInstance getStatusWith:xRequestID
    consentId:consentId
    pSUIPAddress:pSUIPAddress
              completionHandler: ^(InitiateConsentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var consentId = consentId_example; // {{String}} ID of the corresponding consent object as returned by an account information consent request. 
var opts = { 
  'pSUIPAddress': pSUIPAddress_example // {{String}} The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStatus(xRequestID, consentId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStatusExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var consentId = consentId_example;  // String | ID of the corresponding consent object as returned by an account information consent request. 
            var pSUIPAddress = pSUIPAddress_example;  // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional) 

            try
            {
                // Get consent request
                InitiateConsentResponse result = apiInstance.getStatus(xRequestID, consentId, pSUIPAddress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.getStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
$pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 

try {
    $result = $api_instance->getStatus($xRequestID, $consentId, $pSUIPAddress);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->getStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $consentId = consentId_example; # String | ID of the corresponding consent object as returned by an account information consent request. 
my $pSUIPAddress = pSUIPAddress_example; # String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 

eval { 
    my $result = $api_instance->getStatus(xRequestID => $xRequestID, consentId => $consentId, pSUIPAddress => $pSUIPAddress);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->getStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
consentId = consentId_example # String | ID of the corresponding consent object as returned by an account information consent request. 
pSUIPAddress = pSUIPAddress_example # String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional)

try: 
    # Get consent request
    api_response = api_instance.get_status(xRequestID, consentId, pSUIPAddress=pSUIPAddress)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->getStatus: %s\n" % e)

Parameters

Path parameters
Name Description
consentId*
String
ID of the corresponding consent object as returned by an account information consent request.
Required
Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required
PSU-IP-Address
String
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


initiate

Create consent

This method create a consent resource, defining access rights to dedicated accounts of a given PSU-ID. These accounts are addressed explicitly in the method as parameters as a core function. **Side Effects** When this consent request is a request where the "recurringIndicator" equals "true", and if it exists already a former consent for recurring access on account information for the addressed PSU, then the former consent automatically expires as soon as the new consent request is authorised by the PSU. Optional Extension: As an option, an ASPSP might optionally accept a specific access right on the access on all PSD2 related services for all available accounts. As another option an ASPSP might optionally also accept a command, where only access rights are inserted without mentioning the addressed account. The relation to accounts is then handled afterwards between PSU and ASPSP. This option is not supported for the Embedded SCA Approach. As a last option, an ASPSP might in addition accept a command with access rights * to see the list of available payment accounts or * to see the list of available payment accounts with balances.


/api/v1/consents

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*,application/problem+json"\
-H "Content-Type: application/json"\
"//api/v1/consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        InitiateConsentRequest body = ; // InitiateConsentRequest | 
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
        String tPPRedirectURI = tPPRedirectURI_example; // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification. 
        String tPPNokRedirectURI = tPPNokRedirectURI_example; // String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. 
        Boolean tPPRedirectPreferred = true; // Boolean | If it equals "true", the TPP prefers a decoupled SCA approach.  If it equals "false", the TPP prefers not to use the decoupled approach for SCA. The ASPSP will then choose between the embedded or the redirect SCA approach, depending on the choice of the SCA procedure by the TPP/PSU.  If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the parameter TPP-Redirect-Preferred and the SCA method chosen by the TPP/PSU.  The parameter might be ignored by the ASPSP. If both parameters TPP-Redirect-Preferred and TPP-Decoupled-Preferred are present and true, the request is still not rejected, but it is up to the ASPSP, which approach will actually be used.  **Remark for Future:**  TPP-Redirect-Preferred and TPP-Decoupled-Preferred will be revised in future versions, maybe merged. Currently kept separate for downward compatibility. 
        try {
            InitiateConsentResponse result = apiInstance.initiate(body, xRequestID, pSUIPAddress, tPPRedirectURI, tPPNokRedirectURI, tPPRedirectPreferred);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#initiate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        InitiateConsentRequest body = ; // InitiateConsentRequest | 
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
        String tPPRedirectURI = tPPRedirectURI_example; // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification. 
        String tPPNokRedirectURI = tPPNokRedirectURI_example; // String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. 
        Boolean tPPRedirectPreferred = true; // Boolean | If it equals "true", the TPP prefers a decoupled SCA approach.  If it equals "false", the TPP prefers not to use the decoupled approach for SCA. The ASPSP will then choose between the embedded or the redirect SCA approach, depending on the choice of the SCA procedure by the TPP/PSU.  If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the parameter TPP-Redirect-Preferred and the SCA method chosen by the TPP/PSU.  The parameter might be ignored by the ASPSP. If both parameters TPP-Redirect-Preferred and TPP-Decoupled-Preferred are present and true, the request is still not rejected, but it is up to the ASPSP, which approach will actually be used.  **Remark for Future:**  TPP-Redirect-Preferred and TPP-Decoupled-Preferred will be revised in future versions, maybe merged. Currently kept separate for downward compatibility. 
        try {
            InitiateConsentResponse result = apiInstance.initiate(body, xRequestID, pSUIPAddress, tPPRedirectURI, tPPNokRedirectURI, tPPRedirectPreferred);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#initiate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
InitiateConsentRequest *body = ; // 
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *pSUIPAddress = pSUIPAddress_example; // The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional)
String *tPPRedirectURI = tPPRedirectURI_example; // URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification.  (optional)
String *tPPNokRedirectURI = tPPNokRedirectURI_example; // If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.  (optional)
Boolean *tPPRedirectPreferred = true; // If it equals "true", the TPP prefers a decoupled SCA approach.  If it equals "false", the TPP prefers not to use the decoupled approach for SCA. The ASPSP will then choose between the embedded or the redirect SCA approach, depending on the choice of the SCA procedure by the TPP/PSU.  If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the parameter TPP-Redirect-Preferred and the SCA method chosen by the TPP/PSU.  The parameter might be ignored by the ASPSP. If both parameters TPP-Redirect-Preferred and TPP-Decoupled-Preferred are present and true, the request is still not rejected, but it is up to the ASPSP, which approach will actually be used.  **Remark for Future:**  TPP-Redirect-Preferred and TPP-Decoupled-Preferred will be revised in future versions, maybe merged. Currently kept separate for downward compatibility.  (optional)

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Create consent
[apiInstance initiateWith:body
    xRequestID:xRequestID
    pSUIPAddress:pSUIPAddress
    tPPRedirectURI:tPPRedirectURI
    tPPNokRedirectURI:tPPNokRedirectURI
    tPPRedirectPreferred:tPPRedirectPreferred
              completionHandler: ^(InitiateConsentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var body = ; // {{InitiateConsentRequest}} 
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var opts = { 
  'pSUIPAddress': pSUIPAddress_example // {{String}} The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
  'tPPRedirectURI': tPPRedirectURI_example // {{String}} URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification. 
  'tPPNokRedirectURI': tPPNokRedirectURI_example // {{String}} If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. 
  'tPPRedirectPreferred': true // {{Boolean}} If it equals "true", the TPP prefers a decoupled SCA approach.  If it equals "false", the TPP prefers not to use the decoupled approach for SCA. The ASPSP will then choose between the embedded or the redirect SCA approach, depending on the choice of the SCA procedure by the TPP/PSU.  If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the parameter TPP-Redirect-Preferred and the SCA method chosen by the TPP/PSU.  The parameter might be ignored by the ASPSP. If both parameters TPP-Redirect-Preferred and TPP-Decoupled-Preferred are present and true, the request is still not rejected, but it is up to the ASPSP, which approach will actually be used.  **Remark for Future:**  TPP-Redirect-Preferred and TPP-Decoupled-Preferred will be revised in future versions, maybe merged. Currently kept separate for downward compatibility. 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.initiate(bodyxRequestID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class initiateExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var body = new InitiateConsentRequest(); // InitiateConsentRequest | 
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var pSUIPAddress = pSUIPAddress_example;  // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional) 
            var tPPRedirectURI = tPPRedirectURI_example;  // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification.  (optional) 
            var tPPNokRedirectURI = tPPNokRedirectURI_example;  // String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.  (optional) 
            var tPPRedirectPreferred = true;  // Boolean | If it equals "true", the TPP prefers a decoupled SCA approach.  If it equals "false", the TPP prefers not to use the decoupled approach for SCA. The ASPSP will then choose between the embedded or the redirect SCA approach, depending on the choice of the SCA procedure by the TPP/PSU.  If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the parameter TPP-Redirect-Preferred and the SCA method chosen by the TPP/PSU.  The parameter might be ignored by the ASPSP. If both parameters TPP-Redirect-Preferred and TPP-Decoupled-Preferred are present and true, the request is still not rejected, but it is up to the ASPSP, which approach will actually be used.  **Remark for Future:**  TPP-Redirect-Preferred and TPP-Decoupled-Preferred will be revised in future versions, maybe merged. Currently kept separate for downward compatibility.  (optional) 

            try
            {
                // Create consent
                InitiateConsentResponse result = apiInstance.initiate(body, xRequestID, pSUIPAddress, tPPRedirectURI, tPPNokRedirectURI, tPPRedirectPreferred);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.initiate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$body = ; // InitiateConsentRequest | 
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$pSUIPAddress = pSUIPAddress_example; // String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
$tPPRedirectURI = tPPRedirectURI_example; // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification. 
$tPPNokRedirectURI = tPPNokRedirectURI_example; // String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. 
$tPPRedirectPreferred = true; // Boolean | If it equals "true", the TPP prefers a decoupled SCA approach.  If it equals "false", the TPP prefers not to use the decoupled approach for SCA. The ASPSP will then choose between the embedded or the redirect SCA approach, depending on the choice of the SCA procedure by the TPP/PSU.  If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the parameter TPP-Redirect-Preferred and the SCA method chosen by the TPP/PSU.  The parameter might be ignored by the ASPSP. If both parameters TPP-Redirect-Preferred and TPP-Decoupled-Preferred are present and true, the request is still not rejected, but it is up to the ASPSP, which approach will actually be used.  **Remark for Future:**  TPP-Redirect-Preferred and TPP-Decoupled-Preferred will be revised in future versions, maybe merged. Currently kept separate for downward compatibility. 

try {
    $result = $api_instance->initiate($body, $xRequestID, $pSUIPAddress, $tPPRedirectURI, $tPPNokRedirectURI, $tPPRedirectPreferred);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->initiate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $body = WWW::SwaggerClient::Object::InitiateConsentRequest->new(); # InitiateConsentRequest | 
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $pSUIPAddress = pSUIPAddress_example; # String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. 
my $tPPRedirectURI = tPPRedirectURI_example; # String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification. 
my $tPPNokRedirectURI = tPPNokRedirectURI_example; # String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. 
my $tPPRedirectPreferred = true; # Boolean | If it equals "true", the TPP prefers a decoupled SCA approach.  If it equals "false", the TPP prefers not to use the decoupled approach for SCA. The ASPSP will then choose between the embedded or the redirect SCA approach, depending on the choice of the SCA procedure by the TPP/PSU.  If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the parameter TPP-Redirect-Preferred and the SCA method chosen by the TPP/PSU.  The parameter might be ignored by the ASPSP. If both parameters TPP-Redirect-Preferred and TPP-Decoupled-Preferred are present and true, the request is still not rejected, but it is up to the ASPSP, which approach will actually be used.  **Remark for Future:**  TPP-Redirect-Preferred and TPP-Decoupled-Preferred will be revised in future versions, maybe merged. Currently kept separate for downward compatibility. 

eval { 
    my $result = $api_instance->initiate(body => $body, xRequestID => $xRequestID, pSUIPAddress => $pSUIPAddress, tPPRedirectURI => $tPPRedirectURI, tPPNokRedirectURI => $tPPNokRedirectURI, tPPRedirectPreferred => $tPPRedirectPreferred);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->initiate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
body =  # InitiateConsentRequest | 
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
pSUIPAddress = pSUIPAddress_example # String | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.  (optional)
tPPRedirectURI = tPPRedirectURI_example # String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach, specifically  when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification.  (optional)
tPPNokRedirectURI = tPPNokRedirectURI_example # String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.  (optional)
tPPRedirectPreferred = true # Boolean | If it equals "true", the TPP prefers a decoupled SCA approach.  If it equals "false", the TPP prefers not to use the decoupled approach for SCA. The ASPSP will then choose between the embedded or the redirect SCA approach, depending on the choice of the SCA procedure by the TPP/PSU.  If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the parameter TPP-Redirect-Preferred and the SCA method chosen by the TPP/PSU.  The parameter might be ignored by the ASPSP. If both parameters TPP-Redirect-Preferred and TPP-Decoupled-Preferred are present and true, the request is still not rejected, but it is up to the ASPSP, which approach will actually be used.  **Remark for Future:**  TPP-Redirect-Preferred and TPP-Decoupled-Preferred will be revised in future versions, maybe merged. Currently kept separate for downward compatibility.  (optional)

try: 
    # Create consent
    api_response = api_instance.initiate(body, xRequestID, pSUIPAddress=pSUIPAddress, tPPRedirectURI=tPPRedirectURI, tPPNokRedirectURI=tPPNokRedirectURI, tPPRedirectPreferred=tPPRedirectPreferred)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->initiate: %s\n" % e)

Parameters

Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required
PSU-IP-Address
String
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
TPP-Redirect-URI
String
URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. **Remark for Future:** This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI
String
If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
TPP-Redirect-Preferred
Boolean
If it equals "true", the TPP prefers a decoupled SCA approach. If it equals "false", the TPP prefers not to use the decoupled approach for SCA. The ASPSP will then choose between the embedded or the redirect SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the parameter TPP-Redirect-Preferred and the SCA method chosen by the TPP/PSU. The parameter might be ignored by the ASPSP. If both parameters TPP-Redirect-Preferred and TPP-Decoupled-Preferred are present and true, the request is still not rejected, but it is up to the ASPSP, which approach will actually be used. **Remark for Future:** TPP-Redirect-Preferred and TPP-Decoupled-Preferred will be revised in future versions, maybe merged. Currently kept separate for downward compatibility.
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


selectAuthorisationMethod

Update PSU Data for consents

This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded SCA Approach where needed. Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication. This methods updates PSU data on the cancellation authorisation resource if needed. There are several possible update PSU data requests in the context of a consent request if needed, which depends on the SCA approach: * Redirect SCA Approach: A specific Update PSU data request is applicable for * the selection of authentication methods, before choosing the actual SCA approach. * Decoupled SCA Approach: A specific update PSU data request is only applicable for * adding the PSU Identification, if not provided yet in the payment initiation request or the Account Information Consent Request, or if no OAuth2 access token is used, or * the selection of authentication methods. * Embedded SCA Approach: The Update PSU data request might be used * to add credentials as a first factor authentication data of the PSU and * to select the authentication method and * transaction authorisation. The SCA Approach might depend on the chosen SCA method. For that reason, the following possible update PSU data request can apply to all SCA approaches: * Select an SCA method in case of several SCA methods are available for the customer. There are the following request types on this access path: * Update PSU identification * Update PSU authentication * Select PSU autorization method WARNING: This method needs a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change. * Transaction Authorisation WARNING: This method needs a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.


/api/v1/consents/{consentId}/authorisations/{authorisationId}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*,application/problem+json"\
-H "Content-Type: application/json"\
"//api/v1/consents/{consentId}/authorisations/{authorisationId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        SelectScaMethodRequest body = ; // SelectScaMethodRequest | 
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        String authorisationId = authorisationId_example; // String | Resource identification of the related SCA.
        try {
            SelectScaMethodResponse result = apiInstance.selectAuthorisationMethod(body, xRequestID, consentId, authorisationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#selectAuthorisationMethod");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        SelectScaMethodRequest body = ; // SelectScaMethodRequest | 
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        String authorisationId = authorisationId_example; // String | Resource identification of the related SCA.
        try {
            SelectScaMethodResponse result = apiInstance.selectAuthorisationMethod(body, xRequestID, consentId, authorisationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#selectAuthorisationMethod");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
SelectScaMethodRequest *body = ; // 
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *consentId = consentId_example; // ID of the corresponding consent object as returned by an account information consent request. 
String *authorisationId = authorisationId_example; // Resource identification of the related SCA.

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Update PSU Data for consents
[apiInstance selectAuthorisationMethodWith:body
    xRequestID:xRequestID
    consentId:consentId
    authorisationId:authorisationId
              completionHandler: ^(SelectScaMethodResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var body = ; // {{SelectScaMethodRequest}} 
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var consentId = consentId_example; // {{String}} ID of the corresponding consent object as returned by an account information consent request. 
var authorisationId = authorisationId_example; // {{String}} Resource identification of the related SCA.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.selectAuthorisationMethod(bodyxRequestIDconsentIdauthorisationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class selectAuthorisationMethodExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var body = new SelectScaMethodRequest(); // SelectScaMethodRequest | 
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var consentId = consentId_example;  // String | ID of the corresponding consent object as returned by an account information consent request. 
            var authorisationId = authorisationId_example;  // String | Resource identification of the related SCA.

            try
            {
                // Update PSU Data for consents
                SelectScaMethodResponse result = apiInstance.selectAuthorisationMethod(body, xRequestID, consentId, authorisationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.selectAuthorisationMethod: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$body = ; // SelectScaMethodRequest | 
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
$authorisationId = authorisationId_example; // String | Resource identification of the related SCA.

try {
    $result = $api_instance->selectAuthorisationMethod($body, $xRequestID, $consentId, $authorisationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->selectAuthorisationMethod: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $body = WWW::SwaggerClient::Object::SelectScaMethodRequest->new(); # SelectScaMethodRequest | 
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $consentId = consentId_example; # String | ID of the corresponding consent object as returned by an account information consent request. 
my $authorisationId = authorisationId_example; # String | Resource identification of the related SCA.

eval { 
    my $result = $api_instance->selectAuthorisationMethod(body => $body, xRequestID => $xRequestID, consentId => $consentId, authorisationId => $authorisationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->selectAuthorisationMethod: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
body =  # SelectScaMethodRequest | 
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
consentId = consentId_example # String | ID of the corresponding consent object as returned by an account information consent request. 
authorisationId = authorisationId_example # String | Resource identification of the related SCA.

try: 
    # Update PSU Data for consents
    api_response = api_instance.select_authorisation_method(body, xRequestID, consentId, authorisationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->selectAuthorisationMethod: %s\n" % e)

Parameters

Path parameters
Name Description
consentId*
String
ID of the corresponding consent object as returned by an account information consent request.
Required
authorisationId*
String
Resource identification of the related SCA.
Required
Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


terminate

Delete consent

The TPP can delete an account information consent object if needed.


/api/v1/consents/{consentId}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json,*/*"\
"//api/v1/consents/{consentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAISApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        try {
            apiInstance.terminate(xRequestID, consentId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#terminate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationServiceAISApi;

public class AccountInformationServiceAISApiExample {

    public static void main(String[] args) {
        AccountInformationServiceAISApi apiInstance = new AccountInformationServiceAISApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 
        try {
            apiInstance.terminate(xRequestID, consentId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAISApi#terminate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
String *consentId = consentId_example; // ID of the corresponding consent object as returned by an account information consent request. 

AccountInformationServiceAISApi *apiInstance = [[AccountInformationServiceAISApi alloc] init];

// Delete consent
[apiInstance terminateWith:xRequestID
    consentId:consentId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountInformationApiAis = require('account_information_api__ais');
var defaultClient = AccountInformationApiAis.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AccountInformationApiAis.AccountInformationServiceAISApi()
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var consentId = consentId_example; // {{String}} ID of the corresponding consent object as returned by an account information consent request. 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.terminate(xRequestID, consentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class terminateExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountInformationServiceAISApi();
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var consentId = consentId_example;  // String | ID of the corresponding consent object as returned by an account information consent request. 

            try
            {
                // Delete consent
                apiInstance.terminate(xRequestID, consentId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationServiceAISApi.terminate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccountInformationServiceAISApi();
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$consentId = consentId_example; // String | ID of the corresponding consent object as returned by an account information consent request. 

try {
    $api_instance->terminate($xRequestID, $consentId);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServiceAISApi->terminate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationServiceAISApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountInformationServiceAISApi->new();
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $consentId = consentId_example; # String | ID of the corresponding consent object as returned by an account information consent request. 

eval { 
    $api_instance->terminate(xRequestID => $xRequestID, consentId => $consentId);
};
if ($@) {
    warn "Exception when calling AccountInformationServiceAISApi->terminate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountInformationServiceAISApi()
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
consentId = consentId_example # String | ID of the corresponding consent object as returned by an account information consent request. 

try: 
    # Delete consent
    api_instance.terminate(xRequestID, consentId)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->terminate: %s\n" % e)

Parameters

Path parameters
Name Description
consentId*
String
ID of the corresponding consent object as returned by an account information consent request.
Required
Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable