Payment Initiation API

DomesticPayments

Usage and SDK Samples

curl -X POST "https://localhost/open-banking/v3.0/pisp/domestic-payment-consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticPaymentsApi;

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

public class DomesticPaymentsApiExample {

    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");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomesticConsent1 oBWriteDomesticConsent1Param = ; // OBWriteDomesticConsent1 | 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 xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        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 {
            OBWriteDomesticConsentResponse1 result = apiInstance.createDomesticPaymentConsents(oBWriteDomesticConsent1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#createDomesticPaymentConsents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomesticConsent1 oBWriteDomesticConsent1Param = ; // OBWriteDomesticConsent1 | 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 xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        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 {
            OBWriteDomesticConsentResponse1 result = apiInstance.createDomesticPaymentConsents(oBWriteDomesticConsent1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#createDomesticPaymentConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteDomesticConsent1 *oBWriteDomesticConsent1Param = ; // 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 *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
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)

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

// Create Domestic Payment Consents
[apiInstance createDomesticPaymentConsentsWith:oBWriteDomesticConsent1Param
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticConsentResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticPaymentsApi()

var oBWriteDomesticConsent1Param = ; // {OBWriteDomesticConsent1} 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 xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

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.createDomesticPaymentConsents(oBWriteDomesticConsent1Param, xFapiFinancialId, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var oBWriteDomesticConsent1Param = new OBWriteDomesticConsent1(); // OBWriteDomesticConsent1 | 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 xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            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 Domestic Payment Consents
                OBWriteDomesticConsentResponse1 result = apiInstance.createDomesticPaymentConsents(oBWriteDomesticConsent1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.createDomesticPaymentConsents: " + 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\DomesticPaymentsApi();
$oBWriteDomesticConsent1Param = ; // OBWriteDomesticConsent1 | 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
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$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->createDomesticPaymentConsents($oBWriteDomesticConsent1Param, $xFapiFinancialId, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->createDomesticPaymentConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $oBWriteDomesticConsent1Param = WWW::SwaggerClient::Object::OBWriteDomesticConsent1->new(); # OBWriteDomesticConsent1 | 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 $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
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->createDomesticPaymentConsents(oBWriteDomesticConsent1Param => $oBWriteDomesticConsent1Param, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->createDomesticPaymentConsents: $@\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.DomesticPaymentsApi()
oBWriteDomesticConsent1Param =  # OBWriteDomesticConsent1 | 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
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
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 Domestic Payment Consents
    api_response = api_instance.create_domestic_payment_consents(oBWriteDomesticConsent1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->createDomesticPaymentConsents: %s\n" % e)

Parameters

Header 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*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
oBWriteDomesticConsent1Param *

Responses

Status: 201 - Domestic Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

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 POST "https://localhost/open-banking/v3.0/pisp/domestic-payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticPaymentsApi;

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

public class DomesticPaymentsApiExample {

    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");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomestic1 oBWriteDomestic1Param = ; // OBWriteDomestic1 | 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 xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        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 {
            OBWriteDomesticResponse1 result = apiInstance.createDomesticPayments(oBWriteDomestic1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#createDomesticPayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomestic1 oBWriteDomestic1Param = ; // OBWriteDomestic1 | 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 xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        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 {
            OBWriteDomesticResponse1 result = apiInstance.createDomesticPayments(oBWriteDomestic1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#createDomesticPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteDomestic1 *oBWriteDomestic1Param = ; // 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 *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
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)

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

// Create Domestic Payments
[apiInstance createDomesticPaymentsWith:oBWriteDomestic1Param
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticPaymentsApi()

var oBWriteDomestic1Param = ; // {OBWriteDomestic1} 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 xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

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.createDomesticPayments(oBWriteDomestic1Param, xFapiFinancialId, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var oBWriteDomestic1Param = new OBWriteDomestic1(); // OBWriteDomestic1 | 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 xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            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 Domestic Payments
                OBWriteDomesticResponse1 result = apiInstance.createDomesticPayments(oBWriteDomestic1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.createDomesticPayments: " + 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\DomesticPaymentsApi();
$oBWriteDomestic1Param = ; // OBWriteDomestic1 | 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
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$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->createDomesticPayments($oBWriteDomestic1Param, $xFapiFinancialId, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->createDomesticPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $oBWriteDomestic1Param = WWW::SwaggerClient::Object::OBWriteDomestic1->new(); # OBWriteDomestic1 | 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 $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
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->createDomesticPayments(oBWriteDomestic1Param => $oBWriteDomestic1Param, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->createDomesticPayments: $@\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.DomesticPaymentsApi()
oBWriteDomestic1Param =  # OBWriteDomestic1 | 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
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
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 Domestic Payments
    api_response = api_instance.create_domestic_payments(oBWriteDomestic1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->createDomesticPayments: %s\n" % e)

Parameters

Header 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*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
oBWriteDomestic1Param *

Responses

Status: 201 - Domestic Payments Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

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 GET "https://localhost/open-banking/v3.0/pisp/domestic-payment-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticPaymentsApi;

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

public class DomesticPaymentsApiExample {

    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");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        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 {
            OBWriteDomesticConsentResponse1 result = apiInstance.getDomesticPaymentConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        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 {
            OBWriteDomesticConsentResponse1 result = apiInstance.getDomesticPaymentConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentConsentsConsentId");
            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)

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

// Get Domestic Payment Consents
[apiInstance getDomesticPaymentConsentsConsentIdWith:consentId
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticConsentResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticPaymentsApi()

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.getDomesticPaymentConsentsConsentId(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 getDomesticPaymentConsentsConsentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            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 Domestic Payment Consents
                OBWriteDomesticConsentResponse1 result = apiInstance.getDomesticPaymentConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.getDomesticPaymentConsentsConsentId: " + 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\DomesticPaymentsApi();
$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->getDomesticPaymentConsentsConsentId($consentId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->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->getDomesticPaymentConsentsConsentId(consentId => $consentId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentId: $@\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.DomesticPaymentsApi()
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 Domestic Payment Consents
    api_response = api_instance.get_domestic_payment_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 DomesticPaymentsApi->getDomesticPaymentConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header 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*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

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

Usage and SDK Samples

curl -X GET "https://localhost/open-banking/v3.0/pisp/domestic-payments/{DomesticPaymentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticPaymentsApi;

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

public class DomesticPaymentsApiExample {

    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");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
        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 {
            OBWriteDomesticResponse1 result = apiInstance.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentsDomesticPaymentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
        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 {
            OBWriteDomesticResponse1 result = apiInstance.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentsDomesticPaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *domesticPaymentId = domesticPaymentId_example; // DomesticPaymentId
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)

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

// Get Domestic Payments
[apiInstance getDomesticPaymentsDomesticPaymentIdWith:domesticPaymentId
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticPaymentsApi()

var domesticPaymentId = domesticPaymentId_example; // {String} DomesticPaymentId

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.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, 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 getDomesticPaymentsDomesticPaymentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var domesticPaymentId = domesticPaymentId_example;  // String | DomesticPaymentId
            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 Domestic Payments
                OBWriteDomesticResponse1 result = apiInstance.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.getDomesticPaymentsDomesticPaymentId: " + 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\DomesticPaymentsApi();
$domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
$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->getDomesticPaymentsDomesticPaymentId($domesticPaymentId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->getDomesticPaymentsDomesticPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $domesticPaymentId = domesticPaymentId_example; # String | DomesticPaymentId
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->getDomesticPaymentsDomesticPaymentId(domesticPaymentId => $domesticPaymentId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->getDomesticPaymentsDomesticPaymentId: $@\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.DomesticPaymentsApi()
domesticPaymentId = domesticPaymentId_example # String | DomesticPaymentId
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 Domestic Payments
    api_response = api_instance.get_domestic_payments_domestic_payment_id(domesticPaymentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->getDomesticPaymentsDomesticPaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticPaymentId*
String
DomesticPaymentId
Required
Header 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*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Payments Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

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

DomesticScheduledPayments

Usage and SDK Samples

curl -X POST "https://localhost/open-banking/v3.0/pisp/domestic-scheduled-payment-consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticScheduledPaymentsApi;

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

public class DomesticScheduledPaymentsApiExample {

    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");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduledConsent1 oBWriteDomesticScheduledConsent1Param = ; // OBWriteDomesticScheduledConsent1 | 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 xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        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 {
            OBWriteDomesticScheduledConsentResponse1 result = apiInstance.createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#createDomesticScheduledPaymentConsents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticScheduledPaymentsApi;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduledConsent1 oBWriteDomesticScheduledConsent1Param = ; // OBWriteDomesticScheduledConsent1 | 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 xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        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 {
            OBWriteDomesticScheduledConsentResponse1 result = apiInstance.createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#createDomesticScheduledPaymentConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteDomesticScheduledConsent1 *oBWriteDomesticScheduledConsent1Param = ; // 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 *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
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)

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

// Create Domestic Scheduled Payment Consents
[apiInstance createDomesticScheduledPaymentConsentsWith:oBWriteDomesticScheduledConsent1Param
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledConsentResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticScheduledPaymentsApi()

var oBWriteDomesticScheduledConsent1Param = ; // {OBWriteDomesticScheduledConsent1} 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 xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

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.createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent1Param, xFapiFinancialId, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var oBWriteDomesticScheduledConsent1Param = new OBWriteDomesticScheduledConsent1(); // OBWriteDomesticScheduledConsent1 | 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 xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            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 Domestic Scheduled Payment Consents
                OBWriteDomesticScheduledConsentResponse1 result = apiInstance.createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticScheduledPaymentsApi.createDomesticScheduledPaymentConsents: " + 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\DomesticScheduledPaymentsApi();
$oBWriteDomesticScheduledConsent1Param = ; // OBWriteDomesticScheduledConsent1 | 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
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$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->createDomesticScheduledPaymentConsents($oBWriteDomesticScheduledConsent1Param, $xFapiFinancialId, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPaymentConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $oBWriteDomesticScheduledConsent1Param = WWW::SwaggerClient::Object::OBWriteDomesticScheduledConsent1->new(); # OBWriteDomesticScheduledConsent1 | 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 $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
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->createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent1Param => $oBWriteDomesticScheduledConsent1Param, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPaymentConsents: $@\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.DomesticScheduledPaymentsApi()
oBWriteDomesticScheduledConsent1Param =  # OBWriteDomesticScheduledConsent1 | 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
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
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 Domestic Scheduled Payment Consents
    api_response = api_instance.create_domestic_scheduled_payment_consents(oBWriteDomesticScheduledConsent1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPaymentConsents: %s\n" % e)

Parameters

Header 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*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
oBWriteDomesticScheduledConsent1Param *

Responses

Status: 201 - Domestic Scheduled Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

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 POST "https://localhost/open-banking/v3.0/pisp/domestic-scheduled-payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticScheduledPaymentsApi;

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

public class DomesticScheduledPaymentsApiExample {

    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");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduled1 oBWriteDomesticScheduled1Param = ; // OBWriteDomesticScheduled1 | 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 xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        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 {
            OBWriteDomesticScheduledResponse1 result = apiInstance.createDomesticScheduledPayments(oBWriteDomesticScheduled1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#createDomesticScheduledPayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticScheduledPaymentsApi;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduled1 oBWriteDomesticScheduled1Param = ; // OBWriteDomesticScheduled1 | 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 xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        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 {
            OBWriteDomesticScheduledResponse1 result = apiInstance.createDomesticScheduledPayments(oBWriteDomesticScheduled1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#createDomesticScheduledPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteDomesticScheduled1 *oBWriteDomesticScheduled1Param = ; // 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 *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
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)

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

// Create Domestic Scheduled Payments
[apiInstance createDomesticScheduledPaymentsWith:oBWriteDomesticScheduled1Param
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticScheduledPaymentsApi()

var oBWriteDomesticScheduled1Param = ; // {OBWriteDomesticScheduled1} 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 xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

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.createDomesticScheduledPayments(oBWriteDomesticScheduled1Param, xFapiFinancialId, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var oBWriteDomesticScheduled1Param = new OBWriteDomesticScheduled1(); // OBWriteDomesticScheduled1 | 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 xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            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 Domestic Scheduled Payments
                OBWriteDomesticScheduledResponse1 result = apiInstance.createDomesticScheduledPayments(oBWriteDomesticScheduled1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticScheduledPaymentsApi.createDomesticScheduledPayments: " + 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\DomesticScheduledPaymentsApi();
$oBWriteDomesticScheduled1Param = ; // OBWriteDomesticScheduled1 | 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
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$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->createDomesticScheduledPayments($oBWriteDomesticScheduled1Param, $xFapiFinancialId, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $oBWriteDomesticScheduled1Param = WWW::SwaggerClient::Object::OBWriteDomesticScheduled1->new(); # OBWriteDomesticScheduled1 | 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 $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
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->createDomesticScheduledPayments(oBWriteDomesticScheduled1Param => $oBWriteDomesticScheduled1Param, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPayments: $@\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.DomesticScheduledPaymentsApi()
oBWriteDomesticScheduled1Param =  # OBWriteDomesticScheduled1 | 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
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
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 Domestic Scheduled Payments
    api_response = api_instance.create_domestic_scheduled_payments(oBWriteDomesticScheduled1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPayments: %s\n" % e)

Parameters

Header 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*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
oBWriteDomesticScheduled1Param *

Responses

Status: 201 - Domestic Scheduled Payments Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

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 GET "https://localhost/open-banking/v3.0/pisp/domestic-scheduled-payment-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticScheduledPaymentsApi;

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

public class DomesticScheduledPaymentsApiExample {

    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");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        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 {
            OBWriteDomesticScheduledConsentResponse1 result = apiInstance.getDomesticScheduledPaymentConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#getDomesticScheduledPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticScheduledPaymentsApi;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        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 {
            OBWriteDomesticScheduledConsentResponse1 result = apiInstance.getDomesticScheduledPaymentConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#getDomesticScheduledPaymentConsentsConsentId");
            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)

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

// Get Domestic Scheduled Payment Consents
[apiInstance getDomesticScheduledPaymentConsentsConsentIdWith:consentId
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledConsentResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticScheduledPaymentsApi()

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.getDomesticScheduledPaymentConsentsConsentId(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 getDomesticScheduledPaymentConsentsConsentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            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 Domestic Scheduled Payment Consents
                OBWriteDomesticScheduledConsentResponse1 result = apiInstance.getDomesticScheduledPaymentConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticScheduledPaymentsApi.getDomesticScheduledPaymentConsentsConsentId: " + 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\DomesticScheduledPaymentsApi();
$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->getDomesticScheduledPaymentConsentsConsentId($consentId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->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->getDomesticScheduledPaymentConsentsConsentId(consentId => $consentId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentConsentsConsentId: $@\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.DomesticScheduledPaymentsApi()
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 Domestic Scheduled Payment Consents
    api_response = api_instance.get_domestic_scheduled_payment_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 DomesticScheduledPaymentsApi->getDomesticScheduledPaymentConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header 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*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Scheduled Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

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.0/pisp/domestic-scheduled-payments/{DomesticScheduledPaymentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticScheduledPaymentsApi;

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

public class DomesticScheduledPaymentsApiExample {

    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");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        String domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
        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 {
            OBWriteDomesticScheduledResponse1 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#getDomesticScheduledPaymentsDomesticScheduledPaymentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticScheduledPaymentsApi;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        String domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
        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 {
            OBWriteDomesticScheduledResponse1 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#getDomesticScheduledPaymentsDomesticScheduledPaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *domesticScheduledPaymentId = domesticScheduledPaymentId_example; // DomesticScheduledPaymentId
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)

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

// Get Domestic Scheduled Payments
[apiInstance getDomesticScheduledPaymentsDomesticScheduledPaymentIdWith:domesticScheduledPaymentId
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticScheduledPaymentsApi()

var domesticScheduledPaymentId = domesticScheduledPaymentId_example; // {String} DomesticScheduledPaymentId

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.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, 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 getDomesticScheduledPaymentsDomesticScheduledPaymentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var domesticScheduledPaymentId = domesticScheduledPaymentId_example;  // String | DomesticScheduledPaymentId
            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 Domestic Scheduled Payments
                OBWriteDomesticScheduledResponse1 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticScheduledPaymentsApi.getDomesticScheduledPaymentsDomesticScheduledPaymentId: " + 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\DomesticScheduledPaymentsApi();
$domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
$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->getDomesticScheduledPaymentsDomesticScheduledPaymentId($domesticScheduledPaymentId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $domesticScheduledPaymentId = domesticScheduledPaymentId_example; # String | DomesticScheduledPaymentId
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->getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId => $domesticScheduledPaymentId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentId: $@\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.DomesticScheduledPaymentsApi()
domesticScheduledPaymentId = domesticScheduledPaymentId_example # String | DomesticScheduledPaymentId
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 Domestic Scheduled Payments
    api_response = api_instance.get_domestic_scheduled_payments_domestic_scheduled_payment_id(domesticScheduledPaymentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticScheduledPaymentId*
String
DomesticScheduledPaymentId
Required
Header 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*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Scheduled Payments Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

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

DomesticStandingOrders

Usage and SDK Samples

curl -X POST "https://localhost/open-banking/v3.0/pisp/domestic-standing-order-consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticStandingOrdersApi;

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

public class DomesticStandingOrdersApiExample {

    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");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrderConsent1 oBWriteDomesticStandingOrderConsent1Param = ; // OBWriteDomesticStandingOrderConsent1 | 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 xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        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 {
            OBWriteDomesticStandingOrderConsentResponse1 result = apiInstance.createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#createDomesticStandingOrderConsents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticStandingOrdersApi;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrderConsent1 oBWriteDomesticStandingOrderConsent1Param = ; // OBWriteDomesticStandingOrderConsent1 | 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 xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        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 {
            OBWriteDomesticStandingOrderConsentResponse1 result = apiInstance.createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#createDomesticStandingOrderConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteDomesticStandingOrderConsent1 *oBWriteDomesticStandingOrderConsent1Param = ; // 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 *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
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)

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

// Create Domestic Standing Order Consents
[apiInstance createDomesticStandingOrderConsentsWith:oBWriteDomesticStandingOrderConsent1Param
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticStandingOrderConsentResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticStandingOrdersApi()

var oBWriteDomesticStandingOrderConsent1Param = ; // {OBWriteDomesticStandingOrderConsent1} 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 xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

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.createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent1Param, xFapiFinancialId, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            var oBWriteDomesticStandingOrderConsent1Param = new OBWriteDomesticStandingOrderConsent1(); // OBWriteDomesticStandingOrderConsent1 | 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 xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            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 Domestic Standing Order Consents
                OBWriteDomesticStandingOrderConsentResponse1 result = apiInstance.createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticStandingOrdersApi.createDomesticStandingOrderConsents: " + 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\DomesticStandingOrdersApi();
$oBWriteDomesticStandingOrderConsent1Param = ; // OBWriteDomesticStandingOrderConsent1 | 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
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$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->createDomesticStandingOrderConsents($oBWriteDomesticStandingOrderConsent1Param, $xFapiFinancialId, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrderConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->new();
my $oBWriteDomesticStandingOrderConsent1Param = WWW::SwaggerClient::Object::OBWriteDomesticStandingOrderConsent1->new(); # OBWriteDomesticStandingOrderConsent1 | 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 $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
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->createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent1Param => $oBWriteDomesticStandingOrderConsent1Param, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrderConsents: $@\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.DomesticStandingOrdersApi()
oBWriteDomesticStandingOrderConsent1Param =  # OBWriteDomesticStandingOrderConsent1 | 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
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
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 Domestic Standing Order Consents
    api_response = api_instance.create_domestic_standing_order_consents(oBWriteDomesticStandingOrderConsent1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrderConsents: %s\n" % e)

Parameters

Header 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*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
oBWriteDomesticStandingOrderConsent1Param *

Responses

Status: 201 - Domestic Standing Order Consents Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

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 POST "https://localhost/open-banking/v3.0/pisp/domestic-standing-orders"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticStandingOrdersApi;

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

public class DomesticStandingOrdersApiExample {

    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");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrder1 oBWriteDomesticStandingOrder1Param = ; // OBWriteDomesticStandingOrder1 | 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 xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        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 {
            OBWriteDomesticStandingOrderResponse1 result = apiInstance.createDomesticStandingOrders(oBWriteDomesticStandingOrder1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#createDomesticStandingOrders");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticStandingOrdersApi;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrder1 oBWriteDomesticStandingOrder1Param = ; // OBWriteDomesticStandingOrder1 | 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 xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        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 {
            OBWriteDomesticStandingOrderResponse1 result = apiInstance.createDomesticStandingOrders(oBWriteDomesticStandingOrder1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#createDomesticStandingOrders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteDomesticStandingOrder1 *oBWriteDomesticStandingOrder1Param = ; // 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 *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
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)

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

// Create Domestic Standing Orders
[apiInstance createDomesticStandingOrdersWith:oBWriteDomesticStandingOrder1Param
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticStandingOrderResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticStandingOrdersApi()

var oBWriteDomesticStandingOrder1Param = ; // {OBWriteDomesticStandingOrder1} 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 xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

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.createDomesticStandingOrders(oBWriteDomesticStandingOrder1Param, xFapiFinancialId, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            var oBWriteDomesticStandingOrder1Param = new OBWriteDomesticStandingOrder1(); // OBWriteDomesticStandingOrder1 | 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 xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            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 Domestic Standing Orders
                OBWriteDomesticStandingOrderResponse1 result = apiInstance.createDomesticStandingOrders(oBWriteDomesticStandingOrder1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticStandingOrdersApi.createDomesticStandingOrders: " + 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\DomesticStandingOrdersApi();
$oBWriteDomesticStandingOrder1Param = ; // OBWriteDomesticStandingOrder1 | 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
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$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->createDomesticStandingOrders($oBWriteDomesticStandingOrder1Param, $xFapiFinancialId, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticStandingOrdersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->new();
my $oBWriteDomesticStandingOrder1Param = WWW::SwaggerClient::Object::OBWriteDomesticStandingOrder1->new(); # OBWriteDomesticStandingOrder1 | 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 $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
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->createDomesticStandingOrders(oBWriteDomesticStandingOrder1Param => $oBWriteDomesticStandingOrder1Param, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrders: $@\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.DomesticStandingOrdersApi()
oBWriteDomesticStandingOrder1Param =  # OBWriteDomesticStandingOrder1 | 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
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours.
xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
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 Domestic Standing Orders
    api_response = api_instance.create_domestic_standing_orders(oBWriteDomesticStandingOrder1Param, xFapiFinancialId, authorization, xIdempotencyKey, xJwsSignature, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrders: %s\n" % e)

Parameters

Header 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*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
oBWriteDomesticStandingOrder1Param *

Responses

Status: 201 - Domestic Standing Orders Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

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 GET "https://localhost/open-banking/v3.0/pisp/domestic-standing-order-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticStandingOrdersApi;

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

public class DomesticStandingOrdersApiExample {

    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");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        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 {
            OBWriteDomesticStandingOrderConsentResponse1 result = apiInstance.getDomesticStandingOrderConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#getDomesticStandingOrderConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticStandingOrdersApi;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        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 {
            OBWriteDomesticStandingOrderConsentResponse1 result = apiInstance.getDomesticStandingOrderConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#getDomesticStandingOrderConsentsConsentId");
            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)

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

// Get Domestic Standing Order Consents
[apiInstance getDomesticStandingOrderConsentsConsentIdWith:consentId
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticStandingOrderConsentResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticStandingOrdersApi()

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.getDomesticStandingOrderConsentsConsentId(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 getDomesticStandingOrderConsentsConsentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            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 Domestic Standing Order Consents
                OBWriteDomesticStandingOrderConsentResponse1 result = apiInstance.getDomesticStandingOrderConsentsConsentId(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticStandingOrdersApi.getDomesticStandingOrderConsentsConsentId: " + 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\DomesticStandingOrdersApi();
$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->getDomesticStandingOrderConsentsConsentId($consentId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrderConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->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->getDomesticStandingOrderConsentsConsentId(consentId => $consentId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrderConsentsConsentId: $@\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.DomesticStandingOrdersApi()
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 Domestic Standing Order Consents
    api_response = api_instance.get_domestic_standing_order_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 DomesticStandingOrdersApi->getDomesticStandingOrderConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header 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*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Standing Order Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

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.0/pisp/domestic-standing-orders/{DomesticStandingOrderId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticStandingOrdersApi;

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

public class DomesticStandingOrdersApiExample {

    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");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        String domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
        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 {
            OBWriteDomesticStandingOrderResponse1 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#getDomesticStandingOrdersDomesticStandingOrderId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticStandingOrdersApi;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        String domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
        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 {
            OBWriteDomesticStandingOrderResponse1 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#getDomesticStandingOrdersDomesticStandingOrderId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *domesticStandingOrderId = domesticStandingOrderId_example; // DomesticStandingOrderId
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)

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

// Get Domestic Standing Orders
[apiInstance getDomesticStandingOrdersDomesticStandingOrderIdWith:domesticStandingOrderId
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticStandingOrderResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticStandingOrdersApi()

var domesticStandingOrderId = domesticStandingOrderId_example; // {String} DomesticStandingOrderId

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.getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId, 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 getDomesticStandingOrdersDomesticStandingOrderIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            var domesticStandingOrderId = domesticStandingOrderId_example;  // String | DomesticStandingOrderId
            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 Domestic Standing Orders
                OBWriteDomesticStandingOrderResponse1 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticStandingOrdersApi.getDomesticStandingOrdersDomesticStandingOrderId: " + 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\DomesticStandingOrdersApi();
$domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
$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->getDomesticStandingOrdersDomesticStandingOrderId($domesticStandingOrderId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrdersDomesticStandingOrderId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->new();
my $domesticStandingOrderId = domesticStandingOrderId_example; # String | DomesticStandingOrderId
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->getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId => $domesticStandingOrderId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrdersDomesticStandingOrderId: $@\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.DomesticStandingOrdersApi()
domesticStandingOrderId = domesticStandingOrderId_example # String | DomesticStandingOrderId
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 Domestic Standing Orders
    api_response = api_instance.get_domestic_standing_orders_domestic_standing_order_id(domesticStandingOrderId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrdersDomesticStandingOrderId: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticStandingOrderId*
String
DomesticStandingOrderId
Required
Header 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*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Standing Orders Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

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

Generated 2019-03-13T14:44:59.418Z