Account and Transaction API Specification
API and SDK Documentation
AccountAccess
Usage and SDK Samples
curl -X POST "https://localhost/open-banking/v3.1/aisp/account-access-consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountAccessApi;
import java.io.File;
import java.util.*;
public class AccountAccessApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: TPPOAuth2Security
OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
AccountAccessApi apiInstance = new AccountAccessApi();
OBReadConsent1 oBReadConsent1Param = ; // OBReadConsent1 | Default
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadConsentResponse1 result = apiInstance.createAccountAccessConsents(oBReadConsent1Param, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccountAccessApi#createAccountAccessConsents");
e.printStackTrace();
}
}
}
import io.swagger.client.api.AccountAccessApi;
public class AccountAccessApiExample {
public static void main(String[] args) {
AccountAccessApi apiInstance = new AccountAccessApi();
OBReadConsent1 oBReadConsent1Param = ; // OBReadConsent1 | Default
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadConsentResponse1 result = apiInstance.createAccountAccessConsents(oBReadConsent1Param, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccountAccessApi#createAccountAccessConsents");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBReadConsent1 *oBReadConsent1Param = ; // Default
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
AccountAccessApi *apiInstance = [[AccountAccessApi alloc] init];
// Create Account Access Consents
[apiInstance createAccountAccessConsentsWith:oBReadConsent1Param
xFapiFinancialId:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadConsentResponse1 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.AccountAccessApi()
var oBReadConsent1Param = ; // {OBReadConsent1} Default
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createAccountAccessConsents(oBReadConsent1Param, xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class createAccountAccessConsentsExample
{
public void main()
{
// Configure OAuth2 access token for authorization: TPPOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AccountAccessApi();
var oBReadConsent1Param = new OBReadConsent1(); // OBReadConsent1 | Default
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Create Account Access Consents
OBReadConsentResponse1 result = apiInstance.createAccountAccessConsents(oBReadConsent1Param, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountAccessApi.createAccountAccessConsents: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\AccountAccessApi();
$oBReadConsent1Param = ; // OBReadConsent1 | Default
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->createAccountAccessConsents($oBReadConsent1Param, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountAccessApi->createAccountAccessConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAccessApi;
# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::AccountAccessApi->new();
my $oBReadConsent1Param = WWW::SwaggerClient::Object::OBReadConsent1->new(); # OBReadConsent1 | Default
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->createAccountAccessConsents(oBReadConsent1Param => $oBReadConsent1Param, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
print Dumper($result);
};
if ($@) {
warn "Exception when calling AccountAccessApi->createAccountAccessConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountAccessApi()
oBReadConsent1Param = # OBReadConsent1 | Default
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Create Account Access Consents
api_response = api_instance.create_account_access_consents(oBReadConsent1Param, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountAccessApi->createAccountAccessConsents: %s\n" % e)
Parameters
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Name | Description |
---|---|
oBReadConsent1Param * |
Responses
Status: 201 - Account Access Consents Created
Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
ReadAccountsBasic
, ReadAccountsDetail
, ReadBalances
, ReadBeneficiariesBasic
, ReadBeneficiariesDetail
, ReadDirectDebits
, ReadOffers
, ReadPAN
, ReadParty
, ReadPartyPSU
, ReadProducts
, ReadScheduledPaymentsBasic
, ReadScheduledPaymentsDetail
, ReadStandingOrdersBasic
, ReadStandingOrdersDetail
, ReadStatementsBasic
, ReadStatementsDetail
, ReadTransactionsBasic
, ReadTransactionsCredits
, ReadTransactionsDebits
, ReadTransactionsDetail
Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not found
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 415 - Unsupported Media Type
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
Usage and SDK Samples
curl -X DELETE "https://localhost/open-banking/v3.1/aisp/account-access-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountAccessApi;
import java.io.File;
import java.util.*;
public class AccountAccessApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: TPPOAuth2Security
OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
AccountAccessApi apiInstance = new AccountAccessApi();
String consentId = consentId_example; // String | ConsentId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
apiInstance.deleteAccountAccessConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
} catch (ApiException e) {
System.err.println("Exception when calling AccountAccessApi#deleteAccountAccessConsentsConsentId");
e.printStackTrace();
}
}
}
import io.swagger.client.api.AccountAccessApi;
public class AccountAccessApiExample {
public static void main(String[] args) {
AccountAccessApi apiInstance = new AccountAccessApi();
String consentId = consentId_example; // String | ConsentId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
apiInstance.deleteAccountAccessConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
} catch (ApiException e) {
System.err.println("Exception when calling AccountAccessApi#deleteAccountAccessConsentsConsentId");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
AccountAccessApi *apiInstance = [[AccountAccessApi alloc] init];
// Delete Account Access Consents
[apiInstance deleteAccountAccessConsentsConsentIdWith:consentId
xFapiFinancialId:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.AccountAccessApi()
var consentId = consentId_example; // {String} ConsentId
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.deleteAccountAccessConsentsConsentId(consentId, xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class deleteAccountAccessConsentsConsentIdExample
{
public void main()
{
// Configure OAuth2 access token for authorization: TPPOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AccountAccessApi();
var consentId = consentId_example; // String | ConsentId
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Delete Account Access Consents
apiInstance.deleteAccountAccessConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountAccessApi.deleteAccountAccessConsentsConsentId: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\AccountAccessApi();
$consentId = consentId_example; // String | ConsentId
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$api_instance->deleteAccountAccessConsentsConsentId($consentId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
} catch (Exception $e) {
echo 'Exception when calling AccountAccessApi->deleteAccountAccessConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAccessApi;
# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::AccountAccessApi->new();
my $consentId = consentId_example; # String | ConsentId
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
$api_instance->deleteAccountAccessConsentsConsentId(consentId => $consentId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
};
if ($@) {
warn "Exception when calling AccountAccessApi->deleteAccountAccessConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountAccessApi()
consentId = consentId_example # String | ConsentId
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Delete Account Access Consents
api_instance.delete_account_access_consents_consent_id(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
except ApiException as e:
print("Exception when calling AccountAccessApi->deleteAccountAccessConsentsConsentId: %s\n" % e)
Parameters
Name | Description |
---|---|
ConsentId* |
String
ConsentId
Required
|
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Responses
Status: 204 - Account Access Consents Deleted
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not found
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
Usage and SDK Samples
curl -X GET "https://localhost/open-banking/v3.1/aisp/account-access-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountAccessApi;
import java.io.File;
import java.util.*;
public class AccountAccessApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: TPPOAuth2Security
OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
AccountAccessApi apiInstance = new AccountAccessApi();
String consentId = consentId_example; // String | ConsentId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadConsentResponse1 result = apiInstance.getAccountAccessConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccountAccessApi#getAccountAccessConsentsConsentId");
e.printStackTrace();
}
}
}
import io.swagger.client.api.AccountAccessApi;
public class AccountAccessApiExample {
public static void main(String[] args) {
AccountAccessApi apiInstance = new AccountAccessApi();
String consentId = consentId_example; // String | ConsentId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadConsentResponse1 result = apiInstance.getAccountAccessConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccountAccessApi#getAccountAccessConsentsConsentId");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
AccountAccessApi *apiInstance = [[AccountAccessApi alloc] init];
// Get Account Access Consents
[apiInstance getAccountAccessConsentsConsentIdWith:consentId
xFapiFinancialId:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadConsentResponse1 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.AccountAccessApi()
var consentId = consentId_example; // {String} ConsentId
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAccountAccessConsentsConsentId(consentId, xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAccountAccessConsentsConsentIdExample
{
public void main()
{
// Configure OAuth2 access token for authorization: TPPOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AccountAccessApi();
var consentId = consentId_example; // String | ConsentId
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Get Account Access Consents
OBReadConsentResponse1 result = apiInstance.getAccountAccessConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountAccessApi.getAccountAccessConsentsConsentId: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\AccountAccessApi();
$consentId = consentId_example; // String | ConsentId
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->getAccountAccessConsentsConsentId($consentId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountAccessApi->getAccountAccessConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAccessApi;
# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::AccountAccessApi->new();
my $consentId = consentId_example; # String | ConsentId
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->getAccountAccessConsentsConsentId(consentId => $consentId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
print Dumper($result);
};
if ($@) {
warn "Exception when calling AccountAccessApi->getAccountAccessConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountAccessApi()
consentId = consentId_example # String | ConsentId
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Get Account Access Consents
api_response = api_instance.get_account_access_consents_consent_id(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountAccessApi->getAccountAccessConsentsConsentId: %s\n" % e)
Parameters
Name | Description |
---|---|
ConsentId* |
String
ConsentId
Required
|
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Responses
Status: 200 - Account Access Consents Read
Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
ReadAccountsBasic
, ReadAccountsDetail
, ReadBalances
, ReadBeneficiariesBasic
, ReadBeneficiariesDetail
, ReadDirectDebits
, ReadOffers
, ReadPAN
, ReadParty
, ReadPartyPSU
, ReadProducts
, ReadScheduledPaymentsBasic
, ReadScheduledPaymentsDetail
, ReadStandingOrdersBasic
, ReadStandingOrdersDetail
, ReadStatementsBasic
, ReadStatementsDetail
, ReadTransactionsBasic
, ReadTransactionsCredits
, ReadTransactionsDebits
, ReadTransactionsDetail
Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not found
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
Accounts
Usage and SDK Samples
curl -X GET "https://localhost/open-banking/v3.1/aisp/accounts"
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 OAuth2 access token for authorization: PSUOAuth2Security
OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
AccountsApi apiInstance = new AccountsApi();
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadAccount3 result = apiInstance.getAccounts(xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
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();
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadAccount3 result = apiInstance.getAccounts(xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccountsApi#getAccounts");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
AccountsApi *apiInstance = [[AccountsApi alloc] init];
// Get Accounts
[apiInstance getAccountsWith:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadAccount3 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.AccountsApi()
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAccounts(xFapiFinancialId, authorization, 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 OAuth2 access token for authorization: PSUOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AccountsApi();
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Get Accounts
OBReadAccount3 result = apiInstance.getAccounts(xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountsApi.getAccounts: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\AccountsApi();
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->getAccounts($xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
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 OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->getAccounts(xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
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 OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi()
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Get Accounts
api_response = api_instance.get_accounts(xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->getAccounts: %s\n" % e)
Parameters
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Responses
Status: 200 - Accounts Read
Unambiguous identification of the account to which credit and debit entries are made.
Unambiguous identification of the account to which credit and debit entries are made.
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not found
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
Usage and SDK Samples
curl -X GET "https://localhost/open-banking/v3.1/aisp/accounts/{AccountId}"
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 OAuth2 access token for authorization: PSUOAuth2Security
OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
AccountsApi apiInstance = new AccountsApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadAccount3 result = apiInstance.getAccountsAccountId(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccountsApi#getAccountsAccountId");
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 | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadAccount3 result = apiInstance.getAccountsAccountId(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccountsApi#getAccountsAccountId");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
AccountsApi *apiInstance = [[AccountsApi alloc] init];
// Get Accounts
[apiInstance getAccountsAccountIdWith:accountId
xFapiFinancialId:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadAccount3 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.AccountsApi()
var accountId = accountId_example; // {String} AccountId
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAccountsAccountId(accountId, xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAccountsAccountIdExample
{
public void main()
{
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AccountsApi();
var accountId = accountId_example; // String | AccountId
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Get Accounts
OBReadAccount3 result = apiInstance.getAccountsAccountId(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountsApi.getAccountsAccountId: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\AccountsApi();
$accountId = accountId_example; // String | AccountId
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->getAccountsAccountId($accountId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountsApi->getAccountsAccountId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;
# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $accountId = accountId_example; # String | AccountId
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->getAccountsAccountId(accountId => $accountId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
print Dumper($result);
};
if ($@) {
warn "Exception when calling AccountsApi->getAccountsAccountId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi()
accountId = accountId_example # String | AccountId
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Get Accounts
api_response = api_instance.get_accounts_account_id(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->getAccountsAccountId: %s\n" % e)
Parameters
Name | Description |
---|---|
AccountId* |
String
AccountId
Required
|
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Responses
Status: 200 - Accounts Read
Unambiguous identification of the account to which credit and debit entries are made.
Unambiguous identification of the account to which credit and debit entries are made.
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
Balances
Usage and SDK Samples
curl -X GET "https://localhost/open-banking/v3.1/aisp/accounts/{AccountId}/balances"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BalancesApi;
import java.io.File;
import java.util.*;
public class BalancesApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: PSUOAuth2Security
OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
BalancesApi apiInstance = new BalancesApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadBalance1 result = apiInstance.getAccountsAccountIdBalances(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BalancesApi#getAccountsAccountIdBalances");
e.printStackTrace();
}
}
}
import io.swagger.client.api.BalancesApi;
public class BalancesApiExample {
public static void main(String[] args) {
BalancesApi apiInstance = new BalancesApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadBalance1 result = apiInstance.getAccountsAccountIdBalances(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BalancesApi#getAccountsAccountIdBalances");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
BalancesApi *apiInstance = [[BalancesApi alloc] init];
// Get Balances
[apiInstance getAccountsAccountIdBalancesWith:accountId
xFapiFinancialId:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadBalance1 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.BalancesApi()
var accountId = accountId_example; // {String} AccountId
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAccountsAccountIdBalances(accountId, xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAccountsAccountIdBalancesExample
{
public void main()
{
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new BalancesApi();
var accountId = accountId_example; // String | AccountId
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Get Balances
OBReadBalance1 result = apiInstance.getAccountsAccountIdBalances(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling BalancesApi.getAccountsAccountIdBalances: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\BalancesApi();
$accountId = accountId_example; // String | AccountId
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->getAccountsAccountIdBalances($accountId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BalancesApi->getAccountsAccountIdBalances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BalancesApi;
# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::BalancesApi->new();
my $accountId = accountId_example; # String | AccountId
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->getAccountsAccountIdBalances(accountId => $accountId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
print Dumper($result);
};
if ($@) {
warn "Exception when calling BalancesApi->getAccountsAccountIdBalances: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.BalancesApi()
accountId = accountId_example # String | AccountId
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Get Balances
api_response = api_instance.get_accounts_account_id_balances(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling BalancesApi->getAccountsAccountIdBalances: %s\n" % e)
Parameters
Name | Description |
---|---|
AccountId* |
String
AccountId
Required
|
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Responses
Status: 200 - Balances Read
Set of elements used to define the balance details.
Set of elements used to define the balance details.
Amount of money of the cash balance after a transaction entry is applied to the account..
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
Beneficiaries
Usage and SDK Samples
curl -X GET "https://localhost/open-banking/v3.1/aisp/accounts/{AccountId}/beneficiaries"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BeneficiariesApi;
import java.io.File;
import java.util.*;
public class BeneficiariesApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: PSUOAuth2Security
OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
BeneficiariesApi apiInstance = new BeneficiariesApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadBeneficiary3 result = apiInstance.getAccountsAccountIdBeneficiaries(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BeneficiariesApi#getAccountsAccountIdBeneficiaries");
e.printStackTrace();
}
}
}
import io.swagger.client.api.BeneficiariesApi;
public class BeneficiariesApiExample {
public static void main(String[] args) {
BeneficiariesApi apiInstance = new BeneficiariesApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadBeneficiary3 result = apiInstance.getAccountsAccountIdBeneficiaries(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BeneficiariesApi#getAccountsAccountIdBeneficiaries");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
BeneficiariesApi *apiInstance = [[BeneficiariesApi alloc] init];
// Get Beneficiaries
[apiInstance getAccountsAccountIdBeneficiariesWith:accountId
xFapiFinancialId:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadBeneficiary3 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.BeneficiariesApi()
var accountId = accountId_example; // {String} AccountId
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAccountsAccountIdBeneficiaries(accountId, xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAccountsAccountIdBeneficiariesExample
{
public void main()
{
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new BeneficiariesApi();
var accountId = accountId_example; // String | AccountId
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Get Beneficiaries
OBReadBeneficiary3 result = apiInstance.getAccountsAccountIdBeneficiaries(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling BeneficiariesApi.getAccountsAccountIdBeneficiaries: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\BeneficiariesApi();
$accountId = accountId_example; // String | AccountId
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->getAccountsAccountIdBeneficiaries($accountId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BeneficiariesApi->getAccountsAccountIdBeneficiaries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BeneficiariesApi;
# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::BeneficiariesApi->new();
my $accountId = accountId_example; # String | AccountId
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->getAccountsAccountIdBeneficiaries(accountId => $accountId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
print Dumper($result);
};
if ($@) {
warn "Exception when calling BeneficiariesApi->getAccountsAccountIdBeneficiaries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.BeneficiariesApi()
accountId = accountId_example # String | AccountId
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Get Beneficiaries
api_response = api_instance.get_accounts_account_id_beneficiaries(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling BeneficiariesApi->getAccountsAccountIdBeneficiaries: %s\n" % e)
Parameters
Name | Description |
---|---|
AccountId* |
String
AccountId
Required
|
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Responses
Status: 200 - Beneficiaries Read
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
Provides the details to identify the beneficiary account.
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not found
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
DirectDebits
Usage and SDK Samples
curl -X GET "https://localhost/open-banking/v3.1/aisp/accounts/{AccountId}/direct-debits"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DirectDebitsApi;
import java.io.File;
import java.util.*;
public class DirectDebitsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: PSUOAuth2Security
OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
DirectDebitsApi apiInstance = new DirectDebitsApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadDirectDebit1 result = apiInstance.getAccountsAccountIdDirectDebits(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DirectDebitsApi#getAccountsAccountIdDirectDebits");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DirectDebitsApi;
public class DirectDebitsApiExample {
public static void main(String[] args) {
DirectDebitsApi apiInstance = new DirectDebitsApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadDirectDebit1 result = apiInstance.getAccountsAccountIdDirectDebits(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DirectDebitsApi#getAccountsAccountIdDirectDebits");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
DirectDebitsApi *apiInstance = [[DirectDebitsApi alloc] init];
// Get Direct Debits
[apiInstance getAccountsAccountIdDirectDebitsWith:accountId
xFapiFinancialId:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadDirectDebit1 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.DirectDebitsApi()
var accountId = accountId_example; // {String} AccountId
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAccountsAccountIdDirectDebits(accountId, xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAccountsAccountIdDirectDebitsExample
{
public void main()
{
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new DirectDebitsApi();
var accountId = accountId_example; // String | AccountId
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Get Direct Debits
OBReadDirectDebit1 result = apiInstance.getAccountsAccountIdDirectDebits(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DirectDebitsApi.getAccountsAccountIdDirectDebits: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\DirectDebitsApi();
$accountId = accountId_example; // String | AccountId
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->getAccountsAccountIdDirectDebits($accountId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DirectDebitsApi->getAccountsAccountIdDirectDebits: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DirectDebitsApi;
# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::DirectDebitsApi->new();
my $accountId = accountId_example; # String | AccountId
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->getAccountsAccountIdDirectDebits(accountId => $accountId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DirectDebitsApi->getAccountsAccountIdDirectDebits: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.DirectDebitsApi()
accountId = accountId_example # String | AccountId
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Get Direct Debits
api_response = api_instance.get_accounts_account_id_direct_debits(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling DirectDebitsApi->getAccountsAccountIdDirectDebits: %s\n" % e)
Parameters
Name | Description |
---|---|
AccountId* |
String
AccountId
Required
|
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Responses
Status: 200 - Direct Debits Read
Account to or from which a cash entry is made.
Account to or from which a cash entry is made.
Amount of money of the cash balance after a transaction entry is applied to the account..
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not found
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
Partys
Usage and SDK Samples
curl -X GET "https://localhost/open-banking/v3.1/aisp/party"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartysApi;
import java.io.File;
import java.util.*;
public class PartysApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: PSUOAuth2Security
OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
PartysApi apiInstance = new PartysApi();
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadParty1 result = apiInstance.getParty(xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PartysApi#getParty");
e.printStackTrace();
}
}
}
import io.swagger.client.api.PartysApi;
public class PartysApiExample {
public static void main(String[] args) {
PartysApi apiInstance = new PartysApi();
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadParty1 result = apiInstance.getParty(xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PartysApi#getParty");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
PartysApi *apiInstance = [[PartysApi alloc] init];
// Get Party
[apiInstance getPartyWith:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadParty1 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.PartysApi()
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getParty(xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getPartyExample
{
public void main()
{
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new PartysApi();
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Get Party
OBReadParty1 result = apiInstance.getParty(xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling PartysApi.getParty: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\PartysApi();
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->getParty($xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PartysApi->getParty: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartysApi;
# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::PartysApi->new();
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->getParty(xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
print Dumper($result);
};
if ($@) {
warn "Exception when calling PartysApi->getParty: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.PartysApi()
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Get Party
api_response = api_instance.get_party(xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling PartysApi->getParty: %s\n" % e)
Parameters
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Responses
Status: 200 - Party Read
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not found
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
ScheduledPayments
Usage and SDK Samples
curl -X GET "https://localhost/open-banking/v3.1/aisp/accounts/{AccountId}/scheduled-payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScheduledPaymentsApi;
import java.io.File;
import java.util.*;
public class ScheduledPaymentsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: PSUOAuth2Security
OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
ScheduledPaymentsApi apiInstance = new ScheduledPaymentsApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadScheduledPayment2 result = apiInstance.getAccountsAccountIdScheduledPayments(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ScheduledPaymentsApi#getAccountsAccountIdScheduledPayments");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ScheduledPaymentsApi;
public class ScheduledPaymentsApiExample {
public static void main(String[] args) {
ScheduledPaymentsApi apiInstance = new ScheduledPaymentsApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadScheduledPayment2 result = apiInstance.getAccountsAccountIdScheduledPayments(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ScheduledPaymentsApi#getAccountsAccountIdScheduledPayments");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
ScheduledPaymentsApi *apiInstance = [[ScheduledPaymentsApi alloc] init];
// Get Scheduled Payments
[apiInstance getAccountsAccountIdScheduledPaymentsWith:accountId
xFapiFinancialId:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadScheduledPayment2 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.ScheduledPaymentsApi()
var accountId = accountId_example; // {String} AccountId
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAccountsAccountIdScheduledPayments(accountId, xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAccountsAccountIdScheduledPaymentsExample
{
public void main()
{
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new ScheduledPaymentsApi();
var accountId = accountId_example; // String | AccountId
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Get Scheduled Payments
OBReadScheduledPayment2 result = apiInstance.getAccountsAccountIdScheduledPayments(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ScheduledPaymentsApi.getAccountsAccountIdScheduledPayments: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\ScheduledPaymentsApi();
$accountId = accountId_example; // String | AccountId
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->getAccountsAccountIdScheduledPayments($accountId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ScheduledPaymentsApi->getAccountsAccountIdScheduledPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScheduledPaymentsApi;
# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::ScheduledPaymentsApi->new();
my $accountId = accountId_example; # String | AccountId
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->getAccountsAccountIdScheduledPayments(accountId => $accountId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ScheduledPaymentsApi->getAccountsAccountIdScheduledPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.ScheduledPaymentsApi()
accountId = accountId_example # String | AccountId
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Get Scheduled Payments
api_response = api_instance.get_accounts_account_id_scheduled_payments(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScheduledPaymentsApi->getAccountsAccountIdScheduledPayments: %s\n" % e)
Parameters
Name | Description |
---|---|
AccountId* |
String
AccountId
Required
|
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Responses
Status: 200 - Scheduled Payments Read
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
Amount of money of the cash balance after a transaction entry is applied to the account..
Provides the details to identify the beneficiary account.
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not found
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
StandingOrders
Usage and SDK Samples
curl -X GET "https://localhost/open-banking/v3.1/aisp/accounts/{AccountId}/standing-orders"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StandingOrdersApi;
import java.io.File;
import java.util.*;
public class StandingOrdersApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: PSUOAuth2Security
OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
StandingOrdersApi apiInstance = new StandingOrdersApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadStandingOrder4 result = apiInstance.getAccountsAccountIdStandingOrders(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StandingOrdersApi#getAccountsAccountIdStandingOrders");
e.printStackTrace();
}
}
}
import io.swagger.client.api.StandingOrdersApi;
public class StandingOrdersApiExample {
public static void main(String[] args) {
StandingOrdersApi apiInstance = new StandingOrdersApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadStandingOrder4 result = apiInstance.getAccountsAccountIdStandingOrders(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StandingOrdersApi#getAccountsAccountIdStandingOrders");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
StandingOrdersApi *apiInstance = [[StandingOrdersApi alloc] init];
// Get Standing Orders
[apiInstance getAccountsAccountIdStandingOrdersWith:accountId
xFapiFinancialId:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadStandingOrder4 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.StandingOrdersApi()
var accountId = accountId_example; // {String} AccountId
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAccountsAccountIdStandingOrders(accountId, xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAccountsAccountIdStandingOrdersExample
{
public void main()
{
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new StandingOrdersApi();
var accountId = accountId_example; // String | AccountId
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Get Standing Orders
OBReadStandingOrder4 result = apiInstance.getAccountsAccountIdStandingOrders(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling StandingOrdersApi.getAccountsAccountIdStandingOrders: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\StandingOrdersApi();
$accountId = accountId_example; // String | AccountId
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->getAccountsAccountIdStandingOrders($accountId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling StandingOrdersApi->getAccountsAccountIdStandingOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StandingOrdersApi;
# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::StandingOrdersApi->new();
my $accountId = accountId_example; # String | AccountId
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->getAccountsAccountIdStandingOrders(accountId => $accountId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
print Dumper($result);
};
if ($@) {
warn "Exception when calling StandingOrdersApi->getAccountsAccountIdStandingOrders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.StandingOrdersApi()
accountId = accountId_example # String | AccountId
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Get Standing Orders
api_response = api_instance.get_accounts_account_id_standing_orders(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling StandingOrdersApi->getAccountsAccountIdStandingOrders: %s\n" % e)
Parameters
Name | Description |
---|---|
AccountId* |
String
AccountId
Required
|
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Responses
Status: 200 - Standing Orders Read
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
Amount of money of the cash balance after a transaction entry is applied to the account..
Amount of money of the cash balance after a transaction entry is applied to the account..
Amount of money of the cash balance after a transaction entry is applied to the account..
Provides the details to identify the beneficiary account.
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not found
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
Statements
Usage and SDK Samples
curl -X GET "https://localhost/open-banking/v3.1/aisp/accounts/{AccountId}/statements?fromStatementDateTime=&toStatementDateTime="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatementsApi;
import java.io.File;
import java.util.*;
public class StatementsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: PSUOAuth2Security
OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
StatementsApi apiInstance = new StatementsApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
Date fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
Date toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadStatement1 result = apiInstance.getAccountsAccountIdStatements(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, fromStatementDateTime, toStatementDateTime, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatements");
e.printStackTrace();
}
}
}
import io.swagger.client.api.StatementsApi;
public class StatementsApiExample {
public static void main(String[] args) {
StatementsApi apiInstance = new StatementsApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
Date fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
Date toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadStatement1 result = apiInstance.getAccountsAccountIdStatements(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, fromStatementDateTime, toStatementDateTime, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatements");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
Date *fromStatementDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
Date *toStatementDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
StatementsApi *apiInstance = [[StatementsApi alloc] init];
// Get Statements
[apiInstance getAccountsAccountIdStatementsWith:accountId
xFapiFinancialId:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
fromStatementDateTime:fromStatementDateTime
toStatementDateTime:toStatementDateTime
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadStatement1 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.StatementsApi()
var accountId = accountId_example; // {String} AccountId
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'fromStatementDateTime': 2013-10-20T19:20:30+01:00, // {Date} The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
'toStatementDateTime': 2013-10-20T19:20:30+01:00, // {Date} The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAccountsAccountIdStatements(accountId, xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAccountsAccountIdStatementsExample
{
public void main()
{
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new StatementsApi();
var accountId = accountId_example; // String | AccountId
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
var toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Get Statements
OBReadStatement1 result = apiInstance.getAccountsAccountIdStatements(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, fromStatementDateTime, toStatementDateTime, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling StatementsApi.getAccountsAccountIdStatements: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\StatementsApi();
$accountId = accountId_example; // String | AccountId
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
$toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->getAccountsAccountIdStatements($accountId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $fromStatementDateTime, $toStatementDateTime, $xCustomerUserAgent);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling StatementsApi->getAccountsAccountIdStatements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;
# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $accountId = accountId_example; # String | AccountId
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $fromStatementDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
my $toStatementDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->getAccountsAccountIdStatements(accountId => $accountId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, fromStatementDateTime => $fromStatementDateTime, toStatementDateTime => $toStatementDateTime, xCustomerUserAgent => $xCustomerUserAgent);
print Dumper($result);
};
if ($@) {
warn "Exception when calling StatementsApi->getAccountsAccountIdStatements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.StatementsApi()
accountId = accountId_example # String | AccountId
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
fromStatementDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
toStatementDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Get Statements
api_response = api_instance.get_accounts_account_id_statements(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, fromStatementDateTime=fromStatementDateTime, toStatementDateTime=toStatementDateTime, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling StatementsApi->getAccountsAccountIdStatements: %s\n" % e)
Parameters
Name | Description |
---|---|
AccountId* |
String
AccountId
Required
|
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Name | Description |
---|---|
fromStatementDateTime |
Date
(date-time)
The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
|
toStatementDateTime |
Date
(date-time)
The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
|
Responses
Status: 200 - Statements Read
Provides further details on a statement resource.
Provides further details on a statement resource.
Other descriptions that may be available for the statement resource.
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not found
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
Usage and SDK Samples
curl -X GET "https://localhost/open-banking/v3.1/aisp/accounts/{AccountId}/statements/{StatementId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatementsApi;
import java.io.File;
import java.util.*;
public class StatementsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: PSUOAuth2Security
OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
StatementsApi apiInstance = new StatementsApi();
String statementId = statementId_example; // String | StatementId
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadStatement1 result = apiInstance.getAccountsAccountIdStatementsStatementId(statementId, accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatementsStatementId");
e.printStackTrace();
}
}
}
import io.swagger.client.api.StatementsApi;
public class StatementsApiExample {
public static void main(String[] args) {
StatementsApi apiInstance = new StatementsApi();
String statementId = statementId_example; // String | StatementId
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadStatement1 result = apiInstance.getAccountsAccountIdStatementsStatementId(statementId, accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatementsStatementId");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *statementId = statementId_example; // StatementId
String *accountId = accountId_example; // AccountId
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
StatementsApi *apiInstance = [[StatementsApi alloc] init];
// Get Statements
[apiInstance getAccountsAccountIdStatementsStatementIdWith:statementId
accountId:accountId
xFapiFinancialId:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadStatement1 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.StatementsApi()
var statementId = statementId_example; // {String} StatementId
var accountId = accountId_example; // {String} AccountId
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAccountsAccountIdStatementsStatementId(statementId, accountId, xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAccountsAccountIdStatementsStatementIdExample
{
public void main()
{
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new StatementsApi();
var statementId = statementId_example; // String | StatementId
var accountId = accountId_example; // String | AccountId
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Get Statements
OBReadStatement1 result = apiInstance.getAccountsAccountIdStatementsStatementId(statementId, accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling StatementsApi.getAccountsAccountIdStatementsStatementId: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\StatementsApi();
$statementId = statementId_example; // String | StatementId
$accountId = accountId_example; // String | AccountId
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->getAccountsAccountIdStatementsStatementId($statementId, $accountId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;
# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $statementId = statementId_example; # String | StatementId
my $accountId = accountId_example; # String | AccountId
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->getAccountsAccountIdStatementsStatementId(statementId => $statementId, accountId => $accountId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
print Dumper($result);
};
if ($@) {
warn "Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.StatementsApi()
statementId = statementId_example # String | StatementId
accountId = accountId_example # String | AccountId
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Get Statements
api_response = api_instance.get_accounts_account_id_statements_statement_id(statementId, accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementId: %s\n" % e)
Parameters
Name | Description |
---|---|
StatementId* |
String
StatementId
Required
|
AccountId* |
String
AccountId
Required
|
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Responses
Status: 200 - Statements Read
Provides further details on a statement resource.
Provides further details on a statement resource.
Other descriptions that may be available for the statement resource.
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not found
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |
Status: 500 - Internal Server Error
Transactions
Usage and SDK Samples
curl -X GET "https://localhost/open-banking/v3.1/aisp/accounts/{AccountId}/transactions?fromBookingDateTime=&toBookingDateTime="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransactionsApi;
import java.io.File;
import java.util.*;
public class TransactionsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: PSUOAuth2Security
OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");
TransactionsApi apiInstance = new TransactionsApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
Date fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime.
Date toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadTransaction4 result = apiInstance.getAccountsAccountIdTransactions(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, fromBookingDateTime, toBookingDateTime, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TransactionsApi#getAccountsAccountIdTransactions");
e.printStackTrace();
}
}
}
import io.swagger.client.api.TransactionsApi;
public class TransactionsApiExample {
public static void main(String[] args) {
TransactionsApi apiInstance = new TransactionsApi();
String accountId = accountId_example; // String | AccountId
String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
Date fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime.
Date toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime.
String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
OBReadTransaction4 result = apiInstance.getAccountsAccountIdTransactions(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, fromBookingDateTime, toBookingDateTime, xCustomerUserAgent);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TransactionsApi#getAccountsAccountIdTransactions");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
Date *fromBookingDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime. (optional)
Date *toBookingDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
// Get Transactions
[apiInstance getAccountsAccountIdTransactionsWith:accountId
xFapiFinancialId:xFapiFinancialId
authorization:authorization
xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
xFapiCustomerIpAddress:xFapiCustomerIpAddress
xFapiInteractionId:xFapiInteractionId
fromBookingDateTime:fromBookingDateTime
toBookingDateTime:toBookingDateTime
xCustomerUserAgent:xCustomerUserAgent
completionHandler: ^(OBReadTransaction4 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccountAndTransactionApiSpecification = require('account_and_transaction_api_specification');
var defaultClient = AccountAndTransactionApiSpecification.ApiClient.instance;
// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"
var api = new AccountAndTransactionApiSpecification.TransactionsApi()
var accountId = accountId_example; // {String} AccountId
var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = {
'xFapiCustomerLastLoggedTime': xFapiCustomerLastLoggedTime_example, // {String} The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
'fromBookingDateTime': 2013-10-20T19:20:30+01:00, // {Date} The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime.
'toBookingDateTime': 2013-10-20T19:20:30+01:00, // {Date} The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime.
'xCustomerUserAgent': xCustomerUserAgent_example // {String} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAccountsAccountIdTransactions(accountId, xFapiFinancialId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAccountsAccountIdTransactionsExample
{
public void main()
{
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new TransactionsApi();
var accountId = accountId_example; // String | AccountId
var xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
var authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
var xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id. (optional)
var fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime. (optional)
var toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime. (optional)
var xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using. (optional)
try
{
// Get Transactions
OBReadTransaction4 result = apiInstance.getAccountsAccountIdTransactions(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, fromBookingDateTime, toBookingDateTime, xCustomerUserAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling TransactionsApi.getAccountsAccountIdTransactions: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\TransactionsApi();
$accountId = accountId_example; // String | AccountId
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; // String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime.
$toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
try {
$result = $api_instance->getAccountsAccountIdTransactions($accountId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $fromBookingDateTime, $toBookingDateTime, $xCustomerUserAgent);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TransactionsApi->getAccountsAccountIdTransactions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransactionsApi;
# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::TransactionsApi->new();
my $accountId = accountId_example; # String | AccountId
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example; # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $fromBookingDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime.
my $toBookingDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
eval {
my $result = $api_instance->getAccountsAccountIdTransactions(accountId => $accountId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, fromBookingDateTime => $fromBookingDateTime, toBookingDateTime => $toBookingDateTime, xCustomerUserAgent => $xCustomerUserAgent);
print Dumper($result);
};
if ($@) {
warn "Exception when calling TransactionsApi->getAccountsAccountIdTransactions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.TransactionsApi()
accountId = accountId_example # String | AccountId
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiCustomerLastLoggedTime = xFapiCustomerLastLoggedTime_example # String | The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
fromBookingDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime. (optional)
toBookingDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
try:
# Get Transactions
api_response = api_instance.get_accounts_account_id_transactions(accountId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, fromBookingDateTime=fromBookingDateTime, toBookingDateTime=toBookingDateTime, xCustomerUserAgent=xCustomerUserAgent)
pprint(api_response)
except ApiException as e:
print("Exception when calling TransactionsApi->getAccountsAccountIdTransactions: %s\n" % e)
Parameters
Name | Description |
---|---|
AccountId* |
String
AccountId
Required
|
Name | Description |
---|---|
x-fapi-financial-id* |
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
|
x-fapi-customer-last-logged-time |
String
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
|
x-fapi-customer-ip-address |
String
The PSU's IP address if the PSU is currently logged in with the TPP.
|
x-fapi-interaction-id |
String
An RFC4122 UID used as a correlation id.
|
Authorization* | |
x-customer-user-agent |
String
Indicates the user-agent that the PSU is using.
|
Name | Description |
---|---|
fromBookingDateTime |
Date
(date-time)
The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime.
|
toBookingDateTime |
Date
(date-time)
The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The range is inclusive of the fromBookingDateTime and exclusive of the toBookingDateTime.
|
Responses
Status: 200 - Transactions Read
Provides further details on an entry in the report.
Provides further details on an entry in the report.
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Amount of money of the cash balance after a transaction entry is applied to the account..
Amount of money of the cash balance after a transaction entry is applied to the account..
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
Amount of money of the cash balance after a transaction entry is applied to the account..
Name | Type | Format | Description |
---|---|---|---|
x-fapi-interaction-id | String | An RFC4122 UID used as a correlation id. |
Status: 400 - Bad request
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not found
Status: 405 - Method Not Allowed
Status: 406 - Not Acceptable
Status: 429 - Too Many Requests
Name | Type | Format | Description |
---|---|---|---|
Retry-After | Integer | Number in seconds to wait |