PaymentInitiationAPI

DomesticPayments

createDomesticPaymentConsents

Create Domestic Payment Consents


/domestic-payment-consents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/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");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomesticConsent4 body = ; // OBWriteDomesticConsent4 | Default
        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 xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticConsentResponse5 result = apiInstance.createDomesticPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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();
        OBWriteDomesticConsent4 body = ; // OBWriteDomesticConsent4 | Default
        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 xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticConsentResponse5 result = apiInstance.createDomesticPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteDomesticConsent4 *body = ; // Default
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 *xFapiAuthDate = xFapiAuthDate_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:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticConsentResponse5 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"

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

var api = new PaymentInitiationApi.DomesticPaymentsApi()
var body = ; // {{OBWriteDomesticConsent4}} Default
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 = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All 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(bodyauthorizationxIdempotencyKeyxJwsSignature, 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";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var body = new OBWriteDomesticConsent4(); // OBWriteDomesticConsent4 | Default
            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 xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All 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
                OBWriteDomesticConsentResponse5 result = apiInstance.createDomesticPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticPaymentsApi();
$body = ; // OBWriteDomesticConsent4 | Default
$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.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $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';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteDomesticConsent4->new(); # OBWriteDomesticConsent4 | Default
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 $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All 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(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, 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'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticPaymentsApi()
body =  # OBWriteDomesticConsent4 | Default
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.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All 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(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, 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-auth-date
String
The time when the PSU last logged in with the TPP. All 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
body *

Responses

Status: 201 - Domestic Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

createDomesticPayments

Create Domestic Payments


/domestic-payments

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/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");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomestic2 body = ; // OBWriteDomestic2 | Default
        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 xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticResponse5 result = apiInstance.createDomesticPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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 body = ; // OBWriteDomestic2 | Default
        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 xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticResponse5 result = apiInstance.createDomesticPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteDomestic2 *body = ; // Default
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 *xFapiAuthDate = xFapiAuthDate_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:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticResponse5 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"

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

var api = new PaymentInitiationApi.DomesticPaymentsApi()
var body = ; // {{OBWriteDomestic2}} Default
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 = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All 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(bodyauthorizationxIdempotencyKeyxJwsSignature, 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";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var body = new OBWriteDomestic2(); // OBWriteDomestic2 | Default
            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 xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All 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
                OBWriteDomesticResponse5 result = apiInstance.createDomesticPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticPaymentsApi();
$body = ; // OBWriteDomestic2 | Default
$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.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $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';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteDomestic2->new(); # OBWriteDomestic2 | Default
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 $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All 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(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, 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'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticPaymentsApi()
body =  # OBWriteDomestic2 | Default
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.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All 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(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, 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-auth-date
String
The time when the PSU last logged in with the TPP. All 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
body *

Responses

Status: 201 - Domestic Payments Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticPaymentConsentsConsentId

Get Domestic Payment Consents


/domestic-payment-consents/{ConsentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/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");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticConsentResponse5 result = apiInstance.getDomesticPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, 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 authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticConsentResponse5 result = apiInstance.getDomesticPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, 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"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_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
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticConsentResponse5 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"

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

var api = new PaymentInitiationApi.DomesticPaymentsApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All 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, 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";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All 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
                OBWriteDomesticConsentResponse5 result = apiInstance.getDomesticPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, 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');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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, $authorization, $xFapiAuthDate, $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';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All 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, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, 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'
# Configure OAuth2 access token for authorization: default
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
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All 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, authorization, xFapiAuthDate=xFapiAuthDate, 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-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticPaymentConsentsConsentIdFundsConfirmation

Get Domestic Payment Consents Funds Confirmation


/domestic-payment-consents/{ConsentId}/funds-confirmation

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/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");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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, authorization, xFapiAuthDate, 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 authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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, authorization, xFapiAuthDate, 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"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_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
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    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"

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

var api = new PaymentInitiationApi.DomesticPaymentsApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All 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, 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";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All 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, authorization, xFapiAuthDate, 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');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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, $authorization, $xFapiAuthDate, $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';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All 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, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, 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'
# Configure OAuth2 access token for authorization: default
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
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All 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, authorization, xFapiAuthDate=xFapiAuthDate, 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-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticPaymentsDomesticPaymentId

Get Domestic Payments


/domestic-payments/{DomesticPaymentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/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");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticResponse5 result = apiInstance.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, authorization, xFapiAuthDate, 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 authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticResponse5 result = apiInstance.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, authorization, xFapiAuthDate, 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"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *domesticPaymentId = domesticPaymentId_example; // DomesticPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_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
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticResponse5 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"

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

var api = new PaymentInitiationApi.DomesticPaymentsApi()
var domesticPaymentId = domesticPaymentId_example; // {{String}} DomesticPaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All 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, 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";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var domesticPaymentId = domesticPaymentId_example;  // String | DomesticPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All 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
                OBWriteDomesticResponse5 result = apiInstance.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, authorization, xFapiAuthDate, 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');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticPaymentsApi();
$domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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, $authorization, $xFapiAuthDate, $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';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $domesticPaymentId = domesticPaymentId_example; # String | DomesticPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All 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, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, 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'
# Configure OAuth2 access token for authorization: default
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
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All 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, authorization, xFapiAuthDate=xFapiAuthDate, 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-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Payments Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

DomesticScheduledPayments

createDomesticScheduledPaymentConsents

Create Domestic Scheduled Payment Consents


/domestic-scheduled-payment-consents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/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");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduledConsent4 body = ; // OBWriteDomesticScheduledConsent4 | Default
        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 xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticScheduledConsentResponse5 result = apiInstance.createDomesticScheduledPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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();
        OBWriteDomesticScheduledConsent4 body = ; // OBWriteDomesticScheduledConsent4 | Default
        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 xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticScheduledConsentResponse5 result = apiInstance.createDomesticScheduledPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteDomesticScheduledConsent4 *body = ; // Default
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 *xFapiAuthDate = xFapiAuthDate_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:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledConsentResponse5 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"

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

var api = new PaymentInitiationApi.DomesticScheduledPaymentsApi()
var body = ; // {{OBWriteDomesticScheduledConsent4}} Default
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 = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All 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(bodyauthorizationxIdempotencyKeyxJwsSignature, 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";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var body = new OBWriteDomesticScheduledConsent4(); // OBWriteDomesticScheduledConsent4 | Default
            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 xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All 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
                OBWriteDomesticScheduledConsentResponse5 result = apiInstance.createDomesticScheduledPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticScheduledPaymentsApi();
$body = ; // OBWriteDomesticScheduledConsent4 | Default
$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.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $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';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteDomesticScheduledConsent4->new(); # OBWriteDomesticScheduledConsent4 | Default
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 $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All 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(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, 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'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticScheduledPaymentsApi()
body =  # OBWriteDomesticScheduledConsent4 | Default
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.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All 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(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, 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-auth-date
String
The time when the PSU last logged in with the TPP. All 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
body *

Responses

Status: 201 - Domestic Scheduled Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

createDomesticScheduledPayments

Create Domestic Scheduled Payments


/domestic-scheduled-payments

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/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");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduled2 body = ; // OBWriteDomesticScheduled2 | Default
        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 xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticScheduledResponse5 result = apiInstance.createDomesticScheduledPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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 body = ; // OBWriteDomesticScheduled2 | Default
        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 xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticScheduledResponse5 result = apiInstance.createDomesticScheduledPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteDomesticScheduled2 *body = ; // Default
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 *xFapiAuthDate = xFapiAuthDate_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:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledResponse5 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"

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

var api = new PaymentInitiationApi.DomesticScheduledPaymentsApi()
var body = ; // {{OBWriteDomesticScheduled2}} Default
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 = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All 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(bodyauthorizationxIdempotencyKeyxJwsSignature, 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";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var body = new OBWriteDomesticScheduled2(); // OBWriteDomesticScheduled2 | Default
            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 xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All 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
                OBWriteDomesticScheduledResponse5 result = apiInstance.createDomesticScheduledPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticScheduledPaymentsApi();
$body = ; // OBWriteDomesticScheduled2 | Default
$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.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $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';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteDomesticScheduled2->new(); # OBWriteDomesticScheduled2 | Default
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 $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All 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(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, 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'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticScheduledPaymentsApi()
body =  # OBWriteDomesticScheduled2 | Default
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.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All 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(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, 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-auth-date
String
The time when the PSU last logged in with the TPP. All 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
body *

Responses

Status: 201 - Domestic Scheduled Payments Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticScheduledPaymentConsentsConsentId

Get Domestic Scheduled Payment Consents


/domestic-scheduled-payment-consents/{ConsentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/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");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticScheduledConsentResponse5 result = apiInstance.getDomesticScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, 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 authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticScheduledConsentResponse5 result = apiInstance.getDomesticScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, 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"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_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
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledConsentResponse5 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"

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

var api = new PaymentInitiationApi.DomesticScheduledPaymentsApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All 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, 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";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All 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
                OBWriteDomesticScheduledConsentResponse5 result = apiInstance.getDomesticScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, 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');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticScheduledPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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, $authorization, $xFapiAuthDate, $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';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All 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, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, 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'
# Configure OAuth2 access token for authorization: default
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
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All 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, authorization, xFapiAuthDate=xFapiAuthDate, 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-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Scheduled Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticScheduledPaymentsDomesticScheduledPaymentId

Get Domestic Scheduled Payments


/domestic-scheduled-payments/{DomesticScheduledPaymentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/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");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        String domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticScheduledResponse5 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, authorization, xFapiAuthDate, 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 authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticScheduledResponse5 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, authorization, xFapiAuthDate, 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"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *domesticScheduledPaymentId = domesticScheduledPaymentId_example; // DomesticScheduledPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_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
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledResponse5 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"

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

var api = new PaymentInitiationApi.DomesticScheduledPaymentsApi()
var domesticScheduledPaymentId = domesticScheduledPaymentId_example; // {{String}} DomesticScheduledPaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All 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, 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";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var domesticScheduledPaymentId = domesticScheduledPaymentId_example;  // String | DomesticScheduledPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All 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
                OBWriteDomesticScheduledResponse5 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, authorization, xFapiAuthDate, 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');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticScheduledPaymentsApi();
$domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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, $authorization, $xFapiAuthDate, $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';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $domesticScheduledPaymentId = domesticScheduledPaymentId_example; # String | DomesticScheduledPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All 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, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, 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'
# Configure OAuth2 access token for authorization: default
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
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All 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, authorization, xFapiAuthDate=xFapiAuthDate, 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-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Scheduled Payments Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

DomesticStandingOrders

createDomesticStandingOrderConsents

Create Domestic Standing Order Consents


/domestic-standing-order-consents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/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");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrderConsent5 body = ; // OBWriteDomesticStandingOrderConsent5 | Default
        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 xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticStandingOrderConsentResponse6 result = apiInstance.createDomesticStandingOrderConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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();
        OBWriteDomesticStandingOrderConsent5 body = ; // OBWriteDomesticStandingOrderConsent5 | Default
        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 xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticStandingOrderConsentResponse6 result = apiInstance.createDomesticStandingOrderConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteDomesticStandingOrderConsent5 *body = ; // Default
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 *xFapiAuthDate = xFapiAuthDate_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:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticStandingOrderConsentResponse6 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"

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

var api = new PaymentInitiationApi.DomesticStandingOrdersApi()
var body = ; // {{OBWriteDomesticStandingOrderConsent5}} Default
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 = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All 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(bodyauthorizationxIdempotencyKeyxJwsSignature, 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";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            var body = new OBWriteDomesticStandingOrderConsent5(); // OBWriteDomesticStandingOrderConsent5 | Default
            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 xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All 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
                OBWriteDomesticStandingOrderConsentResponse6 result = apiInstance.createDomesticStandingOrderConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticStandingOrdersApi();
$body = ; // OBWriteDomesticStandingOrderConsent5 | Default
$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.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $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';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteDomesticStandingOrderConsent5->new(); # OBWriteDomesticStandingOrderConsent5 | Default
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 $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All 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(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, 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'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticStandingOrdersApi()
body =  # OBWriteDomesticStandingOrderConsent5 | Default
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.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All 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(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, 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-auth-date
String
The time when the PSU last logged in with the TPP. All 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
body *

Responses

Status: 201 - Domestic Standing Order Consents Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

createDomesticStandingOrders

Create Domestic Standing Orders


/domestic-standing-orders

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/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");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrder3 body = ; // OBWriteDomesticStandingOrder3 | Default
        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 xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticStandingOrderResponse6 result = apiInstance.createDomesticStandingOrders(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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();
        OBWriteDomesticStandingOrder3 body = ; // OBWriteDomesticStandingOrder3 | Default
        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 xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All 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 {
            OBWriteDomesticStandingOrderResponse6 result = apiInstance.createDomesticStandingOrders(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, 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"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteDomesticStandingOrder3 *body = ; // Default
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 *xFapiAuthDate = xFapiAuthDate_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:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticStandingOrderResponse6 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"

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

var api = new PaymentInitiationApi.DomesticStandingOrdersApi()
var body = ; // {{OBWriteDomesticStandingOrder3}} Default
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 = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All 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(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);