CCBank PSD2

Accounts

getAccountbyId

account details

Reads a list of bank accounts, 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 list of accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the OAuth2 access token.


/accounts/{account-id}

Usage and SDK Samples

curl -X GET -H "x-openpsd-key: [[apiKey]]" "{protocol}://psd2.ccbank.bg/psd2/v1/accounts/{account-id}?withBalance="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

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

public class AccountsApiExample {

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

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

        AccountsApi apiInstance = new AccountsApi();
        String accountId = accountId_example; // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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.
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
        Boolean withBalance = true; // Boolean | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200_1 result = apiInstance.getAccountbyId(accountId, xRequestID, consentID, withBalance, authorization, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccountbyId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        String accountId = accountId_example; // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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.
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
        Boolean withBalance = true; // Boolean | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200_1 result = apiInstance.getAccountbyId(accountId, xRequestID, consentID, withBalance, authorization, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccountbyId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-openpsd-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-openpsd-key"];
String *accountId = accountId_example; // This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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.
UUID *xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // ID of the request, unique to the call, as determined by the initiating party.
String *consentID = consentID_example; // Shall be contained since "Establish Consent Transaction" was performed via this API before.
Boolean *withBalance = true; // If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP. (optional)
String *authorization = authorization_example; // Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
String *digest = digest_example; // Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
String *signature = signature_example; // A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
String *tPPSignatureCertificate = tPPSignatureCertificate_example; // The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

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

// account details
[apiInstance getAccountbyIdWith:accountId
    xRequestID:xRequestID
    consentID:consentID
    withBalance:withBalance
    authorization:authorization
    digest:digest
    signature:signature
    tPPSignatureCertificate:tPPSignatureCertificate
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenPsdNextGenPsd2 = require('open_psd_next_gen_psd2');
var defaultClient = OpenPsdNextGenPsd2.ApiClient.instance;

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

var api = new OpenPsdNextGenPsd2.AccountsApi()
var accountId = accountId_example; // {{String}} This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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 xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} ID of the request, unique to the call, as determined by the initiating party.
var consentID = consentID_example; // {{String}} Shall be contained since "Establish Consent Transaction" was performed via this API before.
var opts = { 
  'withBalance': true, // {{Boolean}} If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
  'authorization': authorization_example, // {{String}} Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
  'digest': digest_example, // {{String}} Is contained if and only if the "Signature" element is contained in the header of the request.
  'signature': signature_example, // {{String}} A signature of the request by the TPP on application level. This might be mandated by ASPSP.
  'tPPSignatureCertificate': tPPSignatureCertificate_example // {{String}} The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountbyId(accountId, 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 getAccountbyIdExample
    {
        public void main()
        {

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

            var apiInstance = new AccountsApi();
            var accountId = accountId_example;  // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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 xRequestID = new UUID(); // UUID | ID of the request, unique to the call, as determined by the initiating party.
            var consentID = consentID_example;  // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
            var withBalance = true;  // Boolean | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP. (optional) 
            var authorization = authorization_example;  // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional) 
            var digest = digest_example;  // String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional) 
            var signature = signature_example;  // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional) 
            var tPPSignatureCertificate = tPPSignatureCertificate_example;  // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional) 

            try
            {
                // account details
                inline_response_200_1 result = apiInstance.getAccountbyId(accountId, xRequestID, consentID, withBalance, authorization, digest, signature, tPPSignatureCertificate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.getAccountbyId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccountsApi();
$accountId = accountId_example; // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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.
$xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
$consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
$withBalance = true; // Boolean | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
$authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
$digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
$signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
$tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

try {
    $result = $api_instance->getAccountbyId($accountId, $xRequestID, $consentID, $withBalance, $authorization, $digest, $signature, $tPPSignatureCertificate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getAccountbyId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;

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

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $accountId = accountId_example; # String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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 $xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | ID of the request, unique to the call, as determined by the initiating party.
my $consentID = consentID_example; # String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
my $withBalance = true; # Boolean | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
my $authorization = authorization_example; # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
my $digest = digest_example; # String | Is contained if and only if the "Signature" element is contained in the header of the request.
my $signature = signature_example; # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
my $tPPSignatureCertificate = tPPSignatureCertificate_example; # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

eval { 
    my $result = $api_instance->getAccountbyId(accountId => $accountId, xRequestID => $xRequestID, consentID => $consentID, withBalance => $withBalance, authorization => $authorization, digest => $digest, signature => $signature, tPPSignatureCertificate => $tPPSignatureCertificate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->getAccountbyId: $@\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: ApiKeyAuth
swagger_client.configuration.api_key['x-openpsd-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-openpsd-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
accountId = accountId_example # String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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.
xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | ID of the request, unique to the call, as determined by the initiating party.
consentID = consentID_example # String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
withBalance = true # Boolean | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP. (optional)
authorization = authorization_example # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
digest = digest_example # String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
signature = signature_example # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
tPPSignatureCertificate = tPPSignatureCertificate_example # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

try: 
    # account details
    api_response = api_instance.get_accountby_id(accountId, xRequestID, consentID, withBalance=withBalance, authorization=authorization, digest=digest, signature=signature, tPPSignatureCertificate=tPPSignatureCertificate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->getAccountbyId: %s\n" % e)

Parameters

Path parameters
Name Description
account-id*
String
This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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*
UUID (uuid)
ID of the request, unique to the call, as determined by the initiating party.
Required
Consent-ID*
String
Shall be contained since "Establish Consent Transaction" was performed via this API before.
Required
Authorization
String
Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
Digest
String
Is contained if and only if the "Signature" element is contained in the header of the request.
Signature
String
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate
String
The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
Query parameters
Name Description
withBalance
Boolean
If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

Responses

Status: 200 - OK

Name Type Format Description

Status: 400 - Validation error occurred. This code will cover malformed syntax in request or incorrect data in payload.

Status: 401 - The TPP or the PSU is not correctly authorized to perform the request. Retry the request with correct authentication information.

Status: 403 - Returned if the resource that was referenced in the path exists but cannot be accessed by the TPP or the PSU. This code should only be used for non-sensitive id references as it will reveal that the resource exists even though it cannot be accessed.

Status: 404 - Returned if the resource that was referenced in the path does not exist or cannot be referenced by the TPP or the PSU. When in doubt if a specific id in the path is sensitive or not, use the HTTP response code 404 instead of the HTTP response code 403.

Status: 405 - This code is only sent when the HTTP method (PUT, POST, DELETE, GET etc.) is not supported on a specific endpoint. It has nothing to do with the consent, payment or account information data model.

Status: 406 - The ASPSP cannot generate the content that the TPP specified in the Accept header.

Status: 429 - The TPP has exceeded the number of requests allowed by the consent or by the RTS.

Status: 500 - Internal server error occurred.


getAccounts

list of accounts

Reads a list of bank accounts, 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 list of accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the OAuth2 access token.


/accounts

Usage and SDK Samples

curl -X GET -H "x-openpsd-key: [[apiKey]]" "{protocol}://psd2.ccbank.bg/psd2/v1/accounts?withBalance="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

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

public class AccountsApiExample {

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

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

        AccountsApi apiInstance = new AccountsApi();
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
        Boolean withBalance = true; // Boolean | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200 result = apiInstance.getAccounts(xRequestID, consentID, withBalance, authorization, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
        Boolean withBalance = true; // Boolean | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200 result = apiInstance.getAccounts(xRequestID, consentID, withBalance, authorization, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccounts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-openpsd-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-openpsd-key"];
UUID *xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // ID of the request, unique to the call, as determined by the initiating party.
String *consentID = consentID_example; // Shall be contained since "Establish Consent Transaction" was performed via this API before.
Boolean *withBalance = true; // If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP. (optional)
String *authorization = authorization_example; // Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
String *digest = digest_example; // Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
String *signature = signature_example; // A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
String *tPPSignatureCertificate = tPPSignatureCertificate_example; // The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

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

// list of accounts
[apiInstance getAccountsWith:xRequestID
    consentID:consentID
    withBalance:withBalance
    authorization:authorization
    digest:digest
    signature:signature
    tPPSignatureCertificate:tPPSignatureCertificate
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenPsdNextGenPsd2 = require('open_psd_next_gen_psd2');
var defaultClient = OpenPsdNextGenPsd2.ApiClient.instance;

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

var api = new OpenPsdNextGenPsd2.AccountsApi()
var xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} ID of the request, unique to the call, as determined by the initiating party.
var consentID = consentID_example; // {{String}} Shall be contained since "Establish Consent Transaction" was performed via this API before.
var opts = { 
  'withBalance': true, // {{Boolean}} If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
  'authorization': authorization_example, // {{String}} Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
  'digest': digest_example, // {{String}} Is contained if and only if the "Signature" element is contained in the header of the request.
  'signature': signature_example, // {{String}} A signature of the request by the TPP on application level. This might be mandated by ASPSP.
  'tPPSignatureCertificate': tPPSignatureCertificate_example // {{String}} The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
};
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: ApiKeyAuth
            Configuration.Default.ApiKey.Add("x-openpsd-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-openpsd-key", "Bearer");

            var apiInstance = new AccountsApi();
            var xRequestID = new UUID(); // UUID | ID of the request, unique to the call, as determined by the initiating party.
            var consentID = consentID_example;  // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
            var withBalance = true;  // Boolean | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP. (optional) 
            var authorization = authorization_example;  // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional) 
            var digest = digest_example;  // String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional) 
            var signature = signature_example;  // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional) 
            var tPPSignatureCertificate = tPPSignatureCertificate_example;  // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional) 

            try
            {
                // list of accounts
                inline_response_200 result = apiInstance.getAccounts(xRequestID, consentID, withBalance, authorization, digest, signature, tPPSignatureCertificate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.getAccounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccountsApi();
$xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
$consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
$withBalance = true; // Boolean | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
$authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
$digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
$signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
$tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

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

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

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | ID of the request, unique to the call, as determined by the initiating party.
my $consentID = consentID_example; # String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
my $withBalance = true; # Boolean | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
my $authorization = authorization_example; # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
my $digest = digest_example; # String | Is contained if and only if the "Signature" element is contained in the header of the request.
my $signature = signature_example; # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
my $tPPSignatureCertificate = tPPSignatureCertificate_example; # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

eval { 
    my $result = $api_instance->getAccounts(xRequestID => $xRequestID, consentID => $consentID, withBalance => $withBalance, authorization => $authorization, digest => $digest, signature => $signature, tPPSignatureCertificate => $tPPSignatureCertificate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->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: ApiKeyAuth
swagger_client.configuration.api_key['x-openpsd-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-openpsd-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | ID of the request, unique to the call, as determined by the initiating party.
consentID = consentID_example # String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
withBalance = true # Boolean | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP. (optional)
authorization = authorization_example # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
digest = digest_example # String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
signature = signature_example # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
tPPSignatureCertificate = tPPSignatureCertificate_example # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

try: 
    # list of accounts
    api_response = api_instance.get_accounts(xRequestID, consentID, withBalance=withBalance, authorization=authorization, digest=digest, signature=signature, tPPSignatureCertificate=tPPSignatureCertificate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->getAccounts: %s\n" % e)

Parameters

Header parameters
Name Description
X-Request-ID*
UUID (uuid)
ID of the request, unique to the call, as determined by the initiating party.
Required
Consent-ID*
String
Shall be contained since "Establish Consent Transaction" was performed via this API before.
Required
Authorization
String
Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
Digest
String
Is contained if and only if the "Signature" element is contained in the header of the request.
Signature
String
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate
String
The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
Query parameters
Name Description
withBalance
Boolean
If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

Responses

Status: 200 - OK

Name Type Format Description

Status: 400 - Validation error occurred. This code will cover malformed syntax in request or incorrect data in payload.

Status: 401 - The TPP or the PSU is not correctly authorized to perform the request. Retry the request with correct authentication information.

Status: 403 - Returned if the resource that was referenced in the path exists but cannot be accessed by the TPP or the PSU. This code should only be used for non-sensitive id references as it will reveal that the resource exists even though it cannot be accessed.

Status: 404 - Returned if the resource that was referenced in the path does not exist or cannot be referenced by the TPP or the PSU. When in doubt if a specific id in the path is sensitive or not, use the HTTP response code 404 instead of the HTTP response code 403.

Status: 405 - This code is only sent when the HTTP method (PUT, POST, DELETE, GET etc.) is not supported on a specific endpoint. It has nothing to do with the consent, payment or account information data model.

Status: 406 - The ASPSP cannot generate the content that the TPP specified in the Accept header.

Status: 429 - The TPP has exceeded the number of requests allowed by the consent or by the RTS.

Status: 500 - Internal server error occurred.


getBalanceForAccountByAccountId

balances for account

Reads the balance list for a given account.


/accounts/{account-id}/balances

Usage and SDK Samples

curl -X GET -H "x-openpsd-key: [[apiKey]]" "{protocol}://psd2.ccbank.bg/psd2/v1/accounts/{account-id}/balances"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

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

public class AccountsApiExample {

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

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

        AccountsApi apiInstance = new AccountsApi();
        String accountId = accountId_example; // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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.
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200_2 result = apiInstance.getBalanceForAccountByAccountId(accountId, xRequestID, consentID, authorization, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getBalanceForAccountByAccountId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        String accountId = accountId_example; // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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.
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200_2 result = apiInstance.getBalanceForAccountByAccountId(accountId, xRequestID, consentID, authorization, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getBalanceForAccountByAccountId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-openpsd-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-openpsd-key"];
String *accountId = accountId_example; // This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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.
UUID *xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // ID of the request, unique to the call, as determined by the initiating party.
String *consentID = consentID_example; // Shall be contained since "Establish Consent Transaction" was performed via this API before.
String *authorization = authorization_example; // Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
String *digest = digest_example; // Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
String *signature = signature_example; // A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
String *tPPSignatureCertificate = tPPSignatureCertificate_example; // The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

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

// balances for account
[apiInstance getBalanceForAccountByAccountIdWith:accountId
    xRequestID:xRequestID
    consentID:consentID
    authorization:authorization
    digest:digest
    signature:signature
    tPPSignatureCertificate:tPPSignatureCertificate
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenPsdNextGenPsd2 = require('open_psd_next_gen_psd2');
var defaultClient = OpenPsdNextGenPsd2.ApiClient.instance;

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

var api = new OpenPsdNextGenPsd2.AccountsApi()
var accountId = accountId_example; // {{String}} This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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 xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} ID of the request, unique to the call, as determined by the initiating party.
var consentID = consentID_example; // {{String}} Shall be contained since "Establish Consent Transaction" was performed via this API before.
var opts = { 
  'authorization': authorization_example, // {{String}} Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
  'digest': digest_example, // {{String}} Is contained if and only if the "Signature" element is contained in the header of the request.
  'signature': signature_example, // {{String}} A signature of the request by the TPP on application level. This might be mandated by ASPSP.
  'tPPSignatureCertificate': tPPSignatureCertificate_example // {{String}} The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBalanceForAccountByAccountId(accountId, 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 getBalanceForAccountByAccountIdExample
    {
        public void main()
        {

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

            var apiInstance = new AccountsApi();
            var accountId = accountId_example;  // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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 xRequestID = new UUID(); // UUID | ID of the request, unique to the call, as determined by the initiating party.
            var consentID = consentID_example;  // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
            var authorization = authorization_example;  // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional) 
            var digest = digest_example;  // String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional) 
            var signature = signature_example;  // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional) 
            var tPPSignatureCertificate = tPPSignatureCertificate_example;  // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional) 

            try
            {
                // balances for account
                inline_response_200_2 result = apiInstance.getBalanceForAccountByAccountId(accountId, xRequestID, consentID, authorization, digest, signature, tPPSignatureCertificate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.getBalanceForAccountByAccountId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccountsApi();
$accountId = accountId_example; // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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.
$xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
$consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
$authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
$digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
$signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
$tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

try {
    $result = $api_instance->getBalanceForAccountByAccountId($accountId, $xRequestID, $consentID, $authorization, $digest, $signature, $tPPSignatureCertificate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getBalanceForAccountByAccountId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;

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

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $accountId = accountId_example; # String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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 $xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | ID of the request, unique to the call, as determined by the initiating party.
my $consentID = consentID_example; # String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
my $authorization = authorization_example; # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
my $digest = digest_example; # String | Is contained if and only if the "Signature" element is contained in the header of the request.
my $signature = signature_example; # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
my $tPPSignatureCertificate = tPPSignatureCertificate_example; # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

eval { 
    my $result = $api_instance->getBalanceForAccountByAccountId(accountId => $accountId, xRequestID => $xRequestID, consentID => $consentID, authorization => $authorization, digest => $digest, signature => $signature, tPPSignatureCertificate => $tPPSignatureCertificate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->getBalanceForAccountByAccountId: $@\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: ApiKeyAuth
swagger_client.configuration.api_key['x-openpsd-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-openpsd-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
accountId = accountId_example # String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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.
xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | ID of the request, unique to the call, as determined by the initiating party.
consentID = consentID_example # String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
authorization = authorization_example # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
digest = digest_example # String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
signature = signature_example # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
tPPSignatureCertificate = tPPSignatureCertificate_example # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

try: 
    # balances for account
    api_response = api_instance.get_balance_for_account_by_account_id(accountId, xRequestID, consentID, authorization=authorization, digest=digest, signature=signature, tPPSignatureCertificate=tPPSignatureCertificate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->getBalanceForAccountByAccountId: %s\n" % e)

Parameters

Path parameters
Name Description
account-id*
String
This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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*
UUID (uuid)
ID of the request, unique to the call, as determined by the initiating party.
Required
Consent-ID*
String
Shall be contained since "Establish Consent Transaction" was performed via this API before.
Required
Authorization
String
Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
Digest
String
Is contained if and only if the "Signature" element is contained in the header of the request.
Signature
String
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate
String
The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

Responses

Status: 200 - OK

Name Type Format Description

Status: 400 - Validation error occurred. This code will cover malformed syntax in request or incorrect data in payload.

Status: 401 - The TPP or the PSU is not correctly authorized to perform the request. Retry the request with correct authentication information.

Status: 403 - Returned if the resource that was referenced in the path exists but cannot be accessed by the TPP or the PSU. This code should only be used for non-sensitive id references as it will reveal that the resource exists even though it cannot be accessed.

Status: 404 - Returned if the resource that was referenced in the path does not exist or cannot be referenced by the TPP or the PSU. When in doubt if a specific id in the path is sensitive or not, use the HTTP response code 404 instead of the HTTP response code 403.

Status: 405 - This code is only sent when the HTTP method (PUT, POST, DELETE, GET etc.) is not supported on a specific endpoint. It has nothing to do with the consent, payment or account information data model.

Status: 406 - The ASPSP cannot generate the content that the TPP specified in the Accept header.

Status: 429 - The TPP has exceeded the number of requests allowed by the consent or by the RTS.

Status: 500 - Internal server error occurred.


getTransactionByTransactionIdForAccountByAccountId

transaction details for transaction of an account

Reads transaction details of an addressed transaction.


/accounts/{account-id}/transactions/{resourceId}

Usage and SDK Samples

curl -X GET "{protocol}://psd2.ccbank.bg/psd2/v1/accounts/{account-id}/transactions/{resourceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

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

public class AccountsApiExample {

    public static void main(String[] args) {
        
        AccountsApi apiInstance = new AccountsApi();
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
        String resourceId = resourceId_example; // String | This identification is given by the attribute resourceId of the corresponding entry of a transaction list.
        String accountId = accountId_example; // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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 authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200_4 result = apiInstance.getTransactionByTransactionIdForAccountByAccountId(xRequestID, consentID, resourceId, accountId, authorization, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getTransactionByTransactionIdForAccountByAccountId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
        String resourceId = resourceId_example; // String | This identification is given by the attribute resourceId of the corresponding entry of a transaction list.
        String accountId = accountId_example; // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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 authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200_4 result = apiInstance.getTransactionByTransactionIdForAccountByAccountId(xRequestID, consentID, resourceId, accountId, authorization, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getTransactionByTransactionIdForAccountByAccountId");
            e.printStackTrace();
        }
    }
}
UUID *xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // ID of the request, unique to the call, as determined by the initiating party.
String *consentID = consentID_example; // Shall be contained since "Establish Consent Transaction" was performed via this API before.
String *resourceId = resourceId_example; // This identification is given by the attribute resourceId of the corresponding entry of a transaction list.
String *accountId = accountId_example; // This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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 *authorization = authorization_example; // Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
String *digest = digest_example; // Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
String *signature = signature_example; // A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
String *tPPSignatureCertificate = tPPSignatureCertificate_example; // The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

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

// transaction details for transaction of an account
[apiInstance getTransactionByTransactionIdForAccountByAccountIdWith:xRequestID
    consentID:consentID
    resourceId:resourceId
    accountId:accountId
    authorization:authorization
    digest:digest
    signature:signature
    tPPSignatureCertificate:tPPSignatureCertificate
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenPsdNextGenPsd2 = require('open_psd_next_gen_psd2');

var api = new OpenPsdNextGenPsd2.AccountsApi()
var xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} ID of the request, unique to the call, as determined by the initiating party.
var consentID = consentID_example; // {{String}} Shall be contained since "Establish Consent Transaction" was performed via this API before.
var resourceId = resourceId_example; // {{String}} This identification is given by the attribute resourceId of the corresponding entry of a transaction list.
var accountId = accountId_example; // {{String}} This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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 = { 
  'authorization': authorization_example, // {{String}} Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
  'digest': digest_example, // {{String}} Is contained if and only if the "Signature" element is contained in the header of the request.
  'signature': signature_example, // {{String}} A signature of the request by the TPP on application level. This might be mandated by ASPSP.
  'tPPSignatureCertificate': tPPSignatureCertificate_example // {{String}} The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransactionByTransactionIdForAccountByAccountId(xRequestID, consentID, resourceId, accountId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AccountsApi();
            var xRequestID = new UUID(); // UUID | ID of the request, unique to the call, as determined by the initiating party.
            var consentID = consentID_example;  // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
            var resourceId = resourceId_example;  // String | This identification is given by the attribute resourceId of the corresponding entry of a transaction list.
            var accountId = accountId_example;  // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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 authorization = authorization_example;  // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional) 
            var digest = digest_example;  // String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional) 
            var signature = signature_example;  // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional) 
            var tPPSignatureCertificate = tPPSignatureCertificate_example;  // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional) 

            try
            {
                // transaction details for transaction of an account
                inline_response_200_4 result = apiInstance.getTransactionByTransactionIdForAccountByAccountId(xRequestID, consentID, resourceId, accountId, authorization, digest, signature, tPPSignatureCertificate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.getTransactionByTransactionIdForAccountByAccountId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAccountsApi();
$xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
$consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
$resourceId = resourceId_example; // String | This identification is given by the attribute resourceId of the corresponding entry of a transaction list.
$accountId = accountId_example; // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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.
$authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
$digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
$signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
$tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

try {
    $result = $api_instance->getTransactionByTransactionIdForAccountByAccountId($xRequestID, $consentID, $resourceId, $accountId, $authorization, $digest, $signature, $tPPSignatureCertificate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getTransactionByTransactionIdForAccountByAccountId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | ID of the request, unique to the call, as determined by the initiating party.
my $consentID = consentID_example; # String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
my $resourceId = resourceId_example; # String | This identification is given by the attribute resourceId of the corresponding entry of a transaction list.
my $accountId = accountId_example; # String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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 $authorization = authorization_example; # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
my $digest = digest_example; # String | Is contained if and only if the "Signature" element is contained in the header of the request.
my $signature = signature_example; # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
my $tPPSignatureCertificate = tPPSignatureCertificate_example; # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

eval { 
    my $result = $api_instance->getTransactionByTransactionIdForAccountByAccountId(xRequestID => $xRequestID, consentID => $consentID, resourceId => $resourceId, accountId => $accountId, authorization => $authorization, digest => $digest, signature => $signature, tPPSignatureCertificate => $tPPSignatureCertificate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->getTransactionByTransactionIdForAccountByAccountId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | ID of the request, unique to the call, as determined by the initiating party.
consentID = consentID_example # String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
resourceId = resourceId_example # String | This identification is given by the attribute resourceId of the corresponding entry of a transaction list.
accountId = accountId_example # String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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.
authorization = authorization_example # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
digest = digest_example # String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
signature = signature_example # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
tPPSignatureCertificate = tPPSignatureCertificate_example # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

try: 
    # transaction details for transaction of an account
    api_response = api_instance.get_transaction_by_transaction_id_for_account_by_account_id(xRequestID, consentID, resourceId, accountId, authorization=authorization, digest=digest, signature=signature, tPPSignatureCertificate=tPPSignatureCertificate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->getTransactionByTransactionIdForAccountByAccountId: %s\n" % e)

Parameters

Path parameters
Name Description
resourceId*
String
This identification is given by the attribute resourceId of the corresponding entry of a transaction list.
Required
account-id*
String
This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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*
UUID (uuid)
ID of the request, unique to the call, as determined by the initiating party.
Required
Consent-ID*
String
Shall be contained since "Establish Consent Transaction" was performed via this API before.
Required
Authorization
String
Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
Digest
String
Is contained if and only if the "Signature" element is contained in the header of the request.
Signature
String
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate
String
The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

Responses

Status: 200 - OK

Name Type Format Description

Status: 400 - Validation error occurred. This code will cover malformed syntax in request or incorrect data in payload.

Status: 401 - The TPP or the PSU is not correctly authorized to perform the request. Retry the request with correct authentication information.

Status: 403 - Returned if the resource that was referenced in the path exists but cannot be accessed by the TPP or the PSU. This code should only be used for non-sensitive id references as it will reveal that the resource exists even though it cannot be accessed.

Status: 404 - Returned if the resource that was referenced in the path does not exist or cannot be referenced by the TPP or the PSU. When in doubt if a specific id in the path is sensitive or not, use the HTTP response code 404 instead of the HTTP response code 403.

Status: 405 - This code is only sent when the HTTP method (PUT, POST, DELETE, GET etc.) is not supported on a specific endpoint. It has nothing to do with the consent, payment or account information data model.

Status: 406 - The ASPSP cannot generate the content that the TPP specified in the Accept header.

Status: 429 - The TPP has exceeded the number of requests allowed by the consent or by the RTS.

Status: 500 - Internal server error occurred.


getTransactionsForAccountByAccountId

transactions for account

Reads a transaction list For a given account, additional parameters are e.g. the attributes "date_from" and "date_to". If the attribute "withbalance" is used, the ASPSP will add balances to the transaction list. The latter might be provided by the ASPSP anyhow, if transaction lists without balances are not supported.


/accounts/{account-id}/transactions

Usage and SDK Samples

curl -X GET -H "x-openpsd-key: [[apiKey]]" "{protocol}://psd2.ccbank.bg/psd2/v1/accounts/{account-id}/transactions?dateFrom=&dateTo=&entryReferenceFrom=&bookingStatus=&deltaList="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

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

public class AccountsApiExample {

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

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

        AccountsApi apiInstance = new AccountsApi();
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
        String accountId = accountId_example; // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        date dateFrom = 2013-10-20; // date | Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required
        date dateTo = 2013-10-20; // date | End date (inclusive the data dateTo) of the transaction list, default is now if not given.
        String entryReferenceFrom = entryReferenceFrom_example; // String | This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported.
        Boolean deltaList = true; // Boolean | This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported.
        String accept = accept_example; // String | The TPP can indicate the formats of account reports supported together with a priorisation following the HTTP header definition.
        try {
            inline_response_200_3 result = apiInstance.getTransactionsForAccountByAccountId(xRequestID, consentID, accountId, bookingStatus, authorization, digest, signature, tPPSignatureCertificate, dateFrom, dateTo, entryReferenceFrom, deltaList, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getTransactionsForAccountByAccountId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
        String accountId = accountId_example; // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        date dateFrom = 2013-10-20; // date | Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required
        date dateTo = 2013-10-20; // date | End date (inclusive the data dateTo) of the transaction list, default is now if not given.
        String entryReferenceFrom = entryReferenceFrom_example; // String | This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported.
        Boolean deltaList = true; // Boolean | This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported.
        String accept = accept_example; // String | The TPP can indicate the formats of account reports supported together with a priorisation following the HTTP header definition.
        try {
            inline_response_200_3 result = apiInstance.getTransactionsForAccountByAccountId(xRequestID, consentID, accountId, bookingStatus, authorization, digest, signature, tPPSignatureCertificate, dateFrom, dateTo, entryReferenceFrom, deltaList, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getTransactionsForAccountByAccountId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-openpsd-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-openpsd-key"];
UUID *xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // ID of the request, unique to the call, as determined by the initiating party.
String *consentID = consentID_example; // Shall be contained since "Establish Consent Transaction" was performed via this API before.
String *accountId = accountId_example; // This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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
String *authorization = authorization_example; // Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
String *digest = digest_example; // Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
String *signature = signature_example; // A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
String *tPPSignatureCertificate = tPPSignatureCertificate_example; // The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)
date *dateFrom = 2013-10-20; // Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required (optional)
date *dateTo = 2013-10-20; // End date (inclusive the data dateTo) of the transaction list, default is now if not given. (optional)
String *entryReferenceFrom = entryReferenceFrom_example; // This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported. (optional)
Boolean *deltaList = true; // This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. (optional)
String *accept = accept_example; // The TPP can indicate the formats of account reports supported together with a priorisation following the HTTP header definition. (optional)

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

// transactions for account
[apiInstance getTransactionsForAccountByAccountIdWith:xRequestID
    consentID:consentID
    accountId:accountId
    bookingStatus:bookingStatus
    authorization:authorization
    digest:digest
    signature:signature
    tPPSignatureCertificate:tPPSignatureCertificate
    dateFrom:dateFrom
    dateTo:dateTo
    entryReferenceFrom:entryReferenceFrom
    deltaList:deltaList
    accept:accept
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenPsdNextGenPsd2 = require('open_psd_next_gen_psd2');
var defaultClient = OpenPsdNextGenPsd2.ApiClient.instance;

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

var api = new OpenPsdNextGenPsd2.AccountsApi()
var xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} ID of the request, unique to the call, as determined by the initiating party.
var consentID = consentID_example; // {{String}} Shall be contained since "Establish Consent Transaction" was performed via this API before.
var accountId = accountId_example; // {{String}} This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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
var opts = { 
  'authorization': authorization_example, // {{String}} Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
  'digest': digest_example, // {{String}} Is contained if and only if the "Signature" element is contained in the header of the request.
  'signature': signature_example, // {{String}} A signature of the request by the TPP on application level. This might be mandated by ASPSP.
  'tPPSignatureCertificate': tPPSignatureCertificate_example, // {{String}} The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
  'dateFrom': 2013-10-20, // {{date}} Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required
  'dateTo': 2013-10-20, // {{date}} End date (inclusive the data dateTo) of the transaction list, default is now if not given.
  'entryReferenceFrom': entryReferenceFrom_example, // {{String}} This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported.
  'deltaList': true, // {{Boolean}} This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported.
  'accept': accept_example // {{String}} The TPP can indicate the formats of account reports supported together with a priorisation following the HTTP header definition.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransactionsForAccountByAccountId(xRequestID, consentID, accountId, bookingStatus, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AccountsApi();
            var xRequestID = new UUID(); // UUID | ID of the request, unique to the call, as determined by the initiating party.
            var consentID = consentID_example;  // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
            var accountId = accountId_example;  // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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
            var authorization = authorization_example;  // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional) 
            var digest = digest_example;  // String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional) 
            var signature = signature_example;  // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional) 
            var tPPSignatureCertificate = tPPSignatureCertificate_example;  // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional) 
            var dateFrom = 2013-10-20;  // date | Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required (optional) 
            var dateTo = 2013-10-20;  // date | End date (inclusive the data dateTo) of the transaction list, default is now if not given. (optional) 
            var entryReferenceFrom = entryReferenceFrom_example;  // String | This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported. (optional) 
            var deltaList = true;  // Boolean | This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. (optional) 
            var accept = accept_example;  // String | The TPP can indicate the formats of account reports supported together with a priorisation following the HTTP header definition. (optional) 

            try
            {
                // transactions for account
                inline_response_200_3 result = apiInstance.getTransactionsForAccountByAccountId(xRequestID, consentID, accountId, bookingStatus, authorization, digest, signature, tPPSignatureCertificate, dateFrom, dateTo, entryReferenceFrom, deltaList, accept);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.getTransactionsForAccountByAccountId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccountsApi();
$xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
$consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
$accountId = accountId_example; // String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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
$authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
$digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
$signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
$tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
$dateFrom = 2013-10-20; // date | Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required
$dateTo = 2013-10-20; // date | End date (inclusive the data dateTo) of the transaction list, default is now if not given.
$entryReferenceFrom = entryReferenceFrom_example; // String | This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported.
$deltaList = true; // Boolean | This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported.
$accept = accept_example; // String | The TPP can indicate the formats of account reports supported together with a priorisation following the HTTP header definition.

try {
    $result = $api_instance->getTransactionsForAccountByAccountId($xRequestID, $consentID, $accountId, $bookingStatus, $authorization, $digest, $signature, $tPPSignatureCertificate, $dateFrom, $dateTo, $entryReferenceFrom, $deltaList, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getTransactionsForAccountByAccountId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;

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

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | ID of the request, unique to the call, as determined by the initiating party.
my $consentID = consentID_example; # String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
my $accountId = accountId_example; # String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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
my $authorization = authorization_example; # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
my $digest = digest_example; # String | Is contained if and only if the "Signature" element is contained in the header of the request.
my $signature = signature_example; # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
my $tPPSignatureCertificate = tPPSignatureCertificate_example; # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
my $dateFrom = 2013-10-20; # date | Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required
my $dateTo = 2013-10-20; # date | End date (inclusive the data dateTo) of the transaction list, default is now if not given.
my $entryReferenceFrom = entryReferenceFrom_example; # String | This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported.
my $deltaList = true; # Boolean | This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported.
my $accept = accept_example; # String | The TPP can indicate the formats of account reports supported together with a priorisation following the HTTP header definition.

eval { 
    my $result = $api_instance->getTransactionsForAccountByAccountId(xRequestID => $xRequestID, consentID => $consentID, accountId => $accountId, bookingStatus => $bookingStatus, authorization => $authorization, digest => $digest, signature => $signature, tPPSignatureCertificate => $tPPSignatureCertificate, dateFrom => $dateFrom, dateTo => $dateTo, entryReferenceFrom => $entryReferenceFrom, deltaList => $deltaList, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->getTransactionsForAccountByAccountId: $@\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: ApiKeyAuth
swagger_client.configuration.api_key['x-openpsd-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-openpsd-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | ID of the request, unique to the call, as determined by the initiating party.
consentID = consentID_example # String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
accountId = accountId_example # String | This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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
authorization = authorization_example # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
digest = digest_example # String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
signature = signature_example # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
tPPSignatureCertificate = tPPSignatureCertificate_example # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)
dateFrom = 2013-10-20 # date | Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required (optional)
dateTo = 2013-10-20 # date | End date (inclusive the data dateTo) of the transaction list, default is now if not given. (optional)
entryReferenceFrom = entryReferenceFrom_example # String | This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported. (optional)
deltaList = true # Boolean | This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. (optional)
accept = accept_example # String | The TPP can indicate the formats of account reports supported together with a priorisation following the HTTP header definition. (optional)

try: 
    # transactions for account
    api_response = api_instance.get_transactions_for_account_by_account_id(xRequestID, consentID, accountId, bookingStatus, authorization=authorization, digest=digest, signature=signature, tPPSignatureCertificate=tPPSignatureCertificate, dateFrom=dateFrom, dateTo=dateTo, entryReferenceFrom=entryReferenceFrom, deltaList=deltaList, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->getTransactionsForAccountByAccountId: %s\n" % e)

Parameters

Path parameters
Name Description
account-id*
String
This identification is denoting the addressed account. The account-id is retrieved by using a "Read 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*
UUID (uuid)
ID of the request, unique to the call, as determined by the initiating party.
Required
Consent-ID*
String
Shall be contained since "Establish Consent Transaction" was performed via this API before.
Required
Authorization
String
Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
Digest
String
Is contained if and only if the "Signature" element is contained in the header of the request.
Signature
String
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate
String
The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
Accept
String
The TPP can indicate the formats of account reports supported together with a priorisation following the HTTP header definition.
Query parameters
Name Description
dateFrom
date (date)
Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required
dateTo
date (date)
End date (inclusive the data dateTo) of the transaction list, default is now if not given.
entryReferenceFrom
String
This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported.
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
Required
deltaList
Boolean
This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported.

Responses

Status: 200 - OK

Name Type Format Description

Status: 400 - Validation error occurred. This code will cover malformed syntax in request or incorrect data in payload.

Status: 401 - The TPP or the PSU is not correctly authorized to perform the request. Retry the request with correct authentication information.

Status: 403 - Returned if the resource that was referenced in the path exists but cannot be accessed by the TPP or the PSU. This code should only be used for non-sensitive id references as it will reveal that the resource exists even though it cannot be accessed.

Status: 404 - Returned if the resource that was referenced in the path does not exist or cannot be referenced by the TPP or the PSU. When in doubt if a specific id in the path is sensitive or not, use the HTTP response code 404 instead of the HTTP response code 403.

Status: 405 - This code is only sent when the HTTP method (PUT, POST, DELETE, GET etc.) is not supported on a specific endpoint. It has nothing to do with the consent, payment or account information data model.

Status: 406 - The ASPSP cannot generate the content that the TPP specified in the Accept header.

Status: 429 - The TPP has exceeded the number of requests allowed by the consent or by the RTS.

Status: 500 - Internal server error occurred.


Consents

createConsent

create a consent

Creates a consent resource, defining access rights to dedicated accounts of a given PSU-ID. These accounts must be addressed explicitly in the method as parameters.


/consents

Usage and SDK Samples

curl -X POST -H "x-openpsd-key: [[apiKey]]" "{protocol}://psd2.ccbank.bg/psd2/v1/consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsentsApi;

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

public class ConsentsApiExample {

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

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

        ConsentsApi apiInstance = new ConsentsApi();
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 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.
        CreateConsentsRequest body = ; // CreateConsentsRequest | 
        String pSUID = pSUID_example; // String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
        String pSUIDType = pSUIDType_example; // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
        String pSUCorporateID = pSUCorporateID_example; // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context.
        String pSUCorporateIDType = pSUCorporateIDType_example; // String | Might be mandated in the ASPSPs documentation. Only used in a corporate context.
        String pSUIPPort = pSUIPPort_example; // String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
        String pSUAccept = pSUAccept_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptCharset = pSUAcceptCharset_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptEncoding = pSUAcceptEncoding_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptLanguage = pSUAcceptLanguage_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUUserAgent = pSUUserAgent_example; // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
        String pSUHttpMethod = pSUHttpMethod_example; // String | HTTP method used at the PSU - TPP interface, if available.
        String pSUDeviceID = pSUDeviceID_example; // String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
        String pSUGeoLocation = pSUGeoLocation_example; // String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        Boolean tPPRedirectPreferred = true; // Boolean | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU.
        String tPPRedirectURI = tPPRedirectURI_example; // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach.
        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 digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            CreateConsentsResponse result = apiInstance.createConsent(xRequestID, pSUIPAddress, body, pSUID, pSUIDType, pSUCorporateID, pSUCorporateIDType, pSUIPPort, pSUAccept, pSUAcceptCharset, pSUAcceptEncoding, pSUAcceptLanguage, pSUUserAgent, pSUHttpMethod, pSUDeviceID, pSUGeoLocation, authorization, tPPRedirectPreferred, tPPRedirectURI, tPPNokRedirectURI, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#createConsent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsentsApi;

public class ConsentsApiExample {

    public static void main(String[] args) {
        ConsentsApi apiInstance = new ConsentsApi();
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 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.
        CreateConsentsRequest body = ; // CreateConsentsRequest | 
        String pSUID = pSUID_example; // String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
        String pSUIDType = pSUIDType_example; // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
        String pSUCorporateID = pSUCorporateID_example; // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context.
        String pSUCorporateIDType = pSUCorporateIDType_example; // String | Might be mandated in the ASPSPs documentation. Only used in a corporate context.
        String pSUIPPort = pSUIPPort_example; // String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
        String pSUAccept = pSUAccept_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptCharset = pSUAcceptCharset_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptEncoding = pSUAcceptEncoding_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptLanguage = pSUAcceptLanguage_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUUserAgent = pSUUserAgent_example; // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
        String pSUHttpMethod = pSUHttpMethod_example; // String | HTTP method used at the PSU - TPP interface, if available.
        String pSUDeviceID = pSUDeviceID_example; // String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
        String pSUGeoLocation = pSUGeoLocation_example; // String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        Boolean tPPRedirectPreferred = true; // Boolean | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU.
        String tPPRedirectURI = tPPRedirectURI_example; // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach.
        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 digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            CreateConsentsResponse result = apiInstance.createConsent(xRequestID, pSUIPAddress, body, pSUID, pSUIDType, pSUCorporateID, pSUCorporateIDType, pSUIPPort, pSUAccept, pSUAcceptCharset, pSUAcceptEncoding, pSUAcceptLanguage, pSUUserAgent, pSUHttpMethod, pSUDeviceID, pSUGeoLocation, authorization, tPPRedirectPreferred, tPPRedirectURI, tPPNokRedirectURI, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#createConsent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-openpsd-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-openpsd-key"];
UUID *xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 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.
CreateConsentsRequest *body = ; //  (optional)
String *pSUID = pSUID_example; // Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step. (optional)
String *pSUIDType = pSUIDType_example; // Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. (optional)
String *pSUCorporateID = pSUCorporateID_example; // Might be mandated in the ASPSP's documentation. Only used in a corporate context. (optional)
String *pSUCorporateIDType = pSUCorporateIDType_example; // Might be mandated in the ASPSPs documentation. Only used in a corporate context. (optional)
String *pSUIPPort = pSUIPPort_example; // The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. (optional)
String *pSUAccept = pSUAccept_example; // The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
String *pSUAcceptCharset = pSUAcceptCharset_example; // The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
String *pSUAcceptEncoding = pSUAcceptEncoding_example; // The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
String *pSUAcceptLanguage = pSUAcceptLanguage_example; // The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
String *pSUUserAgent = pSUUserAgent_example; // The forwarded Agent header field of the HTTP request between PSU and TPP, if available. (optional)
String *pSUHttpMethod = pSUHttpMethod_example; // HTTP method used at the PSU - TPP interface, if available. (optional)
String *pSUDeviceID = pSUDeviceID_example; // UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device. (optional)
String *pSUGeoLocation = pSUGeoLocation_example; // The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available. (optional)
String *authorization = authorization_example; // Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
Boolean *tPPRedirectPreferred = true; // If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU. (optional)
String *tPPRedirectURI = tPPRedirectURI_example; // URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach. (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 *digest = digest_example; // Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
String *signature = signature_example; // A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
String *tPPSignatureCertificate = tPPSignatureCertificate_example; // The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

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

// create a consent
[apiInstance createConsentWith:xRequestID
    pSUIPAddress:pSUIPAddress
    body:body
    pSUID:pSUID
    pSUIDType:pSUIDType
    pSUCorporateID:pSUCorporateID
    pSUCorporateIDType:pSUCorporateIDType
    pSUIPPort:pSUIPPort
    pSUAccept:pSUAccept
    pSUAcceptCharset:pSUAcceptCharset
    pSUAcceptEncoding:pSUAcceptEncoding
    pSUAcceptLanguage:pSUAcceptLanguage
    pSUUserAgent:pSUUserAgent
    pSUHttpMethod:pSUHttpMethod
    pSUDeviceID:pSUDeviceID
    pSUGeoLocation:pSUGeoLocation
    authorization:authorization
    tPPRedirectPreferred:tPPRedirectPreferred
    tPPRedirectURI:tPPRedirectURI
    tPPNokRedirectURI:tPPNokRedirectURI
    digest:digest
    signature:signature
    tPPSignatureCertificate:tPPSignatureCertificate
              completionHandler: ^(CreateConsentsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenPsdNextGenPsd2 = require('open_psd_next_gen_psd2');
var defaultClient = OpenPsdNextGenPsd2.ApiClient.instance;

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

var api = new OpenPsdNextGenPsd2.ConsentsApi()
var xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 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.
var opts = { 
  'body':  // {{CreateConsentsRequest}} 
  'pSUID': pSUID_example // {{String}} Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
  'pSUIDType': pSUIDType_example // {{String}} Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
  'pSUCorporateID': pSUCorporateID_example // {{String}} Might be mandated in the ASPSP's documentation. Only used in a corporate context.
  'pSUCorporateIDType': pSUCorporateIDType_example // {{String}} Might be mandated in the ASPSPs documentation. Only used in a corporate context.
  'pSUIPPort': pSUIPPort_example // {{String}} The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
  'pSUAccept': pSUAccept_example // {{String}} The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
  'pSUAcceptCharset': pSUAcceptCharset_example // {{String}} The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
  'pSUAcceptEncoding': pSUAcceptEncoding_example // {{String}} The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
  'pSUAcceptLanguage': pSUAcceptLanguage_example // {{String}} The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
  'pSUUserAgent': pSUUserAgent_example // {{String}} The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
  'pSUHttpMethod': pSUHttpMethod_example // {{String}} HTTP method used at the PSU - TPP interface, if available.
  'pSUDeviceID': pSUDeviceID_example // {{String}} UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
  'pSUGeoLocation': pSUGeoLocation_example // {{String}} The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
  'authorization': authorization_example // {{String}} Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
  'tPPRedirectPreferred': true // {{Boolean}} If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU.
  'tPPRedirectURI': tPPRedirectURI_example // {{String}} URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach.
  '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.
  'digest': digest_example // {{String}} Is contained if and only if the "Signature" element is contained in the header of the request.
  'signature': signature_example // {{String}} A signature of the request by the TPP on application level. This might be mandated by ASPSP.
  'tPPSignatureCertificate': tPPSignatureCertificate_example // {{String}} The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createConsent(xRequestIDpSUIPAddress, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ConsentsApi();
            var xRequestID = new UUID(); // UUID | 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.
            var body = new CreateConsentsRequest(); // CreateConsentsRequest |  (optional) 
            var pSUID = pSUID_example;  // String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step. (optional) 
            var pSUIDType = pSUIDType_example;  // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. (optional) 
            var pSUCorporateID = pSUCorporateID_example;  // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context. (optional) 
            var pSUCorporateIDType = pSUCorporateIDType_example;  // String | Might be mandated in the ASPSPs documentation. Only used in a corporate context. (optional) 
            var pSUIPPort = pSUIPPort_example;  // String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. (optional) 
            var pSUAccept = pSUAccept_example;  // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional) 
            var pSUAcceptCharset = pSUAcceptCharset_example;  // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional) 
            var pSUAcceptEncoding = pSUAcceptEncoding_example;  // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional) 
            var pSUAcceptLanguage = pSUAcceptLanguage_example;  // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional) 
            var pSUUserAgent = pSUUserAgent_example;  // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. (optional) 
            var pSUHttpMethod = pSUHttpMethod_example;  // String | HTTP method used at the PSU - TPP interface, if available. (optional) 
            var pSUDeviceID = pSUDeviceID_example;  // String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device. (optional) 
            var pSUGeoLocation = pSUGeoLocation_example;  // String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available. (optional) 
            var authorization = authorization_example;  // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional) 
            var tPPRedirectPreferred = true;  // Boolean | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU. (optional) 
            var tPPRedirectURI = tPPRedirectURI_example;  // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach. (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 digest = digest_example;  // String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional) 
            var signature = signature_example;  // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional) 
            var tPPSignatureCertificate = tPPSignatureCertificate_example;  // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional) 

            try
            {
                // create a consent
                CreateConsentsResponse result = apiInstance.createConsent(xRequestID, pSUIPAddress, body, pSUID, pSUIDType, pSUCorporateID, pSUCorporateIDType, pSUIPPort, pSUAccept, pSUAcceptCharset, pSUAcceptEncoding, pSUAcceptLanguage, pSUUserAgent, pSUHttpMethod, pSUDeviceID, pSUGeoLocation, authorization, tPPRedirectPreferred, tPPRedirectURI, tPPNokRedirectURI, digest, signature, tPPSignatureCertificate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsentsApi.createConsent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiConsentsApi();
$xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 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.
$body = ; // CreateConsentsRequest | 
$pSUID = pSUID_example; // String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
$pSUIDType = pSUIDType_example; // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
$pSUCorporateID = pSUCorporateID_example; // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context.
$pSUCorporateIDType = pSUCorporateIDType_example; // String | Might be mandated in the ASPSPs documentation. Only used in a corporate context.
$pSUIPPort = pSUIPPort_example; // String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
$pSUAccept = pSUAccept_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
$pSUAcceptCharset = pSUAcceptCharset_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
$pSUAcceptEncoding = pSUAcceptEncoding_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
$pSUAcceptLanguage = pSUAcceptLanguage_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
$pSUUserAgent = pSUUserAgent_example; // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
$pSUHttpMethod = pSUHttpMethod_example; // String | HTTP method used at the PSU - TPP interface, if available.
$pSUDeviceID = pSUDeviceID_example; // String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
$pSUGeoLocation = pSUGeoLocation_example; // String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
$authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
$tPPRedirectPreferred = true; // Boolean | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU.
$tPPRedirectURI = tPPRedirectURI_example; // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach.
$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.
$digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
$signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
$tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

try {
    $result = $api_instance->createConsent($xRequestID, $pSUIPAddress, $body, $pSUID, $pSUIDType, $pSUCorporateID, $pSUCorporateIDType, $pSUIPPort, $pSUAccept, $pSUAcceptCharset, $pSUAcceptEncoding, $pSUAcceptLanguage, $pSUUserAgent, $pSUHttpMethod, $pSUDeviceID, $pSUGeoLocation, $authorization, $tPPRedirectPreferred, $tPPRedirectURI, $tPPNokRedirectURI, $digest, $signature, $tPPSignatureCertificate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsentsApi->createConsent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsentsApi;

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

my $api_instance = WWW::SwaggerClient::ConsentsApi->new();
my $xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 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.
my $body = WWW::SwaggerClient::Object::CreateConsentsRequest->new(); # CreateConsentsRequest | 
my $pSUID = pSUID_example; # String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
my $pSUIDType = pSUIDType_example; # String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
my $pSUCorporateID = pSUCorporateID_example; # String | Might be mandated in the ASPSP's documentation. Only used in a corporate context.
my $pSUCorporateIDType = pSUCorporateIDType_example; # String | Might be mandated in the ASPSPs documentation. Only used in a corporate context.
my $pSUIPPort = pSUIPPort_example; # String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
my $pSUAccept = pSUAccept_example; # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
my $pSUAcceptCharset = pSUAcceptCharset_example; # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
my $pSUAcceptEncoding = pSUAcceptEncoding_example; # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
my $pSUAcceptLanguage = pSUAcceptLanguage_example; # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
my $pSUUserAgent = pSUUserAgent_example; # String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
my $pSUHttpMethod = pSUHttpMethod_example; # String | HTTP method used at the PSU - TPP interface, if available.
my $pSUDeviceID = pSUDeviceID_example; # String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
my $pSUGeoLocation = pSUGeoLocation_example; # String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
my $authorization = authorization_example; # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
my $tPPRedirectPreferred = true; # Boolean | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU.
my $tPPRedirectURI = tPPRedirectURI_example; # String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach.
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 $digest = digest_example; # String | Is contained if and only if the "Signature" element is contained in the header of the request.
my $signature = signature_example; # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
my $tPPSignatureCertificate = tPPSignatureCertificate_example; # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

eval { 
    my $result = $api_instance->createConsent(xRequestID => $xRequestID, pSUIPAddress => $pSUIPAddress, body => $body, pSUID => $pSUID, pSUIDType => $pSUIDType, pSUCorporateID => $pSUCorporateID, pSUCorporateIDType => $pSUCorporateIDType, pSUIPPort => $pSUIPPort, pSUAccept => $pSUAccept, pSUAcceptCharset => $pSUAcceptCharset, pSUAcceptEncoding => $pSUAcceptEncoding, pSUAcceptLanguage => $pSUAcceptLanguage, pSUUserAgent => $pSUUserAgent, pSUHttpMethod => $pSUHttpMethod, pSUDeviceID => $pSUDeviceID, pSUGeoLocation => $pSUGeoLocation, authorization => $authorization, tPPRedirectPreferred => $tPPRedirectPreferred, tPPRedirectURI => $tPPRedirectURI, tPPNokRedirectURI => $tPPNokRedirectURI, digest => $digest, signature => $signature, tPPSignatureCertificate => $tPPSignatureCertificate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsentsApi->createConsent: $@\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: ApiKeyAuth
swagger_client.configuration.api_key['x-openpsd-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-openpsd-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConsentsApi()
xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 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.
body =  # CreateConsentsRequest |  (optional)
pSUID = pSUID_example # String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step. (optional)
pSUIDType = pSUIDType_example # String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. (optional)
pSUCorporateID = pSUCorporateID_example # String | Might be mandated in the ASPSP's documentation. Only used in a corporate context. (optional)
pSUCorporateIDType = pSUCorporateIDType_example # String | Might be mandated in the ASPSPs documentation. Only used in a corporate context. (optional)
pSUIPPort = pSUIPPort_example # String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. (optional)
pSUAccept = pSUAccept_example # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
pSUAcceptCharset = pSUAcceptCharset_example # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
pSUAcceptEncoding = pSUAcceptEncoding_example # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
pSUAcceptLanguage = pSUAcceptLanguage_example # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
pSUUserAgent = pSUUserAgent_example # String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. (optional)
pSUHttpMethod = pSUHttpMethod_example # String | HTTP method used at the PSU - TPP interface, if available. (optional)
pSUDeviceID = pSUDeviceID_example # String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device. (optional)
pSUGeoLocation = pSUGeoLocation_example # String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available. (optional)
authorization = authorization_example # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
tPPRedirectPreferred = true # Boolean | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU. (optional)
tPPRedirectURI = tPPRedirectURI_example # String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach. (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)
digest = digest_example # String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
signature = signature_example # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
tPPSignatureCertificate = tPPSignatureCertificate_example # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

try: 
    # create a consent
    api_response = api_instance.create_consent(xRequestID, pSUIPAddress, body=body, pSUID=pSUID, pSUIDType=pSUIDType, pSUCorporateID=pSUCorporateID, pSUCorporateIDType=pSUCorporateIDType, pSUIPPort=pSUIPPort, pSUAccept=pSUAccept, pSUAcceptCharset=pSUAcceptCharset, pSUAcceptEncoding=pSUAcceptEncoding, pSUAcceptLanguage=pSUAcceptLanguage, pSUUserAgent=pSUUserAgent, pSUHttpMethod=pSUHttpMethod, pSUDeviceID=pSUDeviceID, pSUGeoLocation=pSUGeoLocation, authorization=authorization, tPPRedirectPreferred=tPPRedirectPreferred, tPPRedirectURI=tPPRedirectURI, tPPNokRedirectURI=tPPNokRedirectURI, digest=digest, signature=signature, tPPSignatureCertificate=tPPSignatureCertificate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsentsApi->createConsent: %s\n" % e)

Parameters

Header parameters
Name Description
X-Request-ID*
UUID (uuid)
ID of the request, unique to the call, as determined by the initiating party.
Required
PSU-ID
String
Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
PSU-ID-Type
String
Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
PSU-Corporate-ID
String
Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type
String
Might be mandated in the ASPSPs documentation. Only used in a corporate context.
PSU-IP-Address*
String
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP.
Required
PSU-IP-Port
String
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept
String
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset
String
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding
String
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language
String
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent
String
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method
String
HTTP method used at the PSU - TPP interface, if available.
PSU-Device-ID
String
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-Geo-Location
String
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
Authorization
String
Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
TPP-Redirect-Preferred
Boolean
If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU.
TPP-Redirect-URI
String
URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach.
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.
Digest
String
Is contained if and only if the "Signature" element is contained in the header of the request.
Signature
String
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate
String
The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
Body parameters
Name Description
body

Responses

Status: 201 - Consent Request was correctly performed.

Name Type Format Description

Status: 400 - Validation error occurred. This code will cover malformed syntax in request or incorrect data in payload.

Status: 401 - The TPP or the PSU is not correctly authorized to perform the request. Retry the request with correct authentication information.

Status: 403 - Returned if the resource that was referenced in the path exists but cannot be accessed by the TPP or the PSU. This code should only be used for non-sensitive id references as it will reveal that the resource exists even though it cannot be accessed.

Status: 404 - Returned if the resource that was referenced in the path does not exist or cannot be referenced by the TPP or the PSU. When in doubt if a specific id in the path is sensitive or not, use the HTTP response code 404 instead of the HTTP response code 403.

Status: 405 - This code is only sent when the HTTP method (PUT, POST, DELETE, GET etc.) is not supported on a specific endpoint. It has nothing to do with the consent, payment or account information data model.

Status: 500 - Internal server error occurred.


deleteConsent

delete consent

Deletes a created consent with ID.


/consents/{consentId}

Usage and SDK Samples

curl -X DELETE -H "x-openpsd-key: [[apiKey]]" "{protocol}://psd2.ccbank.bg/psd2/v1/consents/{consentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsentsApi;

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

public class ConsentsApiExample {

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

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

        ConsentsApi apiInstance = new ConsentsApi();
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an Account Information Consent Request
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        try {
            apiInstance.deleteConsent(consentId, xRequestID, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#deleteConsent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsentsApi;

public class ConsentsApiExample {

    public static void main(String[] args) {
        ConsentsApi apiInstance = new ConsentsApi();
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an Account Information Consent Request
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        try {
            apiInstance.deleteConsent(consentId, xRequestID, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#deleteConsent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-openpsd-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-openpsd-key"];
String *consentId = consentId_example; // ID of the corresponding consent object as returned by an Account Information Consent Request
UUID *xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // ID of the request, unique to the call, as determined by the initiating party.
String *authorization = authorization_example; // Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)

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

// delete consent
[apiInstance deleteConsentWith:consentId
    xRequestID:xRequestID
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenPsdNextGenPsd2 = require('open_psd_next_gen_psd2');
var defaultClient = OpenPsdNextGenPsd2.ApiClient.instance;

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

var api = new OpenPsdNextGenPsd2.ConsentsApi()
var consentId = consentId_example; // {{String}} ID of the corresponding consent object as returned by an Account Information Consent Request
var xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} ID of the request, unique to the call, as determined by the initiating party.
var opts = { 
  'authorization': authorization_example // {{String}} Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteConsent(consentId, xRequestID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ConsentsApi();
            var consentId = consentId_example;  // String | ID of the corresponding consent object as returned by an Account Information Consent Request
            var xRequestID = new UUID(); // UUID | ID of the request, unique to the call, as determined by the initiating party.
            var authorization = authorization_example;  // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional) 

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

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

$api_instance = new Swagger\Client\ApiConsentsApi();
$consentId = consentId_example; // String | ID of the corresponding consent object as returned by an Account Information Consent Request
$xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
$authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.

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

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

my $api_instance = WWW::SwaggerClient::ConsentsApi->new();
my $consentId = consentId_example; # String | ID of the corresponding consent object as returned by an Account Information Consent Request
my $xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | ID of the request, unique to the call, as determined by the initiating party.
my $authorization = authorization_example; # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.

eval { 
    $api_instance->deleteConsent(consentId => $consentId, xRequestID => $xRequestID, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ConsentsApi->deleteConsent: $@\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: ApiKeyAuth
swagger_client.configuration.api_key['x-openpsd-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-openpsd-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConsentsApi()
consentId = consentId_example # String | ID of the corresponding consent object as returned by an Account Information Consent Request
xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | ID of the request, unique to the call, as determined by the initiating party.
authorization = authorization_example # String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)

try: 
    # delete consent
    api_instance.delete_consent(consentId, xRequestID, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConsentsApi->deleteConsent: %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
Authorization
String
Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
X-Request-ID*
UUID (uuid)
ID of the request, unique to the call, as determined by the initiating party.
Required

Responses

Status: 204 - Consent resource was successfully deleted.

Name Type Format Description

Status: 400 - Validation error occurred. This code will cover malformed syntax in request or incorrect data in payload.

Status: 401 - The TPP or the PSU is not correctly authorized to perform the request. Retry the request with correct authentication information.

Status: 403 - Returned if the resource that was referenced in the path exists but cannot be accessed by the TPP or the PSU. This code should only be used for non-sensitive id references as it will reveal that the resource exists even though it cannot be accessed.

Status: 500 - Internal server error occurred.


getConsent

get consent details

Reads the exact definition of the given consent resource {consentId}


/consents/{consentId}

Usage and SDK Samples

curl -X GET -H "x-openpsd-key: [[apiKey]]" "{protocol}://psd2.ccbank.bg/psd2/v1/consents/{consentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsentsApi;

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

public class ConsentsApiExample {

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

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

        ConsentsApi apiInstance = new ConsentsApi();
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an Account Information Consent Request
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200_5 result = apiInstance.getConsent(consentId, xRequestID, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#getConsent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsentsApi;

public class ConsentsApiExample {

    public static void main(String[] args) {
        ConsentsApi apiInstance = new ConsentsApi();
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an Account Information Consent Request
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200_5 result = apiInstance.getConsent(consentId, xRequestID, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#getConsent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-openpsd-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-openpsd-key"];
String *consentId = consentId_example; // ID of the corresponding consent object as returned by an Account Information Consent Request
UUID *xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // ID of the request, unique to the call, as determined by the initiating party.
String *digest = digest_example; // Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
String *signature = signature_example; // A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
String *tPPSignatureCertificate = tPPSignatureCertificate_example; // The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

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

// get consent details
[apiInstance getConsentWith:consentId
    xRequestID:xRequestID
    digest:digest
    signature:signature
    tPPSignatureCertificate:tPPSignatureCertificate
              completionHandler: ^(inline_response_200_5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenPsdNextGenPsd2 = require('open_psd_next_gen_psd2');
var defaultClient = OpenPsdNextGenPsd2.ApiClient.instance;

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

var api = new OpenPsdNextGenPsd2.ConsentsApi()
var consentId = consentId_example; // {{String}} ID of the corresponding consent object as returned by an Account Information Consent Request
var xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} ID of the request, unique to the call, as determined by the initiating party.
var opts = { 
  'digest': digest_example, // {{String}} Is contained if and only if the "Signature" element is contained in the header of the request.
  'signature': signature_example, // {{String}} A signature of the request by the TPP on application level. This might be mandated by ASPSP.
  'tPPSignatureCertificate': tPPSignatureCertificate_example // {{String}} The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsent(consentId, xRequestID, 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: ApiKeyAuth
            Configuration.Default.ApiKey.Add("x-openpsd-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-openpsd-key", "Bearer");

            var apiInstance = new ConsentsApi();
            var consentId = consentId_example;  // String | ID of the corresponding consent object as returned by an Account Information Consent Request
            var xRequestID = new UUID(); // UUID | ID of the request, unique to the call, as determined by the initiating party.
            var digest = digest_example;  // String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional) 
            var signature = signature_example;  // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional) 
            var tPPSignatureCertificate = tPPSignatureCertificate_example;  // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional) 

            try
            {
                // get consent details
                inline_response_200_5 result = apiInstance.getConsent(consentId, xRequestID, digest, signature, tPPSignatureCertificate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsentsApi.getConsent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiConsentsApi();
$consentId = consentId_example; // String | ID of the corresponding consent object as returned by an Account Information Consent Request
$xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
$digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
$signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
$tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

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

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

my $api_instance = WWW::SwaggerClient::ConsentsApi->new();
my $consentId = consentId_example; # String | ID of the corresponding consent object as returned by an Account Information Consent Request
my $xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | ID of the request, unique to the call, as determined by the initiating party.
my $digest = digest_example; # String | Is contained if and only if the "Signature" element is contained in the header of the request.
my $signature = signature_example; # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
my $tPPSignatureCertificate = tPPSignatureCertificate_example; # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

eval { 
    my $result = $api_instance->getConsent(consentId => $consentId, xRequestID => $xRequestID, digest => $digest, signature => $signature, tPPSignatureCertificate => $tPPSignatureCertificate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsentsApi->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: ApiKeyAuth
swagger_client.configuration.api_key['x-openpsd-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-openpsd-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConsentsApi()
consentId = consentId_example # String | ID of the corresponding consent object as returned by an Account Information Consent Request
xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | ID of the request, unique to the call, as determined by the initiating party.
digest = digest_example # String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
signature = signature_example # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
tPPSignatureCertificate = tPPSignatureCertificate_example # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

try: 
    # get consent details
    api_response = api_instance.get_consent(consentId, xRequestID, digest=digest, signature=signature, tPPSignatureCertificate=tPPSignatureCertificate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsentsApi->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*
UUID (uuid)
ID of the request, unique to the call, as determined by the initiating party.
Required
Digest
String
Is contained if and only if the "Signature" element is contained in the header of the request.
Signature
String
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate
String
The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

Responses

Status: 200 - OK

Name Type Format Description

Status: 400 - Validation error occurred. This code will cover malformed syntax in request or incorrect data in payload.

Status: 401 - The TPP or the PSU is not correctly authorized to perform the request. Retry the request with correct authentication information.

Status: 403 - Returned if the resource that was referenced in the path exists but cannot be accessed by the TPP or the PSU. This code should only be used for non-sensitive id references as it will reveal that the resource exists even though it cannot be accessed.

Status: 404 - Returned if the resource that was referenced in the path does not exist or cannot be referenced by the TPP or the PSU. When in doubt if a specific id in the path is sensitive or not, use the HTTP response code 404 instead of the HTTP response code 403.

Status: 405 - This code is only sent when the HTTP method (PUT, POST, DELETE, GET etc.) is not supported on a specific endpoint. It has nothing to do with the consent, payment or account information data model.

Status: 500 - Internal server error occurred.


getStatusForConsentById

get status of a consent

Reads the transaction status of the addressed consent resource.


/consents/{consentId}/status

Usage and SDK Samples

curl -X GET -H "x-openpsd-key: [[apiKey]]" "{protocol}://psd2.ccbank.bg/psd2/v1/consents/{consentId}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsentsApi;

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

public class ConsentsApiExample {

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

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

        ConsentsApi apiInstance = new ConsentsApi();
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an Account Information Consent Request
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200_6 result = apiInstance.getStatusForConsentById(consentId, xRequestID, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#getStatusForConsentById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsentsApi;

public class ConsentsApiExample {

    public static void main(String[] args) {
        ConsentsApi apiInstance = new ConsentsApi();
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an Account Information Consent Request
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200_6 result = apiInstance.getStatusForConsentById(consentId, xRequestID, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#getStatusForConsentById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-openpsd-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-openpsd-key"];
String *consentId = consentId_example; // ID of the corresponding consent object as returned by an Account Information Consent Request
UUID *xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // ID of the request, unique to the call, as determined by the initiating party.
String *digest = digest_example; // Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
String *signature = signature_example; // A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
String *tPPSignatureCertificate = tPPSignatureCertificate_example; // The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

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

// get status of a consent
[apiInstance getStatusForConsentByIdWith:consentId
    xRequestID:xRequestID
    digest:digest
    signature:signature
    tPPSignatureCertificate:tPPSignatureCertificate
              completionHandler: ^(inline_response_200_6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenPsdNextGenPsd2 = require('open_psd_next_gen_psd2');
var defaultClient = OpenPsdNextGenPsd2.ApiClient.instance;

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

var api = new OpenPsdNextGenPsd2.ConsentsApi()
var consentId = consentId_example; // {{String}} ID of the corresponding consent object as returned by an Account Information Consent Request
var xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} ID of the request, unique to the call, as determined by the initiating party.
var opts = { 
  'digest': digest_example, // {{String}} Is contained if and only if the "Signature" element is contained in the header of the request.
  'signature': signature_example, // {{String}} A signature of the request by the TPP on application level. This might be mandated by ASPSP.
  'tPPSignatureCertificate': tPPSignatureCertificate_example // {{String}} The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStatusForConsentById(consentId, xRequestID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ConsentsApi();
            var consentId = consentId_example;  // String | ID of the corresponding consent object as returned by an Account Information Consent Request
            var xRequestID = new UUID(); // UUID | ID of the request, unique to the call, as determined by the initiating party.
            var digest = digest_example;  // String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional) 
            var signature = signature_example;  // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional) 
            var tPPSignatureCertificate = tPPSignatureCertificate_example;  // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional) 

            try
            {
                // get status of a consent
                inline_response_200_6 result = apiInstance.getStatusForConsentById(consentId, xRequestID, digest, signature, tPPSignatureCertificate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsentsApi.getStatusForConsentById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiConsentsApi();
$consentId = consentId_example; // String | ID of the corresponding consent object as returned by an Account Information Consent Request
$xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
$digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
$signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
$tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

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

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

my $api_instance = WWW::SwaggerClient::ConsentsApi->new();
my $consentId = consentId_example; # String | ID of the corresponding consent object as returned by an Account Information Consent Request
my $xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | ID of the request, unique to the call, as determined by the initiating party.
my $digest = digest_example; # String | Is contained if and only if the "Signature" element is contained in the header of the request.
my $signature = signature_example; # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
my $tPPSignatureCertificate = tPPSignatureCertificate_example; # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

eval { 
    my $result = $api_instance->getStatusForConsentById(consentId => $consentId, xRequestID => $xRequestID, digest => $digest, signature => $signature, tPPSignatureCertificate => $tPPSignatureCertificate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsentsApi->getStatusForConsentById: $@\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: ApiKeyAuth
swagger_client.configuration.api_key['x-openpsd-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-openpsd-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConsentsApi()
consentId = consentId_example # String | ID of the corresponding consent object as returned by an Account Information Consent Request
xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | ID of the request, unique to the call, as determined by the initiating party.
digest = digest_example # String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
signature = signature_example # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
tPPSignatureCertificate = tPPSignatureCertificate_example # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

try: 
    # get status of a consent
    api_response = api_instance.get_status_for_consent_by_id(consentId, xRequestID, digest=digest, signature=signature, tPPSignatureCertificate=tPPSignatureCertificate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsentsApi->getStatusForConsentById: %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*
UUID (uuid)
ID of the request, unique to the call, as determined by the initiating party.
Required
Digest
String
Is contained if and only if the "Signature" element is contained in the header of the request.
Signature
String
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate
String
The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

Responses

Status: 200 - Transaction status

Name Type Format Description

Status: 400 - Validation error occurred. This code will cover malformed syntax in request or incorrect data in payload.

Status: 401 - The TPP or the PSU is not correctly authorized to perform the request. Retry the request with correct authentication information.

Status: 403 - Returned if the resource that was referenced in the path exists but cannot be accessed by the TPP or the PSU. This code should only be used for non-sensitive id references as it will reveal that the resource exists even though it cannot be accessed.

Status: 404 - Returned if the resource that was referenced in the path does not exist or cannot be referenced by the TPP or the PSU. When in doubt if a specific id in the path is sensitive or not, use the HTTP response code 404 instead of the HTTP response code 403.

Status: 405 - This code is only sent when the HTTP method (PUT, POST, DELETE, GET etc.) is not supported on a specific endpoint. It has nothing to do with the consent, payment or account information data model.

Status: 500 - Internal server error occurred.


updateConsent

update consent

Updates data on the consent resource, authorises a consent within the Embedded SCA Approach where needed.


/consents/{consentId}

Usage and SDK Samples

curl -X PUT -H "x-openpsd-key: [[apiKey]]" "{protocol}://psd2.ccbank.bg/psd2/v1/consents/{consentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsentsApi;

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

public class ConsentsApiExample {

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

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

        ConsentsApi apiInstance = new ConsentsApi();
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 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.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an Account Information Consent Request
         body = ; //  | 
        String pSUID = pSUID_example; // String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
        String pSUIDType = pSUIDType_example; // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
        String pSUCorporateID = pSUCorporateID_example; // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context.
        String pSUCorporateIDType = pSUCorporateIDType_example; // String | Might be mandated in the ASPSPs documentation. Only used in a corporate context.
        String pSUIPPort = pSUIPPort_example; // String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
        String pSUAccept = pSUAccept_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptCharset = pSUAcceptCharset_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptEncoding = pSUAcceptEncoding_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptLanguage = pSUAcceptLanguage_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUUserAgent = pSUUserAgent_example; // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
        String pSUHttpMethod = pSUHttpMethod_example; // String | HTTP method used at the PSU - TPP interface, if available.
        String pSUDeviceID = pSUDeviceID_example; // String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
        String pSUGeoLocation = pSUGeoLocation_example; // String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            apiInstance.updateConsent(xRequestID, pSUIPAddress, consentId, body, pSUID, pSUIDType, pSUCorporateID, pSUCorporateIDType, pSUIPPort, pSUAccept, pSUAcceptCharset, pSUAcceptEncoding, pSUAcceptLanguage, pSUUserAgent, pSUHttpMethod, pSUDeviceID, pSUGeoLocation, digest, signature, tPPSignatureCertificate);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#updateConsent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsentsApi;

public class ConsentsApiExample {

    public static void main(String[] args) {
        ConsentsApi apiInstance = new ConsentsApi();
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 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.
        String consentId = consentId_example; // String | ID of the corresponding consent object as returned by an Account Information Consent Request
         body = ; //  | 
        String pSUID = pSUID_example; // String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
        String pSUIDType = pSUIDType_example; // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
        String pSUCorporateID = pSUCorporateID_example; // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context.
        String pSUCorporateIDType = pSUCorporateIDType_example; // String | Might be mandated in the ASPSPs documentation. Only used in a corporate context.
        String pSUIPPort = pSUIPPort_example; // String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
        String pSUAccept = pSUAccept_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptCharset = pSUAcceptCharset_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptEncoding = pSUAcceptEncoding_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptLanguage = pSUAcceptLanguage_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUUserAgent = pSUUserAgent_example; // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
        String pSUHttpMethod = pSUHttpMethod_example; // String | HTTP method used at the PSU - TPP interface, if available.
        String pSUDeviceID = pSUDeviceID_example; // String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
        String pSUGeoLocation = pSUGeoLocation_example; // String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            apiInstance.updateConsent(xRequestID, pSUIPAddress, consentId, body, pSUID, pSUIDType, pSUCorporateID, pSUCorporateIDType, pSUIPPort, pSUAccept, pSUAcceptCharset, pSUAcceptEncoding, pSUAcceptLanguage, pSUUserAgent, pSUHttpMethod, pSUDeviceID, pSUGeoLocation, digest, signature, tPPSignatureCertificate);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#updateConsent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-openpsd-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-openpsd-key"];
UUID *xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 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.
String *consentId = consentId_example; // ID of the corresponding consent object as returned by an Account Information Consent Request
 *body = ; //  (optional)
String *pSUID = pSUID_example; // Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step. (optional)
String *pSUIDType = pSUIDType_example; // Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. (optional)
String *pSUCorporateID = pSUCorporateID_example; // Might be mandated in the ASPSP's documentation. Only used in a corporate context. (optional)
String *pSUCorporateIDType = pSUCorporateIDType_example; // Might be mandated in the ASPSPs documentation. Only used in a corporate context. (optional)
String *pSUIPPort = pSUIPPort_example; // The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. (optional)
String *pSUAccept = pSUAccept_example; // The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
String *pSUAcceptCharset = pSUAcceptCharset_example; // The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
String *pSUAcceptEncoding = pSUAcceptEncoding_example; // The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
String *pSUAcceptLanguage = pSUAcceptLanguage_example; // The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
String *pSUUserAgent = pSUUserAgent_example; // The forwarded Agent header field of the HTTP request between PSU and TPP, if available. (optional)
String *pSUHttpMethod = pSUHttpMethod_example; // HTTP method used at the PSU - TPP interface, if available. (optional)
String *pSUDeviceID = pSUDeviceID_example; // UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device. (optional)
String *pSUGeoLocation = pSUGeoLocation_example; // The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available. (optional)
String *digest = digest_example; // Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
String *signature = signature_example; // A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
String *tPPSignatureCertificate = tPPSignatureCertificate_example; // The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

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

// update consent
[apiInstance updateConsentWith:xRequestID
    pSUIPAddress:pSUIPAddress
    consentId:consentId
    body:body
    pSUID:pSUID
    pSUIDType:pSUIDType
    pSUCorporateID:pSUCorporateID
    pSUCorporateIDType:pSUCorporateIDType
    pSUIPPort:pSUIPPort
    pSUAccept:pSUAccept
    pSUAcceptCharset:pSUAcceptCharset
    pSUAcceptEncoding:pSUAcceptEncoding
    pSUAcceptLanguage:pSUAcceptLanguage
    pSUUserAgent:pSUUserAgent
    pSUHttpMethod:pSUHttpMethod
    pSUDeviceID:pSUDeviceID
    pSUGeoLocation:pSUGeoLocation
    digest:digest
    signature:signature
    tPPSignatureCertificate:tPPSignatureCertificate
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenPsdNextGenPsd2 = require('open_psd_next_gen_psd2');
var defaultClient = OpenPsdNextGenPsd2.ApiClient.instance;

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

var api = new OpenPsdNextGenPsd2.ConsentsApi()
var xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 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.
var consentId = consentId_example; // {{String}} ID of the corresponding consent object as returned by an Account Information Consent Request
var opts = { 
  'body':  // {{}} 
  'pSUID': pSUID_example // {{String}} Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
  'pSUIDType': pSUIDType_example // {{String}} Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
  'pSUCorporateID': pSUCorporateID_example // {{String}} Might be mandated in the ASPSP's documentation. Only used in a corporate context.
  'pSUCorporateIDType': pSUCorporateIDType_example // {{String}} Might be mandated in the ASPSPs documentation. Only used in a corporate context.
  'pSUIPPort': pSUIPPort_example // {{String}} The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
  'pSUAccept': pSUAccept_example // {{String}} The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
  'pSUAcceptCharset': pSUAcceptCharset_example // {{String}} The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
  'pSUAcceptEncoding': pSUAcceptEncoding_example // {{String}} The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
  'pSUAcceptLanguage': pSUAcceptLanguage_example // {{String}} The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
  'pSUUserAgent': pSUUserAgent_example // {{String}} The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
  'pSUHttpMethod': pSUHttpMethod_example // {{String}} HTTP method used at the PSU - TPP interface, if available.
  'pSUDeviceID': pSUDeviceID_example // {{String}} UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
  'pSUGeoLocation': pSUGeoLocation_example // {{String}} The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
  'digest': digest_example // {{String}} Is contained if and only if the "Signature" element is contained in the header of the request.
  'signature': signature_example // {{String}} A signature of the request by the TPP on application level. This might be mandated by ASPSP.
  'tPPSignatureCertificate': tPPSignatureCertificate_example // {{String}} The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateConsent(xRequestIDpSUIPAddressconsentId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ConsentsApi();
            var xRequestID = new UUID(); // UUID | 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.
            var consentId = consentId_example;  // String | ID of the corresponding consent object as returned by an Account Information Consent Request
            var body = new (); //  |  (optional) 
            var pSUID = pSUID_example;  // String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step. (optional) 
            var pSUIDType = pSUIDType_example;  // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. (optional) 
            var pSUCorporateID = pSUCorporateID_example;  // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context. (optional) 
            var pSUCorporateIDType = pSUCorporateIDType_example;  // String | Might be mandated in the ASPSPs documentation. Only used in a corporate context. (optional) 
            var pSUIPPort = pSUIPPort_example;  // String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. (optional) 
            var pSUAccept = pSUAccept_example;  // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional) 
            var pSUAcceptCharset = pSUAcceptCharset_example;  // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional) 
            var pSUAcceptEncoding = pSUAcceptEncoding_example;  // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional) 
            var pSUAcceptLanguage = pSUAcceptLanguage_example;  // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional) 
            var pSUUserAgent = pSUUserAgent_example;  // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. (optional) 
            var pSUHttpMethod = pSUHttpMethod_example;  // String | HTTP method used at the PSU - TPP interface, if available. (optional) 
            var pSUDeviceID = pSUDeviceID_example;  // String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device. (optional) 
            var pSUGeoLocation = pSUGeoLocation_example;  // String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available. (optional) 
            var digest = digest_example;  // String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional) 
            var signature = signature_example;  // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional) 
            var tPPSignatureCertificate = tPPSignatureCertificate_example;  // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional) 

            try
            {
                // update consent
                apiInstance.updateConsent(xRequestID, pSUIPAddress, consentId, body, pSUID, pSUIDType, pSUCorporateID, pSUCorporateIDType, pSUIPPort, pSUAccept, pSUAcceptCharset, pSUAcceptEncoding, pSUAcceptLanguage, pSUUserAgent, pSUHttpMethod, pSUDeviceID, pSUGeoLocation, digest, signature, tPPSignatureCertificate);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsentsApi.updateConsent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiConsentsApi();
$xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 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.
$consentId = consentId_example; // String | ID of the corresponding consent object as returned by an Account Information Consent Request
$body = ; //  | 
$pSUID = pSUID_example; // String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
$pSUIDType = pSUIDType_example; // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
$pSUCorporateID = pSUCorporateID_example; // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context.
$pSUCorporateIDType = pSUCorporateIDType_example; // String | Might be mandated in the ASPSPs documentation. Only used in a corporate context.
$pSUIPPort = pSUIPPort_example; // String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
$pSUAccept = pSUAccept_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
$pSUAcceptCharset = pSUAcceptCharset_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
$pSUAcceptEncoding = pSUAcceptEncoding_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
$pSUAcceptLanguage = pSUAcceptLanguage_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
$pSUUserAgent = pSUUserAgent_example; // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
$pSUHttpMethod = pSUHttpMethod_example; // String | HTTP method used at the PSU - TPP interface, if available.
$pSUDeviceID = pSUDeviceID_example; // String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
$pSUGeoLocation = pSUGeoLocation_example; // String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
$digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
$signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
$tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

try {
    $api_instance->updateConsent($xRequestID, $pSUIPAddress, $consentId, $body, $pSUID, $pSUIDType, $pSUCorporateID, $pSUCorporateIDType, $pSUIPPort, $pSUAccept, $pSUAcceptCharset, $pSUAcceptEncoding, $pSUAcceptLanguage, $pSUUserAgent, $pSUHttpMethod, $pSUDeviceID, $pSUGeoLocation, $digest, $signature, $tPPSignatureCertificate);
} catch (Exception $e) {
    echo 'Exception when calling ConsentsApi->updateConsent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsentsApi;

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

my $api_instance = WWW::SwaggerClient::ConsentsApi->new();
my $xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 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.
my $consentId = consentId_example; # String | ID of the corresponding consent object as returned by an Account Information Consent Request
my $body = WWW::SwaggerClient::Object::->new(); #  | 
my $pSUID = pSUID_example; # String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
my $pSUIDType = pSUIDType_example; # String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
my $pSUCorporateID = pSUCorporateID_example; # String | Might be mandated in the ASPSP's documentation. Only used in a corporate context.
my $pSUCorporateIDType = pSUCorporateIDType_example; # String | Might be mandated in the ASPSPs documentation. Only used in a corporate context.
my $pSUIPPort = pSUIPPort_example; # String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
my $pSUAccept = pSUAccept_example; # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
my $pSUAcceptCharset = pSUAcceptCharset_example; # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
my $pSUAcceptEncoding = pSUAcceptEncoding_example; # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
my $pSUAcceptLanguage = pSUAcceptLanguage_example; # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
my $pSUUserAgent = pSUUserAgent_example; # String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
my $pSUHttpMethod = pSUHttpMethod_example; # String | HTTP method used at the PSU - TPP interface, if available.
my $pSUDeviceID = pSUDeviceID_example; # String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
my $pSUGeoLocation = pSUGeoLocation_example; # String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
my $digest = digest_example; # String | Is contained if and only if the "Signature" element is contained in the header of the request.
my $signature = signature_example; # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
my $tPPSignatureCertificate = tPPSignatureCertificate_example; # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

eval { 
    $api_instance->updateConsent(xRequestID => $xRequestID, pSUIPAddress => $pSUIPAddress, consentId => $consentId, body => $body, pSUID => $pSUID, pSUIDType => $pSUIDType, pSUCorporateID => $pSUCorporateID, pSUCorporateIDType => $pSUCorporateIDType, pSUIPPort => $pSUIPPort, pSUAccept => $pSUAccept, pSUAcceptCharset => $pSUAcceptCharset, pSUAcceptEncoding => $pSUAcceptEncoding, pSUAcceptLanguage => $pSUAcceptLanguage, pSUUserAgent => $pSUUserAgent, pSUHttpMethod => $pSUHttpMethod, pSUDeviceID => $pSUDeviceID, pSUGeoLocation => $pSUGeoLocation, digest => $digest, signature => $signature, tPPSignatureCertificate => $tPPSignatureCertificate);
};
if ($@) {
    warn "Exception when calling ConsentsApi->updateConsent: $@\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: ApiKeyAuth
swagger_client.configuration.api_key['x-openpsd-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-openpsd-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ConsentsApi()
xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 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.
consentId = consentId_example # String | ID of the corresponding consent object as returned by an Account Information Consent Request
body =  #  |  (optional)
pSUID = pSUID_example # String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step. (optional)
pSUIDType = pSUIDType_example # String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. (optional)
pSUCorporateID = pSUCorporateID_example # String | Might be mandated in the ASPSP's documentation. Only used in a corporate context. (optional)
pSUCorporateIDType = pSUCorporateIDType_example # String | Might be mandated in the ASPSPs documentation. Only used in a corporate context. (optional)
pSUIPPort = pSUIPPort_example # String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. (optional)
pSUAccept = pSUAccept_example # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
pSUAcceptCharset = pSUAcceptCharset_example # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
pSUAcceptEncoding = pSUAcceptEncoding_example # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
pSUAcceptLanguage = pSUAcceptLanguage_example # String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
pSUUserAgent = pSUUserAgent_example # String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. (optional)
pSUHttpMethod = pSUHttpMethod_example # String | HTTP method used at the PSU - TPP interface, if available. (optional)
pSUDeviceID = pSUDeviceID_example # String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device. (optional)
pSUGeoLocation = pSUGeoLocation_example # String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available. (optional)
digest = digest_example # String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
signature = signature_example # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
tPPSignatureCertificate = tPPSignatureCertificate_example # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

try: 
    # update consent
    api_instance.update_consent(xRequestID, pSUIPAddress, consentId, body=body, pSUID=pSUID, pSUIDType=pSUIDType, pSUCorporateID=pSUCorporateID, pSUCorporateIDType=pSUCorporateIDType, pSUIPPort=pSUIPPort, pSUAccept=pSUAccept, pSUAcceptCharset=pSUAcceptCharset, pSUAcceptEncoding=pSUAcceptEncoding, pSUAcceptLanguage=pSUAcceptLanguage, pSUUserAgent=pSUUserAgent, pSUHttpMethod=pSUHttpMethod, pSUDeviceID=pSUDeviceID, pSUGeoLocation=pSUGeoLocation, digest=digest, signature=signature, tPPSignatureCertificate=tPPSignatureCertificate)
except ApiException as e:
    print("Exception when calling ConsentsApi->updateConsent: %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*
UUID (uuid)
ID of the request, unique to the call, as determined by the initiating party.
Required
PSU-ID
String
Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
PSU-ID-Type
String
Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
PSU-Corporate-ID
String
Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type
String
Might be mandated in the ASPSPs documentation. Only used in a corporate context.
PSU-IP-Address*
String
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP.
Required
PSU-IP-Port
String
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept
String
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset
String
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding
String
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language
String
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent
String
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method
String
HTTP method used at the PSU - TPP interface, if available.
PSU-Device-ID
String
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
PSU-Geo-Location
String
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
Digest
String
Is contained if and only if the "Signature" element is contained in the header of the request.
Signature
String
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate
String
The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
Body parameters
Name Description
body

Responses

Status: 201 - Created

Name Type Format Description

Status: 400 - Validation error occurred. This code will cover malformed syntax in request or incorrect data in payload.

Status: 401 - The TPP or the PSU is not correctly authorized to perform the request. Retry the request with correct authentication information.

Status: 403 - Returned if the resource that was referenced in the path exists but cannot be accessed by the TPP or the PSU. This code should only be used for non-sensitive id references as it will reveal that the resource exists even though it cannot be accessed.

Status: 404 - Returned if the resource that was referenced in the path does not exist or cannot be referenced by the TPP or the PSU. When in doubt if a specific id in the path is sensitive or not, use the HTTP response code 404 instead of the HTTP response code 403.

Status: 405 - This code is only sent when the HTTP method (PUT, POST, DELETE, GET etc.) is not supported on a specific endpoint. It has nothing to do with the consent, payment or account information data model.

Status: 500 - Internal server error occurred.


Funds

createFundsConfirmationRequest

check funds

Checks whether funds are available for a payment transaction on an account linked with a given tuple cardissuer/cardnumber, or an IBAN and TPP respectively


/funds-confirmations

Usage and SDK Samples

curl -X POST -H "x-openpsd-key: [[apiKey]]" "{protocol}://psd2.ccbank.bg/psd2/v1/funds-confirmations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FundsApi;

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

public class FundsApiExample {

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

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

        FundsApi apiInstance = new FundsApi();
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        Body body = ; // Body | 
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200_8 result = apiInstance.createFundsConfirmationRequest(xRequestID, body, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FundsApi#createFundsConfirmationRequest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FundsApi;

public class FundsApiExample {

    public static void main(String[] args) {
        FundsApi apiInstance = new FundsApi();
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
        Body body = ; // Body | 
        String digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_200_8 result = apiInstance.createFundsConfirmationRequest(xRequestID, body, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FundsApi#createFundsConfirmationRequest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-openpsd-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-openpsd-key"];
UUID *xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // ID of the request, unique to the call, as determined by the initiating party.
Body *body = ; //  (optional)
String *digest = digest_example; // Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
String *signature = signature_example; // A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
String *tPPSignatureCertificate = tPPSignatureCertificate_example; // The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

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

// check funds
[apiInstance createFundsConfirmationRequestWith:xRequestID
    body:body
    digest:digest
    signature:signature
    tPPSignatureCertificate:tPPSignatureCertificate
              completionHandler: ^(inline_response_200_8 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenPsdNextGenPsd2 = require('open_psd_next_gen_psd2');
var defaultClient = OpenPsdNextGenPsd2.ApiClient.instance;

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

var api = new OpenPsdNextGenPsd2.FundsApi()
var xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} ID of the request, unique to the call, as determined by the initiating party.
var opts = { 
  'body':  // {{Body}} 
  'digest': digest_example // {{String}} Is contained if and only if the "Signature" element is contained in the header of the request.
  'signature': signature_example // {{String}} A signature of the request by the TPP on application level. This might be mandated by ASPSP.
  'tPPSignatureCertificate': tPPSignatureCertificate_example // {{String}} The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFundsConfirmationRequest(xRequestID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new FundsApi();
            var xRequestID = new UUID(); // UUID | ID of the request, unique to the call, as determined by the initiating party.
            var body = new Body(); // Body |  (optional) 
            var digest = digest_example;  // String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional) 
            var signature = signature_example;  // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional) 
            var tPPSignatureCertificate = tPPSignatureCertificate_example;  // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional) 

            try
            {
                // check funds
                inline_response_200_8 result = apiInstance.createFundsConfirmationRequest(xRequestID, body, digest, signature, tPPSignatureCertificate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FundsApi.createFundsConfirmationRequest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiFundsApi();
$xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | ID of the request, unique to the call, as determined by the initiating party.
$body = ; // Body | 
$digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
$signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
$tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

try {
    $result = $api_instance->createFundsConfirmationRequest($xRequestID, $body, $digest, $signature, $tPPSignatureCertificate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FundsApi->createFundsConfirmationRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FundsApi;

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

my $api_instance = WWW::SwaggerClient::FundsApi->new();
my $xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | ID of the request, unique to the call, as determined by the initiating party.
my $body = WWW::SwaggerClient::Object::Body->new(); # Body | 
my $digest = digest_example; # String | Is contained if and only if the "Signature" element is contained in the header of the request.
my $signature = signature_example; # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
my $tPPSignatureCertificate = tPPSignatureCertificate_example; # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.

eval { 
    my $result = $api_instance->createFundsConfirmationRequest(xRequestID => $xRequestID, body => $body, digest => $digest, signature => $signature, tPPSignatureCertificate => $tPPSignatureCertificate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FundsApi->createFundsConfirmationRequest: $@\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: ApiKeyAuth
swagger_client.configuration.api_key['x-openpsd-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-openpsd-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FundsApi()
xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | ID of the request, unique to the call, as determined by the initiating party.
body =  # Body |  (optional)
digest = digest_example # String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
signature = signature_example # String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
tPPSignatureCertificate = tPPSignatureCertificate_example # String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

try: 
    # check funds
    api_response = api_instance.create_funds_confirmation_request(xRequestID, body=body, digest=digest, signature=signature, tPPSignatureCertificate=tPPSignatureCertificate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FundsApi->createFundsConfirmationRequest: %s\n" % e)

Parameters

Header parameters
Name Description
X-Request-ID*
UUID (uuid)
ID of the request, unique to the call, as determined by the initiating party.
Required
Digest
String
Is contained if and only if the "Signature" element is contained in the header of the request.
Signature
String
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate
String
The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
Body parameters
Name Description
body

Responses

Status: 200 - OK

Name Type Format Description

Status: 400 - Validation error occurred. This code will cover malformed syntax in request or incorrect data in payload.

Status: 401 - The TPP or the PSU is not correctly authorized to perform the request. Retry the request with correct authentication information.

Status: 403 - Returned if the resource that was referenced in the path exists but cannot be accessed by the TPP or the PSU. This code should only be used for non-sensitive id references as it will reveal that the resource exists even though it cannot be accessed.

Status: 404 - Returned if the resource that was referenced in the path does not exist or cannot be referenced by the TPP or the PSU. When in doubt if a specific id in the path is sensitive or not, use the HTTP response code 404 instead of the HTTP response code 403.

Status: 405 - This code is only sent when the HTTP method (PUT, POST, DELETE, GET etc.) is not supported on a specific endpoint. It has nothing to do with the consent, payment or account information data model.

Status: 500 - Internal server error occurred.


Payments

createPaymentBGDomestic

creates a Bulgarian domestic transfers payment

Creates a payment initiation resource addressable under {paymentId} with all data relevant for the corresponding payment product. This is the first step in the API to initiate the related payment.


/{payment-service}/bg-domestic-transfers

Usage and SDK Samples

curl -X POST -H "x-openpsd-key: [[apiKey]]" "{protocol}://psd2.ccbank.bg/psd2/v1/{payment-service}/bg-domestic-transfers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentsApi;

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

public class PaymentsApiExample {

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

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

        PaymentsApi apiInstance = new PaymentsApi();
        BgDomesticTransfers body = ; // BgDomesticTransfers | 
        String contentType = contentType_example; // String | Content-Type
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 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.
        String consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
        String paymentService = paymentService_example; // String | The payment service to use.
        String pSUID = pSUID_example; // String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
        String pSUIDType = pSUIDType_example; // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
        String pSUCorporateID = pSUCorporateID_example; // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context.
        String pSUCorporateIDType = pSUCorporateIDType_example; // String | Might be mandated in the ASPSPs documentation. Only used in a corporate context.
        String pSUIPPort = pSUIPPort_example; // String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
        String pSUAccept = pSUAccept_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptCharset = pSUAcceptCharset_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptEncoding = pSUAcceptEncoding_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptLanguage = pSUAcceptLanguage_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUUserAgent = pSUUserAgent_example; // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
        String pSUHttpMethod = pSUHttpMethod_example; // String | HTTP method used at the PSU - TPP interface, if available.
        String pSUDeviceID = pSUDeviceID_example; // String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
        String pSUGeoLocation = pSUGeoLocation_example; // String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        Boolean tPPRedirectPreferred = true; // Boolean | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU.
        String tPPRedirectURI = tPPRedirectURI_example; // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach.
        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 digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_201 result = apiInstance.createPaymentBGDomestic(body, contentType, xRequestID, pSUIPAddress, consentID, paymentService, pSUID, pSUIDType, pSUCorporateID, pSUCorporateIDType, pSUIPPort, pSUAccept, pSUAcceptCharset, pSUAcceptEncoding, pSUAcceptLanguage, pSUUserAgent, pSUHttpMethod, pSUDeviceID, pSUGeoLocation, authorization, tPPRedirectPreferred, tPPRedirectURI, tPPNokRedirectURI, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#createPaymentBGDomestic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentsApi;

public class PaymentsApiExample {

    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        BgDomesticTransfers body = ; // BgDomesticTransfers | 
        String contentType = contentType_example; // String | Content-Type
        UUID xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 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.
        String consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
        String paymentService = paymentService_example; // String | The payment service to use.
        String pSUID = pSUID_example; // String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
        String pSUIDType = pSUIDType_example; // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
        String pSUCorporateID = pSUCorporateID_example; // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context.
        String pSUCorporateIDType = pSUCorporateIDType_example; // String | Might be mandated in the ASPSPs documentation. Only used in a corporate context.
        String pSUIPPort = pSUIPPort_example; // String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
        String pSUAccept = pSUAccept_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptCharset = pSUAcceptCharset_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptEncoding = pSUAcceptEncoding_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUAcceptLanguage = pSUAcceptLanguage_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
        String pSUUserAgent = pSUUserAgent_example; // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
        String pSUHttpMethod = pSUHttpMethod_example; // String | HTTP method used at the PSU - TPP interface, if available.
        String pSUDeviceID = pSUDeviceID_example; // String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
        String pSUGeoLocation = pSUGeoLocation_example; // String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
        String authorization = authorization_example; // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
        Boolean tPPRedirectPreferred = true; // Boolean | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU.
        String tPPRedirectURI = tPPRedirectURI_example; // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach.
        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 digest = digest_example; // String | Is contained if and only if the "Signature" element is contained in the header of the request.
        String signature = signature_example; // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP.
        String tPPSignatureCertificate = tPPSignatureCertificate_example; // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
        try {
            inline_response_201 result = apiInstance.createPaymentBGDomestic(body, contentType, xRequestID, pSUIPAddress, consentID, paymentService, pSUID, pSUIDType, pSUCorporateID, pSUCorporateIDType, pSUIPPort, pSUAccept, pSUAcceptCharset, pSUAcceptEncoding, pSUAcceptLanguage, pSUUserAgent, pSUHttpMethod, pSUDeviceID, pSUGeoLocation, authorization, tPPRedirectPreferred, tPPRedirectURI, tPPNokRedirectURI, digest, signature, tPPSignatureCertificate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#createPaymentBGDomestic");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-openpsd-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-openpsd-key"];
BgDomesticTransfers *body = ; // 
String *contentType = contentType_example; // Content-Type
UUID *xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 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.
String *consentID = consentID_example; // Shall be contained since "Establish Consent Transaction" was performed via this API before.
String *paymentService = paymentService_example; // The payment service to use.
String *pSUID = pSUID_example; // Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step. (optional)
String *pSUIDType = pSUIDType_example; // Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. (optional)
String *pSUCorporateID = pSUCorporateID_example; // Might be mandated in the ASPSP's documentation. Only used in a corporate context. (optional)
String *pSUCorporateIDType = pSUCorporateIDType_example; // Might be mandated in the ASPSPs documentation. Only used in a corporate context. (optional)
String *pSUIPPort = pSUIPPort_example; // The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. (optional)
String *pSUAccept = pSUAccept_example; // The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
String *pSUAcceptCharset = pSUAcceptCharset_example; // The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
String *pSUAcceptEncoding = pSUAcceptEncoding_example; // The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
String *pSUAcceptLanguage = pSUAcceptLanguage_example; // The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional)
String *pSUUserAgent = pSUUserAgent_example; // The forwarded Agent header field of the HTTP request between PSU and TPP, if available. (optional)
String *pSUHttpMethod = pSUHttpMethod_example; // HTTP method used at the PSU - TPP interface, if available. (optional)
String *pSUDeviceID = pSUDeviceID_example; // UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device. (optional)
String *pSUGeoLocation = pSUGeoLocation_example; // The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available. (optional)
String *authorization = authorization_example; // Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional)
Boolean *tPPRedirectPreferred = true; // If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU. (optional)
String *tPPRedirectURI = tPPRedirectURI_example; // URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach. (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 *digest = digest_example; // Is contained if and only if the "Signature" element is contained in the header of the request. (optional)
String *signature = signature_example; // A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional)
String *tPPSignatureCertificate = tPPSignatureCertificate_example; // The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional)

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

// creates a Bulgarian domestic transfers payment
[apiInstance createPaymentBGDomesticWith:body
    contentType:contentType
    xRequestID:xRequestID
    pSUIPAddress:pSUIPAddress
    consentID:consentID
    paymentService:paymentService
    pSUID:pSUID
    pSUIDType:pSUIDType
    pSUCorporateID:pSUCorporateID
    pSUCorporateIDType:pSUCorporateIDType
    pSUIPPort:pSUIPPort
    pSUAccept:pSUAccept
    pSUAcceptCharset:pSUAcceptCharset
    pSUAcceptEncoding:pSUAcceptEncoding
    pSUAcceptLanguage:pSUAcceptLanguage
    pSUUserAgent:pSUUserAgent
    pSUHttpMethod:pSUHttpMethod
    pSUDeviceID:pSUDeviceID
    pSUGeoLocation:pSUGeoLocation
    authorization:authorization
    tPPRedirectPreferred:tPPRedirectPreferred
    tPPRedirectURI:tPPRedirectURI
    tPPNokRedirectURI:tPPNokRedirectURI
    digest:digest
    signature:signature
    tPPSignatureCertificate:tPPSignatureCertificate
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenPsdNextGenPsd2 = require('open_psd_next_gen_psd2');
var defaultClient = OpenPsdNextGenPsd2.ApiClient.instance;

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

var api = new OpenPsdNextGenPsd2.PaymentsApi()
var body = ; // {{BgDomesticTransfers}} 
var contentType = contentType_example; // {{String}} Content-Type
var xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 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.
var consentID = consentID_example; // {{String}} Shall be contained since "Establish Consent Transaction" was performed via this API before.
var paymentService = paymentService_example; // {{String}} The payment service to use.
var opts = { 
  'pSUID': pSUID_example // {{String}} Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
  'pSUIDType': pSUIDType_example // {{String}} Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
  'pSUCorporateID': pSUCorporateID_example // {{String}} Might be mandated in the ASPSP's documentation. Only used in a corporate context.
  'pSUCorporateIDType': pSUCorporateIDType_example // {{String}} Might be mandated in the ASPSPs documentation. Only used in a corporate context.
  'pSUIPPort': pSUIPPort_example // {{String}} The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
  'pSUAccept': pSUAccept_example // {{String}} The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
  'pSUAcceptCharset': pSUAcceptCharset_example // {{String}} The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
  'pSUAcceptEncoding': pSUAcceptEncoding_example // {{String}} The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
  'pSUAcceptLanguage': pSUAcceptLanguage_example // {{String}} The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
  'pSUUserAgent': pSUUserAgent_example // {{String}} The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
  'pSUHttpMethod': pSUHttpMethod_example // {{String}} HTTP method used at the PSU - TPP interface, if available.
  'pSUDeviceID': pSUDeviceID_example // {{String}} UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
  'pSUGeoLocation': pSUGeoLocation_example // {{String}} The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
  'authorization': authorization_example // {{String}} Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
  'tPPRedirectPreferred': true // {{Boolean}} If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU.
  'tPPRedirectURI': tPPRedirectURI_example // {{String}} URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach.
  '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.
  'digest': digest_example // {{String}} Is contained if and only if the "Signature" element is contained in the header of the request.
  'signature': signature_example // {{String}} A signature of the request by the TPP on application level. This might be mandated by ASPSP.
  'tPPSignatureCertificate': tPPSignatureCertificate_example // {{String}} The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPaymentBGDomestic(bodycontentTypexRequestIDpSUIPAddressconsentIDpaymentService, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new PaymentsApi();
            var body = new BgDomesticTransfers(); // BgDomesticTransfers | 
            var contentType = contentType_example;  // String | Content-Type
            var xRequestID = new UUID(); // UUID | 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.
            var consentID = consentID_example;  // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
            var paymentService = paymentService_example;  // String | The payment service to use.
            var pSUID = pSUID_example;  // String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step. (optional) 
            var pSUIDType = pSUIDType_example;  // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. (optional) 
            var pSUCorporateID = pSUCorporateID_example;  // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context. (optional) 
            var pSUCorporateIDType = pSUCorporateIDType_example;  // String | Might be mandated in the ASPSPs documentation. Only used in a corporate context. (optional) 
            var pSUIPPort = pSUIPPort_example;  // String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. (optional) 
            var pSUAccept = pSUAccept_example;  // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional) 
            var pSUAcceptCharset = pSUAcceptCharset_example;  // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional) 
            var pSUAcceptEncoding = pSUAcceptEncoding_example;  // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional) 
            var pSUAcceptLanguage = pSUAcceptLanguage_example;  // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. (optional) 
            var pSUUserAgent = pSUUserAgent_example;  // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. (optional) 
            var pSUHttpMethod = pSUHttpMethod_example;  // String | HTTP method used at the PSU - TPP interface, if available. (optional) 
            var pSUDeviceID = pSUDeviceID_example;  // String | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device. (optional) 
            var pSUGeoLocation = pSUGeoLocation_example;  // String | The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available. (optional) 
            var authorization = authorization_example;  // String | Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation. (optional) 
            var tPPRedirectPreferred = true;  // Boolean | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled 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 SCA method chosen by the TPP/PSU. (optional) 
            var tPPRedirectURI = tPPRedirectURI_example;  // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for the SCA OAuth Approach. (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 digest = digest_example;  // String | Is contained if and only if the "Signature" element is contained in the header of the request. (optional) 
            var signature = signature_example;  // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. (optional) 
            var tPPSignatureCertificate = tPPSignatureCertificate_example;  // String | The certificate used for signing the request, in base64 encoding. It shall be contained if a signature is used, see above. (optional) 

            try
            {
                // creates a Bulgarian domestic transfers payment
                inline_response_201 result = apiInstance.createPaymentBGDomestic(body, contentType, xRequestID, pSUIPAddress, consentID, paymentService, pSUID, pSUIDType, pSUCorporateID, pSUCorporateIDType, pSUIPPort, pSUAccept, pSUAcceptCharset, pSUAcceptEncoding, pSUAcceptLanguage, pSUUserAgent, pSUHttpMethod, pSUDeviceID, pSUGeoLocation, authorization, tPPRedirectPreferred, tPPRedirectURI, tPPNokRedirectURI, digest, signature, tPPSignatureCertificate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentsApi.createPaymentBGDomestic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPaymentsApi();
$body = ; // BgDomesticTransfers | 
$contentType = contentType_example; // String | Content-Type
$xRequestID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 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.
$consentID = consentID_example; // String | Shall be contained since "Establish Consent Transaction" was performed via this API before.
$paymentService = paymentService_example; // String | The payment service to use.
$pSUID = pSUID_example; // String | Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
$pSUIDType = pSUIDType_example; // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
$pSUCorporateID = pSUCorporateID_example; // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context.
$pSUCorporateIDType = pSUCorporateIDType_example; // String | Might be mandated in the ASPSPs documentation. Only used in a corporate context.
$pSUIPPort = pSUIPPort_example; // String | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
$pSUAccept = pSUAccept_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
$pSUAcceptCharset = pSUAcceptCharset_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
$pSUAcceptEncoding = pSUAcceptEncoding_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
$pSUAcceptLanguage = pSUAcceptLanguage_example; // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
$pSUUserAgent = pSUUserAgent_example; // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
$pSUHttpMethod = pSUHttpMethod_example; // String | HTTP method used at the PSU - TPP interface, if available.
$pSUDeviceID = pSUDeviceID_example; // String | UUID (Universally Uniqu