Payment Initiation API

DomesticPayments

Usage and SDK Samples

curl -X POST "https://localhost/open-banking/v3.1/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();
        OBWriteDomesticConsent2 oBWriteDomesticConsent2Param = ; // OBWriteDomesticConsent2 | 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 {
            OBWriteDomesticConsentResponse2 result = apiInstance.createDomesticPaymentConsents(oBWriteDomesticConsent2Param, 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();
        OBWriteDomesticConsent2 oBWriteDomesticConsent2Param = ; // OBWriteDomesticConsent2 | 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 {
            OBWriteDomesticConsentResponse2 result = apiInstance.createDomesticPaymentConsents(oBWriteDomesticConsent2Param, 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"];

OBWriteDomesticConsent2 *oBWriteDomesticConsent2Param = ; // 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:oBWriteDomesticConsent2Param
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticConsentResponse2 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 oBWriteDomesticConsent2Param = ; // {OBWriteDomesticConsent2} 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(oBWriteDomesticConsent2Param, 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 oBWriteDomesticConsent2Param = new OBWriteDomesticConsent2(); // OBWriteDomesticConsent2 | 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
                OBWriteDomesticConsentResponse2 result = apiInstance.createDomesticPaymentConsents(oBWriteDomesticConsent2Param, 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();
$oBWriteDomesticConsent2Param = ; // OBWriteDomesticConsent2 | 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($oBWriteDomesticConsent2Param, $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 $oBWriteDomesticConsent2Param = WWW::SwaggerClient::Object::OBWriteDomesticConsent2->new(); # OBWriteDomesticConsent2 | 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(oBWriteDomesticConsent2Param => $oBWriteDomesticConsent2Param, 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()
oBWriteDomesticConsent2Param =  # OBWriteDomesticConsent2 | 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(oBWriteDomesticConsent2Param, 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
oBWriteDomesticConsent2Param *
{
Required: Data,Risk
Data:
{
Required: Initiation
Initiation:
Authorisation:
}
Risk:
{

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode:
MerchantCategoryCode:
MerchantCustomerIdentification:
DeliveryAddress:
}
}

Responses

Status: 201 - Domestic Payment Consents Created

{
Required: Data,Links,Meta,Risk
Data:
{
Required: ConsentId,CreationDateTime,Initiation,Status,StatusUpdateDateTime
ConsentId:
string minLength:1 maxLength:128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime:
string (date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status:
string

Specifies the status of resource in code form.

Enum: Authorised, AwaitingAuthorisation, Consumed, Rejected
StatusUpdateDateTime:
string (date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

CutOffDateTime:
string (date-time)

Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedExecutionDateTime:
string (date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime:
string (date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges:
[

Set of elements used to provide details of a charge for the payment initiation.

{

Set of elements used to provide details of a charge for the payment initiation.

Required: Amount,ChargeBearer,Type
ChargeBearer:
string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum: BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Type:
string

Charge type, in a coded form.

Amount:
{

Amount of money associated with the charge type.

Required: Amount,Currency
Amount:
string

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency:
string
Pattern: ^[A-Z]{3,3}$
}
}
]
Initiation:
{

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.

Required: CreditorAccount,EndToEndIdentification,InstructedAmount,InstructionIdentification
InstructionIdentification:
EndToEndIdentification:
LocalInstrument:
InstructedAmount:
DebtorAccount:
CreditorAccount:
CreditorPostalAddress:
RemittanceInformation:
SupplementaryData:
}
Authorisation:
{

The authorisation type request from the TPP.

Required: AuthorisationType
AuthorisationType:
CompletionDateTime:
}
}
Risk:
{

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode:
string

Specifies the payment context

Enum: BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty
MerchantCategoryCode:
string minLength:3 maxLength:4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification:
string minLength:1 maxLength:70

The unique customer identifier of the PSU with the merchant.

DeliveryAddress:
{

Information that locates and identifies a specific address, as defined by postal services or in free format text.

Required: Country,TownName
AddressLine:
StreetName:
BuildingNumber:
PostCode:
TownName:
CountrySubDivision:
Country:
}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

Usage and SDK Samples

curl -X POST "https://localhost/open-banking/v3.1/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();
        OBWriteDomestic2 oBWriteDomestic2Param = ; // OBWriteDomestic2 | 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 {
            OBWriteDomesticResponse2 result = apiInstance.createDomesticPayments(oBWriteDomestic2Param, 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();
        OBWriteDomestic2 oBWriteDomestic2Param = ; // OBWriteDomestic2 | 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 {
            OBWriteDomesticResponse2 result = apiInstance.createDomesticPayments(oBWriteDomestic2Param, 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"];

OBWriteDomestic2 *oBWriteDomestic2Param = ; // 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:oBWriteDomestic2Param
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticResponse2 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 oBWriteDomestic2Param = ; // {OBWriteDomestic2} 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(oBWriteDomestic2Param, 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 oBWriteDomestic2Param = new OBWriteDomestic2(); // OBWriteDomestic2 | 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
                OBWriteDomesticResponse2 result = apiInstance.createDomesticPayments(oBWriteDomestic2Param, 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();
$oBWriteDomestic2Param = ; // OBWriteDomestic2 | 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($oBWriteDomestic2Param, $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 $oBWriteDomestic2Param = WWW::SwaggerClient::Object::OBWriteDomestic2->new(); # OBWriteDomestic2 | 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(oBWriteDomestic2Param => $oBWriteDomestic2Param, 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()
oBWriteDomestic2Param =  # OBWriteDomestic2 | 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(oBWriteDomestic2Param, 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
oBWriteDomestic2Param *
{
Required: Data,Risk
Data:
{
Required: ConsentId,Initiation
ConsentId:
Initiation:
}
Risk:
{

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode:
MerchantCategoryCode:
MerchantCustomerIdentification:
DeliveryAddress:
}
}

Responses

Status: 201 - Domestic Payments Created

{
Required: Data,Links,Meta
Data:
{
Required: ConsentId,CreationDateTime,DomesticPaymentId,Initiation,Status,StatusUpdateDateTime
DomesticPaymentId:
string minLength:1 maxLength:40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.

ConsentId:
string minLength:1 maxLength:128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime:
string (date-time)

Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status:
string

Specifies the status of the payment information group.

Enum: AcceptedSettlementCompleted, AcceptedSettlementInProcess, Pending, Rejected
StatusUpdateDateTime:
string (date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedExecutionDateTime:
string (date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime:
string (date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges:
[

Set of elements used to provide details of a charge for the payment initiation.

{

Set of elements used to provide details of a charge for the payment initiation.

Required: Amount,ChargeBearer,Type
ChargeBearer:
string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum: BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Type:
string

Charge type, in a coded form.

Amount:
{

Amount of money associated with the charge type.

Required: Amount,Currency
Amount:
string

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency:
string
Pattern: ^[A-Z]{3,3}$
}
}
]
Initiation:
{

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.

Required: CreditorAccount,EndToEndIdentification,InstructedAmount,InstructionIdentification
InstructionIdentification:
EndToEndIdentification:
LocalInstrument:
InstructedAmount:
DebtorAccount:
CreditorAccount:
CreditorPostalAddress:
RemittanceInformation:
SupplementaryData:
}
MultiAuthorisation:
{

The multiple authorisation flow response from the ASPSP.

Required: Status
Status:
NumberRequired:
NumberReceived:
LastUpdateDateTime:
ExpirationDateTime:
}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

Usage and SDK Samples

curl -X GET "https://localhost/open-banking/v3.1/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 {
            OBWriteDomesticConsentResponse2 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 {
            OBWriteDomesticConsentResponse2 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: ^(OBWriteDomesticConsentResponse2 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
                OBWriteDomesticConsentResponse2 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

{
Required: Data,Links,Meta,Risk
Data:
{
Required: ConsentId,CreationDateTime,Initiation,Status,StatusUpdateDateTime
ConsentId:
string minLength:1 maxLength:128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime:
string (date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status:
string

Specifies the status of resource in code form.

Enum: Authorised, AwaitingAuthorisation, Consumed, Rejected
StatusUpdateDateTime:
string (date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

CutOffDateTime:
string (date-time)

Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedExecutionDateTime:
string (date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime:
string (date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges:
[

Set of elements used to provide details of a charge for the payment initiation.

{

Set of elements used to provide details of a charge for the payment initiation.

Required: Amount,ChargeBearer,Type
ChargeBearer:
string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum: BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Type:
string

Charge type, in a coded form.

Amount:
{

Amount of money associated with the charge type.

Required: Amount,Currency
Amount:
string

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency:
string
Pattern: ^[A-Z]{3,3}$
}
}
]
Initiation:
{

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.

Required: CreditorAccount,EndToEndIdentification,InstructedAmount,InstructionIdentification
InstructionIdentification:
EndToEndIdentification:
LocalInstrument:
InstructedAmount:
DebtorAccount:
CreditorAccount:
CreditorPostalAddress:
RemittanceInformation:
SupplementaryData:
}
Authorisation:
{

The authorisation type request from the TPP.

Required: AuthorisationType
AuthorisationType:
CompletionDateTime:
}
}
Risk:
{

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode:
string

Specifies the payment context

Enum: BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty
MerchantCategoryCode:
string minLength:3 maxLength:4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification:
string minLength:1 maxLength:70

The unique customer identifier of the PSU with the merchant.

DeliveryAddress:
{

Information that locates and identifies a specific address, as defined by postal services or in free format text.

Required: Country,TownName
AddressLine:
StreetName:
BuildingNumber:
PostCode:
TownName:
CountrySubDivision:
Country:
}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

Usage and SDK Samples

curl -X GET "https://localhost/open-banking/v3.1/pisp/domestic-payment-consents/{ConsentId}/funds-confirmation"
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();
        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 {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentConsentsConsentIdFundsConfirmation");
            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 {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[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 Funds Confirmation
[apiInstance getDomesticPaymentConsentsConsentIdFundsConfirmationWith:consentId
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteFundsConfirmationResponse1 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 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.getDomesticPaymentConsentsConsentIdFundsConfirmation(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 getDomesticPaymentConsentsConsentIdFundsConfirmationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            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 Funds Confirmation
                OBWriteFundsConfirmationResponse1 result = apiInstance.getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.getDomesticPaymentConsentsConsentIdFundsConfirmation: " + 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();
$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->getDomesticPaymentConsentsConsentIdFundsConfirmation($consentId, $xFapiFinancialId, $authorization, $xFapiCustomerLastLoggedTime, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentIdFundsConfirmation: ', $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 $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->getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId => $consentId, xFapiFinancialId => $xFapiFinancialId, authorization => $authorization, xFapiCustomerLastLoggedTime => $xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentIdFundsConfirmation: $@\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()
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 Funds Confirmation
    api_response = api_instance.get_domestic_payment_consents_consent_id_funds_confirmation(consentId, xFapiFinancialId, authorization, xFapiCustomerLastLoggedTime=xFapiCustomerLastLoggedTime, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentIdFundsConfirmation: %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 Funds Confirmation Read

{
Required: Data,Links,Meta
Data:
{
FundsAvailableResult:
{

Result of a funds availability check.

Required: FundsAvailable,FundsAvailableDateTime
FundsAvailableDateTime:
FundsAvailable:
}
SupplementaryData:
{

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

Usage and SDK Samples

curl -X GET "https://localhost/open-banking/v3.1/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 {
            OBWriteDomesticResponse2 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 {
            OBWriteDomesticResponse2 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: ^(OBWriteDomesticResponse2 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
                OBWriteDomesticResponse2 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

{
Required: Data,Links,Meta
Data:
{
Required: ConsentId,CreationDateTime,DomesticPaymentId,Initiation,Status,StatusUpdateDateTime
DomesticPaymentId:
string minLength:1 maxLength:40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.

ConsentId:
string minLength:1 maxLength:128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime:
string (date-time)

Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status:
string

Specifies the status of the payment information group.

Enum: AcceptedSettlementCompleted, AcceptedSettlementInProcess, Pending, Rejected
StatusUpdateDateTime:
string (date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedExecutionDateTime:
string (date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime:
string (date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges:
[

Set of elements used to provide details of a charge for the payment initiation.

{

Set of elements used to provide details of a charge for the payment initiation.

Required: Amount,ChargeBearer,Type
ChargeBearer:
string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum: BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Type:
string

Charge type, in a coded form.

Amount:
{

Amount of money associated with the charge type.

Required: Amount,Currency
Amount:
string

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency:
string
Pattern: ^[A-Z]{3,3}$
}
}
]
Initiation:
{

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.

Required: CreditorAccount,EndToEndIdentification,InstructedAmount,InstructionIdentification
InstructionIdentification:
EndToEndIdentification:
LocalInstrument:
InstructedAmount:
DebtorAccount:
CreditorAccount:
CreditorPostalAddress:
RemittanceInformation:
SupplementaryData:
}
MultiAuthorisation:
{

The multiple authorisation flow response from the ASPSP.

Required: Status
Status:
NumberRequired:
NumberReceived:
LastUpdateDateTime:
ExpirationDateTime:
}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

DomesticScheduledPayments

Usage and SDK Samples

curl -X POST "https://localhost/open-banking/v3.1/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();
        OBWriteDomesticScheduledConsent2 oBWriteDomesticScheduledConsent2Param = ; // OBWriteDomesticScheduledConsent2 | 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 {
            OBWriteDomesticScheduledConsentResponse2 result = apiInstance.createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent2Param, 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();
        OBWriteDomesticScheduledConsent2 oBWriteDomesticScheduledConsent2Param = ; // OBWriteDomesticScheduledConsent2 | 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 {
            OBWriteDomesticScheduledConsentResponse2 result = apiInstance.createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent2Param, 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"];

OBWriteDomesticScheduledConsent2 *oBWriteDomesticScheduledConsent2Param = ; // 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:oBWriteDomesticScheduledConsent2Param
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledConsentResponse2 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 oBWriteDomesticScheduledConsent2Param = ; // {OBWriteDomesticScheduledConsent2} 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(oBWriteDomesticScheduledConsent2Param, 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 oBWriteDomesticScheduledConsent2Param = new OBWriteDomesticScheduledConsent2(); // OBWriteDomesticScheduledConsent2 | 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
                OBWriteDomesticScheduledConsentResponse2 result = apiInstance.createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent2Param, 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();
$oBWriteDomesticScheduledConsent2Param = ; // OBWriteDomesticScheduledConsent2 | 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($oBWriteDomesticScheduledConsent2Param, $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 $oBWriteDomesticScheduledConsent2Param = WWW::SwaggerClient::Object::OBWriteDomesticScheduledConsent2->new(); # OBWriteDomesticScheduledConsent2 | 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(oBWriteDomesticScheduledConsent2Param => $oBWriteDomesticScheduledConsent2Param, 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()
oBWriteDomesticScheduledConsent2Param =  # OBWriteDomesticScheduledConsent2 | 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(oBWriteDomesticScheduledConsent2Param, 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
oBWriteDomesticScheduledConsent2Param *
{
Required: Data,Risk
Data:
{
Required: Initiation,Permission
Permission:
Initiation:
Authorisation:
}
Risk:
{

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode:
MerchantCategoryCode:
MerchantCustomerIdentification:
DeliveryAddress:
}
}

Responses

Status: 201 - Domestic Scheduled Payment Consents Created

{
Required: Data,Links,Meta,Risk
Data:
{
Required: ConsentId,CreationDateTime,Initiation,Permission,Status,StatusUpdateDateTime
ConsentId:
string minLength:1 maxLength:128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime:
string (date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status:
string

Specifies the status of resource in code form.

Enum: Authorised, AwaitingAuthorisation, Consumed, Rejected
StatusUpdateDateTime:
string (date-time)

Date and time at which the consent resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Permission:
string

Specifies the Open Banking service request types.

Enum: Create
CutOffDateTime:
string (date-time)

Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedExecutionDateTime:
string (date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime:
string (date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges:
[

Set of elements used to provide details of a charge for the payment initiation.

{

Set of elements used to provide details of a charge for the payment initiation.

Required: Amount,ChargeBearer,Type
ChargeBearer:
string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum: BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Type:
string

Charge type, in a coded form.

Amount:
{

Amount of money associated with the charge type.

Required: Amount,Currency
Amount:
string

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency:
string
Pattern: ^[A-Z]{3,3}$
}
}
]
Initiation:
{

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.

Required: CreditorAccount,InstructedAmount,InstructionIdentification,RequestedExecutionDateTime
InstructionIdentification:
EndToEndIdentification:
LocalInstrument:
RequestedExecutionDateTime:
InstructedAmount:
DebtorAccount:
CreditorAccount:
CreditorPostalAddress:
RemittanceInformation:
SupplementaryData:
}
Authorisation:
{

The authorisation type request from the TPP.

Required: AuthorisationType
AuthorisationType:
CompletionDateTime:
}
}
Risk:
{

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode:
string

Specifies the payment context

Enum: BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty
MerchantCategoryCode:
string minLength:3 maxLength:4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification:
string minLength:1 maxLength:70

The unique customer identifier of the PSU with the merchant.

DeliveryAddress:
{

Information that locates and identifies a specific address, as defined by postal services or in free format text.

Required: Country,TownName
AddressLine:
StreetName:
BuildingNumber:
PostCode:
TownName:
CountrySubDivision:
Country:
}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

Usage and SDK Samples

curl -X POST "https://localhost/open-banking/v3.1/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();
        OBWriteDomesticScheduled2 oBWriteDomesticScheduled2Param = ; // OBWriteDomesticScheduled2 | 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 {
            OBWriteDomesticScheduledResponse2 result = apiInstance.createDomesticScheduledPayments(oBWriteDomesticScheduled2Param, 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();
        OBWriteDomesticScheduled2 oBWriteDomesticScheduled2Param = ; // OBWriteDomesticScheduled2 | 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 {
            OBWriteDomesticScheduledResponse2 result = apiInstance.createDomesticScheduledPayments(oBWriteDomesticScheduled2Param, 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"];

OBWriteDomesticScheduled2 *oBWriteDomesticScheduled2Param = ; // 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:oBWriteDomesticScheduled2Param
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledResponse2 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 oBWriteDomesticScheduled2Param = ; // {OBWriteDomesticScheduled2} 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(oBWriteDomesticScheduled2Param, 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 oBWriteDomesticScheduled2Param = new OBWriteDomesticScheduled2(); // OBWriteDomesticScheduled2 | 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
                OBWriteDomesticScheduledResponse2 result = apiInstance.createDomesticScheduledPayments(oBWriteDomesticScheduled2Param, 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();
$oBWriteDomesticScheduled2Param = ; // OBWriteDomesticScheduled2 | 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($oBWriteDomesticScheduled2Param, $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 $oBWriteDomesticScheduled2Param = WWW::SwaggerClient::Object::OBWriteDomesticScheduled2->new(); # OBWriteDomesticScheduled2 | 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(oBWriteDomesticScheduled2Param => $oBWriteDomesticScheduled2Param, 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()
oBWriteDomesticScheduled2Param =  # OBWriteDomesticScheduled2 | 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(oBWriteDomesticScheduled2Param, 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
oBWriteDomesticScheduled2Param *
{
Required: Data,Risk
Data:
{
Required: ConsentId,Initiation
ConsentId:
Initiation:
}
Risk:
{

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode:
MerchantCategoryCode:
MerchantCustomerIdentification:
DeliveryAddress:
}
}

Responses

Status: 201 - Domestic Scheduled Payments Created

{
Required: Data,Links,Meta
Data:
{
Required: ConsentId,CreationDateTime,DomesticScheduledPaymentId,Initiation,Status,StatusUpdateDateTime
DomesticScheduledPaymentId:
string minLength:1 maxLength:40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource.

ConsentId:
string minLength:1 maxLength:128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime:
string (date-time)

Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status:
string

Specifies the status of resource in code form.

Enum: InitiationCompleted, InitiationFailed, InitiationPending
StatusUpdateDateTime:
string (date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedExecutionDateTime:
string (date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime:
string (date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges:
[

Set of elements used to provide details of a charge for the payment initiation.

{

Set of elements used to provide details of a charge for the payment initiation.

Required: Amount,ChargeBearer,Type
ChargeBearer:
string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum: BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Type:
string

Charge type, in a coded form.

Amount:
{

Amount of money associated with the charge type.

Required: Amount,Currency
Amount:
string

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency:
string
Pattern: ^[A-Z]{3,3}$
}
}
]
Initiation:
{

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.

Required: CreditorAccount,InstructedAmount,InstructionIdentification,RequestedExecutionDateTime
InstructionIdentification:
EndToEndIdentification:
LocalInstrument:
RequestedExecutionDateTime:
InstructedAmount:
DebtorAccount:
CreditorAccount:
CreditorPostalAddress:
RemittanceInformation:
SupplementaryData:
}
MultiAuthorisation:
{

The multiple authorisation flow response from the ASPSP.

Required: Status
Status:
NumberRequired:
NumberReceived:
LastUpdateDateTime:
ExpirationDateTime:
}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

Usage and SDK Samples

curl -X GET "https://localhost/open-banking/v3.1/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 {
            OBWriteDomesticScheduledConsentResponse2 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 {
            OBWriteDomesticScheduledConsentResponse2 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: ^(OBWriteDomesticScheduledConsentResponse2 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
                OBWriteDomesticScheduledConsentResponse2 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

{
Required: Data,Links,Meta,Risk
Data:
{
Required: ConsentId,CreationDateTime,Initiation,Permission,Status,StatusUpdateDateTime
ConsentId:
string minLength:1 maxLength:128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime:
string (date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status:
string

Specifies the status of resource in code form.

Enum: Authorised, AwaitingAuthorisation, Consumed, Rejected
StatusUpdateDateTime:
string (date-time)

Date and time at which the consent resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Permission:
string

Specifies the Open Banking service request types.

Enum: Create
CutOffDateTime:
string (date-time)

Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedExecutionDateTime:
string (date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime:
string (date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges:
[

Set of elements used to provide details of a charge for the payment initiation.

{

Set of elements used to provide details of a charge for the payment initiation.

Required: Amount,ChargeBearer,Type
ChargeBearer:
string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum: BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Type:
string

Charge type, in a coded form.

Amount:
{

Amount of money associated with the charge type.

Required: Amount,Currency
Amount:
string

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency:
string
Pattern: ^[A-Z]{3,3}$
}
}
]
Initiation:
{

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.

Required: CreditorAccount,InstructedAmount,InstructionIdentification,RequestedExecutionDateTime
InstructionIdentification:
EndToEndIdentification:
LocalInstrument:
RequestedExecutionDateTime:
InstructedAmount:
DebtorAccount:
CreditorAccount:
CreditorPostalAddress:
RemittanceInformation:
SupplementaryData:
}
Authorisation:
{

The authorisation type request from the TPP.

Required: AuthorisationType
AuthorisationType:
CompletionDateTime:
}
}
Risk:
{

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode:
string

Specifies the payment context

Enum: BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty
MerchantCategoryCode:
string minLength:3 maxLength:4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification:
string minLength:1 maxLength:70

The unique customer identifier of the PSU with the merchant.

DeliveryAddress:
{

Information that locates and identifies a specific address, as defined by postal services or in free format text.

Required: Country,TownName
AddressLine:
StreetName:
BuildingNumber:
PostCode:
TownName:
CountrySubDivision:
Country:
}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

Usage and SDK Samples

curl -X GET "https://localhost/open-banking/v3.1/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 {
            OBWriteDomesticScheduledResponse2 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 {
            OBWriteDomesticScheduledResponse2 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: ^(OBWriteDomesticScheduledResponse2 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
                OBWriteDomesticScheduledResponse2 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

{
Required: Data,Links,Meta
Data:
{
Required: ConsentId,CreationDateTime,DomesticScheduledPaymentId,Initiation,Status,StatusUpdateDateTime
DomesticScheduledPaymentId:
string minLength:1 maxLength:40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource.

ConsentId:
string minLength:1 maxLength:128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime:
string (date-time)

Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status:
string

Specifies the status of resource in code form.

Enum: InitiationCompleted, InitiationFailed, InitiationPending
StatusUpdateDateTime:
string (date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedExecutionDateTime:
string (date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime:
string (date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges:
[

Set of elements used to provide details of a charge for the payment initiation.

{

Set of elements used to provide details of a charge for the payment initiation.

Required: Amount,ChargeBearer,Type
ChargeBearer:
string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum: BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Type:
string

Charge type, in a coded form.

Amount:
{

Amount of money associated with the charge type.

Required: Amount,Currency
Amount:
string

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency:
string
Pattern: ^[A-Z]{3,3}$
}
}
]
Initiation:
{

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.

Required: CreditorAccount,InstructedAmount,InstructionIdentification,RequestedExecutionDateTime
InstructionIdentification:
EndToEndIdentification:
LocalInstrument:
RequestedExecutionDateTime:
InstructedAmount:
DebtorAccount:
CreditorAccount:
CreditorPostalAddress:
RemittanceInformation:
SupplementaryData:
}
MultiAuthorisation:
{

The multiple authorisation flow response from the ASPSP.

Required: Status
Status:
NumberRequired:
NumberReceived:
LastUpdateDateTime:
ExpirationDateTime:
}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

DomesticStandingOrders

Usage and SDK Samples

curl -X POST "https://localhost/open-banking/v3.1/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();
        OBWriteDomesticStandingOrderConsent2 oBWriteDomesticStandingOrderConsent2Param = ; // OBWriteDomesticStandingOrderConsent2 | 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 {
            OBWriteDomesticStandingOrderConsentResponse2 result = apiInstance.createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent2Param, 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();
        OBWriteDomesticStandingOrderConsent2 oBWriteDomesticStandingOrderConsent2Param = ; // OBWriteDomesticStandingOrderConsent2 | 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 {
            OBWriteDomesticStandingOrderConsentResponse2 result = apiInstance.createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent2Param, 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"];

OBWriteDomesticStandingOrderConsent2 *oBWriteDomesticStandingOrderConsent2Param = ; // 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:oBWriteDomesticStandingOrderConsent2Param
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticStandingOrderConsentResponse2 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 oBWriteDomesticStandingOrderConsent2Param = ; // {OBWriteDomesticStandingOrderConsent2} 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(oBWriteDomesticStandingOrderConsent2Param, 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 oBWriteDomesticStandingOrderConsent2Param = new OBWriteDomesticStandingOrderConsent2(); // OBWriteDomesticStandingOrderConsent2 | 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
                OBWriteDomesticStandingOrderConsentResponse2 result = apiInstance.createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent2Param, 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();
$oBWriteDomesticStandingOrderConsent2Param = ; // OBWriteDomesticStandingOrderConsent2 | 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($oBWriteDomesticStandingOrderConsent2Param, $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 $oBWriteDomesticStandingOrderConsent2Param = WWW::SwaggerClient::Object::OBWriteDomesticStandingOrderConsent2->new(); # OBWriteDomesticStandingOrderConsent2 | 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(oBWriteDomesticStandingOrderConsent2Param => $oBWriteDomesticStandingOrderConsent2Param, 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()
oBWriteDomesticStandingOrderConsent2Param =  # OBWriteDomesticStandingOrderConsent2 | 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(oBWriteDomesticStandingOrderConsent2Param, 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
oBWriteDomesticStandingOrderConsent2Param *
{
Required: Data,Risk
Data:
{
Required: Initiation,Permission
Permission:
Initiation:
Authorisation:
}
Risk:
{

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode:
MerchantCategoryCode:
MerchantCustomerIdentification:
DeliveryAddress:
}
}

Responses

Status: 201 - Domestic Standing Order Consents Created

{
Required: Data,Links,Meta,Risk
Data:
{
Required: ConsentId,CreationDateTime,Initiation,Permission,Status,StatusUpdateDateTime
ConsentId:
string minLength:1 maxLength:128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime:
string (date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status:
string

Specifies the status of resource in code form.

Enum: Authorised, AwaitingAuthorisation, Consumed, Rejected
StatusUpdateDateTime:
string (date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Permission:
string

Specifies the Open Banking service request types.

Enum: Create
CutOffDateTime:
string (date-time)

Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges:
[

Set of elements used to provide details of a charge for the payment initiation.

{

Set of elements used to provide details of a charge for the payment initiation.

Required: Amount,ChargeBearer,Type
ChargeBearer:
string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum: BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Type:
string

Charge type, in a coded form.

Amount:
{

Amount of money associated with the charge type.

Required: Amount,Currency
Amount:
string

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency:
string
Pattern: ^[A-Z]{3,3}$
}
}
]
Initiation:
{

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.

Required: CreditorAccount,FirstPaymentAmount,FirstPaymentDateTime,Frequency
Frequency:
Reference:
NumberOfPayments:
FirstPaymentDateTime:
FinalPaymentDateTime:
FirstPaymentAmount:
DebtorAccount:
CreditorAccount:
SupplementaryData:
}
Authorisation:
{

The authorisation type request from the TPP.

Required: AuthorisationType
AuthorisationType:
CompletionDateTime:
}
}
Risk:
{

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode:
string

Specifies the payment context

Enum: BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty
MerchantCategoryCode:
string minLength:3 maxLength:4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification:
string minLength:1 maxLength:70

The unique customer identifier of the PSU with the merchant.

DeliveryAddress:
{

Information that locates and identifies a specific address, as defined by postal services or in free format text.

Required: Country,TownName
AddressLine:
StreetName:
BuildingNumber:
PostCode:
TownName:
CountrySubDivision:
Country:
}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

Usage and SDK Samples

curl -X POST "https://localhost/open-banking/v3.1/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();
        OBWriteDomesticStandingOrder2 oBWriteDomesticStandingOrder2Param = ; // OBWriteDomesticStandingOrder2 | 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 {
            OBWriteDomesticStandingOrderResponse2 result = apiInstance.createDomesticStandingOrders(oBWriteDomesticStandingOrder2Param, 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();
        OBWriteDomesticStandingOrder2 oBWriteDomesticStandingOrder2Param = ; // OBWriteDomesticStandingOrder2 | 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 {
            OBWriteDomesticStandingOrderResponse2 result = apiInstance.createDomesticStandingOrders(oBWriteDomesticStandingOrder2Param, 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"];

OBWriteDomesticStandingOrder2 *oBWriteDomesticStandingOrder2Param = ; // 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:oBWriteDomesticStandingOrder2Param
    xFapiFinancialId:xFapiFinancialId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiCustomerLastLoggedTime:xFapiCustomerLastLoggedTime
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticStandingOrderResponse2 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 oBWriteDomesticStandingOrder2Param = ; // {OBWriteDomesticStandingOrder2} 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(oBWriteDomesticStandingOrder2Param, 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 oBWriteDomesticStandingOrder2Param = new OBWriteDomesticStandingOrder2(); // OBWriteDomesticStandingOrder2 | 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
                OBWriteDomesticStandingOrderResponse2 result = apiInstance.createDomesticStandingOrders(oBWriteDomesticStandingOrder2Param, 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();
$oBWriteDomesticStandingOrder2Param = ; // OBWriteDomesticStandingOrder2 | 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($oBWriteDomesticStandingOrder2Param, $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 $oBWriteDomesticStandingOrder2Param = WWW::SwaggerClient::Object::OBWriteDomesticStandingOrder2->new(); # OBWriteDomesticStandingOrder2 | 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(oBWriteDomesticStandingOrder2Param => $oBWriteDomesticStandingOrder2Param, 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()
oBWriteDomesticStandingOrder2Param =  # OBWriteDomesticStandingOrder2 | 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(oBWriteDomesticStandingOrder2Param, 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
oBWriteDomesticStandingOrder2Param *
{
Required: Data,Risk
Data:
{
Required: ConsentId,Initiation
ConsentId:
Initiation:
}
Risk:
{

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode:
MerchantCategoryCode:
MerchantCustomerIdentification:
DeliveryAddress:
}
}

Responses

Status: 201 - Domestic Standing Orders Created

{
Required: Data,Links,Meta
Data:
{
Required: ConsentId,CreationDateTime,DomesticStandingOrderId,Initiation,Status,StatusUpdateDateTime
DomesticStandingOrderId:
string minLength:1 maxLength:40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order resource.

ConsentId:
string minLength:1 maxLength:128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime:
string (date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status:
string

Specifies the status of resource in code form.

Enum: InitiationCompleted, InitiationFailed, InitiationPending
StatusUpdateDateTime:
string (date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges:
[

Set of elements used to provide details of a charge for the payment initiation.

{

Set of elements used to provide details of a charge for the payment initiation.

Required: Amount,ChargeBearer,Type
ChargeBearer:
string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum: BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Type:
string

Charge type, in a coded form.

Amount:
{

Amount of money associated with the charge type.

Required: Amount,Currency
Amount:
string

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency:
string
Pattern: ^[A-Z]{3,3}$
}
}
]
Initiation:
{

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.

Required: CreditorAccount,FirstPaymentAmount,FirstPaymentDateTime,Frequency
Frequency:
Reference:
NumberOfPayments:
FirstPaymentDateTime:
FinalPaymentDateTime:
FirstPaymentAmount:
DebtorAccount:
CreditorAccount:
SupplementaryData:
}
MultiAuthorisation:
{

The multiple authorisation flow response from the ASPSP.

Required: Status
Status:
NumberRequired:
NumberReceived:
LastUpdateDateTime:
ExpirationDateTime:
}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

Usage and SDK Samples

curl -X GET "https://localhost/open-banking/v3.1/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 {
            OBWriteDomesticStandingOrderConsentResponse2 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 {
            OBWriteDomesticStandingOrderConsentResponse2 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: ^(OBWriteDomesticStandingOrderConsentResponse2 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
                OBWriteDomesticStandingOrderConsentResponse2 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

{
Required: Data,Links,Meta,Risk
Data:
{
Required: ConsentId,CreationDateTime,Initiation,Permission,Status,StatusUpdateDateTime
ConsentId:
string minLength:1 maxLength:128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime:
string (date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status:
string

Specifies the status of resource in code form.

Enum: Authorised, AwaitingAuthorisation, Consumed, Rejected
StatusUpdateDateTime:
string (date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Permission:
string

Specifies the Open Banking service request types.

Enum: Create
CutOffDateTime:
string (date-time)

Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges:
[

Set of elements used to provide details of a charge for the payment initiation.

{

Set of elements used to provide details of a charge for the payment initiation.

Required: Amount,ChargeBearer,Type
ChargeBearer:
string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum: BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Type:
string

Charge type, in a coded form.

Amount:
{

Amount of money associated with the charge type.

Required: Amount,Currency
Amount:
string

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency:
string
Pattern: ^[A-Z]{3,3}$
}
}
]
Initiation:
{

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.

Required: CreditorAccount,FirstPaymentAmount,FirstPaymentDateTime,Frequency
Frequency:
Reference:
NumberOfPayments:
FirstPaymentDateTime:
FinalPaymentDateTime:
FirstPaymentAmount:
DebtorAccount:
CreditorAccount:
SupplementaryData:
}
Authorisation:
{

The authorisation type request from the TPP.

Required: AuthorisationType
AuthorisationType:
CompletionDateTime:
}
}
Risk:
{

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode:
string

Specifies the payment context

Enum: BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty
MerchantCategoryCode:
string minLength:3 maxLength:4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification:
string minLength:1 maxLength:70

The unique customer identifier of the PSU with the merchant.

DeliveryAddress:
{

Information that locates and identifies a specific address, as defined by postal services or in free format text.

Required: Country,TownName
AddressLine:
StreetName:
BuildingNumber:
PostCode:
TownName:
CountrySubDivision:
Country:
}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

Usage and SDK Samples

curl -X GET "https://localhost/open-banking/v3.1/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 {
            OBWriteDomesticStandingOrderResponse2 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 {
            OBWriteDomesticStandingOrderResponse2 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: ^(OBWriteDomesticStandingOrderResponse2 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
                OBWriteDomesticStandingOrderResponse2 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

{
Required: Data,Links,Meta
Data:
{
Required: ConsentId,CreationDateTime,DomesticStandingOrderId,Initiation,Status,StatusUpdateDateTime
DomesticStandingOrderId:
string minLength:1 maxLength:40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order resource.

ConsentId:
string minLength:1 maxLength:128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime:
string (date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status:
string

Specifies the status of resource in code form.

Enum: InitiationCompleted, InitiationFailed, InitiationPending
StatusUpdateDateTime:
string (date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges:
[

Set of elements used to provide details of a charge for the payment initiation.

{

Set of elements used to provide details of a charge for the payment initiation.

Required: Amount,ChargeBearer,Type
ChargeBearer:
string

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum: BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Type:
string

Charge type, in a coded form.

Amount:
{

Amount of money associated with the charge type.

Required: Amount,Currency
Amount:
string

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency:
string
Pattern: ^[A-Z]{3,3}$
}
}
]
Initiation:
{

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.

Required: CreditorAccount,FirstPaymentAmount,FirstPaymentDateTime,Frequency
Frequency:
Reference:
NumberOfPayments:
FirstPaymentDateTime:
FinalPaymentDateTime:
FirstPaymentAmount:
DebtorAccount:
CreditorAccount:
SupplementaryData:
}
MultiAuthorisation:
{

The multiple authorisation flow response from the ASPSP.

Required: Status
Status:
NumberRequired:
NumberReceived:
LastUpdateDateTime:
ExpirationDateTime:
}
}
Links:
{

Links relevant to the payload

Required: Self
Self:
string (uri)
First:
string (uri)
Prev:
string (uri)
Next:
string (uri)
Last:
string (uri)
}
Meta:
MetaData {

Meta Data relevant to the payload

TotalPages:
integer (int32)
FirstAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime:
string (date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}

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

{

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Required: Code,Errors,Message
Code:
string minLength:1 maxLength:40

High level textual error code, to help categorize the errors.

Id:
string minLength:1 maxLength:40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message:
string minLength:1 maxLength:500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors:
[ (1..∞)
{
Required: ErrorCode,Message
ErrorCode:
string minLength:1 maxLength:128

Low level textual error code, e.g., UK.OBIE.Field.Missing

Message:
string minLength:1 maxLength:500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path:
string minLength:1 maxLength:500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url:
string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
]
}