PISP Domestic Scheduled Payments REST API HFX

PISP Domestic Scheduled Payments REST API HFX v3.1.10

0
No votes yet
Domestic Scheduled Payments

Swagger for PISP Domestic Scheduled Payments API Specification

expand_moreexpand_lessContact information
Service Desk
expand_moreexpand_lessLicense
https://www.openbanking.org.uk/terms
production
https://secure-api.lloydsbank.com/prod01/lbg
production
https://secure-api-eidas.halifax.co.uk/prod01/lbg
production
https://secure-api-eidas.bankofscotland.co.uk/prod01/lbg
production
https://secure-api.mbna.co.uk/prod01/lbg
production
https://secure-api.halifax.co.uk/prod01/lbg
production
https://secure-api.bankofscotland.co.uk/prod01/lbg
production
https://secure-api-eidas.mbna.co.uk/prod01/lbg
production
https://secure-api-eidas.lloydsbank.com/prod01/lbg

Paths

/domestic-scheduled-payment-consents

post /domestic-scheduled-payment-consents
Domestic Scheduled Payment Consents

Creates a domestic scheduled payment consents resource.

Creates a Domestic Scheduled Payment Consents.

TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)

TPP client credential authorisation flow with the ASPSP

Token URL
https://secure-api.halifax.co.uk/prod01/lbg/hfx/oidc-api/v1.1/token
Scopes
payments
Generic payment scopes
x-idempotency-key
Required in header
string

Every request will be processed only once per x-idempotency-key.

x-fapi-financial-id
Required in header
string

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-time
Optional in header
string

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

{
    "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} (GMT|UTC)$"
}
x-fapi-interaction-id
Optional in header
string

An RFC4122 UID used as a correlation ID.

{
    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}
body
Required in body
object

Domestic Scheduled Payment consent POST body

{
    "schema": {
        "type": "object",
        "required": [
            "Data",
            "Risk"
        ],
        "properties": {
            "Data": {
                "$ref": "#\/definitions\/DomesticScheduledPaymentConsentData"
            },
            "Risk": {
                "$ref": "#\/definitions\/Risk"
            }
        }
    }
}
x-jws-signature
Required in header
string

A detached JWS signature of the body of the payload.

Authorization
Required in header
string

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Content-Type
Optional in header
string
application/json;charset=UTF-8
Accept
Optional in header
string
application/json;charset=UTF-8
201

Created

DomesticScheduledPaymentConsentResponse
400

Bad request

401

Unauthorized

403

Forbidden

404

Resource not found

500

Internal server error

Example Request
curl --request POST \
  --url https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents \
  --header 'Authorization: REPLACE_THIS_VALUE' \
  --header 'accept: application/json;charset=UTF-8' \
  --header 'content-type: application/json;charset=UTF-8' \
  --header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
  --header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
  --header 'x-fapi-interaction-id: REPLACE_THIS_VALUE' \
  --header 'x-idempotency-key: REPLACE_THIS_VALUE' \
  --header 'x-jws-signature: REPLACE_THIS_VALUE' \
  --data '{"Data":{"Permission":"Create","ReadRefundAccount":"No","Initiation":{"InstructionIdentification":"2818313772072960","EndToEndIdentification":"4434295705829376","LocalInstrument":"UK:Bacs","RequestedExecutionDateTime":"4/18/2108","InstructedAmount":{"Amount":"486928618339.14","Currency":"GBP"},"DebtorAccount":{"SchemeName":"IBAN","Identification":"2657728990281728","Name":"Nathaniel Williams","SecondaryIdentification":"4945527812653056"},"CreditorAccount":{"SchemeName":"SortCodeAccountNumber","Identification":"1724724742717440","Name":"Rodney Mitchell","SecondaryIdentification":"1101001016737792"},"CreditorPostalAddress":{"AddressType":"DeliveryTo","Department":"isoaprebivfo","SubDepartment":"kodoacfe","StreetName":"Idosa Lane","BuildingNumber":"3819400364818432","PostCode":"A2K 8V6","TownName":"Leona Hughes","CountrySubDivision":"Mauritius","Country":"JI","AddressLine":["zasvuphewhoifeawdahsejinniweobukezabulariwuggohafacsirurl","jehnupoavenodoluhagigjallonupadahudufzokwezdaukhoawheovcafujtagicem","ijvidhonemulelninwalarobnefwukuhgodwekahuwococeface","kisatneehemegcidkohiravikutdauwk","pukoguvafuhadualuhugazeulnisinobruwobinuvginugaduulvolru"]},"RemittanceInformation":{"Unstructured":"sajedjizuavbuzu","Reference":"vehzuzti"},"SupplementaryData":{"DebitAccountReference":{"Reference":"wewapewtu"}}},"Authorisation":{"AuthorisationType":"Any","CompletionDateTime":"2004-06-05T21:52:10
Show more open_in_new
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'REPLACE_THIS_VALUE'
request["x-idempotency-key"] = 'REPLACE_THIS_VALUE'
request["x-fapi-financial-id"] = 'REPLACE_THIS_VALUE'
request["x-fapi-customer-last-logged-time"] = 'REPLACE_THIS_VALUE'
request["x-fapi-interaction-id"] = 'REPLACE_THIS_VALUE'
request["x-jws-signature"] = 'REPLACE_THIS_VALUE'
request["content-type"] = 'application/json;charset=UTF-8'
request["accept"] = 'application/json;charset=UTF-8'
request.body = "{\"Data\":{\"Permission\":\"Create\",\"ReadRefundAccount\":\"No\",\"Initiation\":{\"InstructionIdentification\":\"2818313772072960\",\"EndToEndIdentification\":\"4434295705829376\",\"LocalInstrument\":\"UK:Bacs\",\"RequestedExecutionDateTime\":\"4/18/2108\",\"InstructedAmount\":{\"Amount\":\"486928618339.14\",\"Currency\":\"GBP\"},\"DebtorAccount\":{\"SchemeName\":\"IBAN\",\"Identification\":\"2657728990281728\",\"Name\":\"Nathaniel Williams\",\"SecondaryIdentification\":\"4945527812653056\"},\"CreditorAccount\":{\"SchemeName\":\"SortCodeAccountNumber\",\"Identification\":\"1724724742717440\",\"Name\":\"Rodney Mitchell\",\"SecondaryIdentification\":\"1101001016737792\"},\"CreditorPostalAddress\":{\"AddressType\":\"DeliveryTo\",\"Department\":\"isoaprebivfo\",\"SubDepartment\":\"kodoacfe\",\"StreetName\":\"Idosa Lane\",\"BuildingNumber\":\"3819400364818432\",\"PostCode\":\"A2K 8V6\",\"TownName\":\"Leona Hughes\",\"CountrySubDivision\":\"Mauritius\",\"Country\":\"JI\",\"AddressLine\":[\"zasvuphewhoifeawdahsejinniweobukezabulariwuggohafacsirurl\",\"jehnupoavenodoluhagigjallonupadahudufzokwezdaukhoawheovcafujtagicem\",\"ijvidhonemulelninwalarobnefwukuhgodwekahuwococeface\",\"kisatneehemegcidkohiravikutdauwk\",\"pu
Show more open_in_new
import http.client

conn = http.client.HTTPSConnection("secure-api.lloydsbank.com")

payload = "{\"Data\":{\"Permission\":\"Create\",\"ReadRefundAccount\":\"No\",\"Initiation\":{\"InstructionIdentification\":\"2818313772072960\",\"EndToEndIdentification\":\"4434295705829376\",\"LocalInstrument\":\"UK:Bacs\",\"RequestedExecutionDateTime\":\"4/18/2108\",\"InstructedAmount\":{\"Amount\":\"486928618339.14\",\"Currency\":\"GBP\"},\"DebtorAccount\":{\"SchemeName\":\"IBAN\",\"Identification\":\"2657728990281728\",\"Name\":\"Nathaniel Williams\",\"SecondaryIdentification\":\"4945527812653056\"},\"CreditorAccount\":{\"SchemeName\":\"SortCodeAccountNumber\",\"Identification\":\"1724724742717440\",\"Name\":\"Rodney Mitchell\",\"SecondaryIdentification\":\"1101001016737792\"},\"CreditorPostalAddress\":{\"AddressType\":\"DeliveryTo\",\"Department\":\"isoaprebivfo\",\"SubDepartment\":\"kodoacfe\",\"StreetName\":\"Idosa Lane\",\"BuildingNumber\":\"3819400364818432\",\"PostCode\":\"A2K 8V6\",\"TownName\":\"Leona Hughes\",\"CountrySubDivision\":\"Mauritius\",\"Country\":\"JI\",\"AddressLine\":[\"zasvuphewhoifeawdahsejinniweobukezabulariwuggohafacsirurl\",\"jehnupoavenodoluhagigjallonupadahudufzokwezdaukhoawheovcafujtagicem\",\"ijvidhonemulelninwalarobnefwukuhgodwekahuwococeface\",\"kisatneehemegcidkohiravikutdauwk\",\"pukoguvafuhadualuhugazeulnisinobruwobinuvginugaduulvolru\"]},\"RemittanceInformation\":{\"Unstructured\":\"sajedjizuavbuzu\",\"Reference\":\"vehzuzti\"},\"SupplementaryData\":{\"DebitAccountReference\":{\"Reference\":\"wewapewtu\"}}},\"Authorisation\":{\"AuthorisationType\":\"Any\",\"CompletionDateTime\":\"2004-06-05T21:52:10.515Z\"},\"SCASupportData\":{\"RequestedSCAExemptionType\":\"EcommerceServices\",\"AppliedAuthenticationApproach\":\"SCA\",\"ReferencePaymentOrderId\":\"4104655835496448\"}},\"Risk\":{\"PaymentContextCode\":\"BillingGoodsAndServicesInAdvance\",\"MerchantCategoryCode\":\"vozegka\",\"MerchantCustomerIdentification\":\"6986716147613696\",\"ContractPre
Show more open_in_new
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"Data\":{\"Permission\":\"Create\",\"ReadRefundAccount\":\"No\",\"Initiation\":{\"InstructionIdentification\":\"2818313772072960\",\"EndToEndIdentification\":\"4434295705829376\",\"LocalInstrument\":\"UK:Bacs\",\"RequestedExecutionDateTime\":\"4/18/2108\",\"InstructedAmount\":{\"Amount\":\"486928618339.14\",\"Currency\":\"GBP\"},\"DebtorAccount\":{\"SchemeName\":\"IBAN\",\"Identification\":\"2657728990281728\",\"Name\":\"Nathaniel Williams\",\"SecondaryIdentification\":\"4945527812653056\"},\"CreditorAccount\":{\"SchemeName\":\"SortCodeAccountNumber\",\"Identification\":\"1724724742717440\",\"Name\":\"Rodney Mitchell\",\"SecondaryIdentification\":\"1101001016737792\"},\"CreditorPostalAddress\":{\"AddressType\":\"DeliveryTo\",\"Department\":\"isoaprebivfo\",\"SubDepartment\":\"kodoacfe\",\"StreetName\":\"Idosa Lane\",\"BuildingNumber\":\"3819400364818432\",\"PostCode\":\"A2K 8V6\",\"TownName\":\"Leona Hughes\",\"CountrySubDivision\":\"Mauritius\",\"Country\":\"JI\",\"AddressLine\":[\"zasvuphewhoifeawdahsejinniweobukezabulariwuggohafacsirurl\",\"jehnupoavenodoluhagigjallonupadahudufzokwezdaukhoawheovcafujtagicem\",\"ijvidhonemulelninwalarobnefwukuhgodwekahuwococeface\",\"kisatneehemegcidkohiravikutdauwk\",\"pukoguvafuhadualuhugazeulnisinobruwobinuvginugaduulvolru\"]},\"RemittanceInformation\":{\"Unstructured\":\"sajedjizuavbuzu\",\"Reference\":\"vehzuzti\"},\"SupplementaryData\":{\"DebitAccountReference\":{\"Reference\":\"wewapewtu\"}}},\"Authorisation\":{\"AuthorisationType\":\"Any\",\"CompletionDateTime\":\"2004-06-05T21:52:10.515Z\"},\"SCASupportData\":{\"RequestedS
Show more open_in_new
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json;charset=UTF-8");
RequestBody body = RequestBody.create(mediaType, "{\"Data\":{\"Permission\":\"Create\",\"ReadRefundAccount\":\"No\",\"Initiation\":{\"InstructionIdentification\":\"2818313772072960\",\"EndToEndIdentification\":\"4434295705829376\",\"LocalInstrument\":\"UK:Bacs\",\"RequestedExecutionDateTime\":\"4/18/2108\",\"InstructedAmount\":{\"Amount\":\"486928618339.14\",\"Currency\":\"GBP\"},\"DebtorAccount\":{\"SchemeName\":\"IBAN\",\"Identification\":\"2657728990281728\",\"Name\":\"Nathaniel Williams\",\"SecondaryIdentification\":\"4945527812653056\"},\"CreditorAccount\":{\"SchemeName\":\"SortCodeAccountNumber\",\"Identification\":\"1724724742717440\",\"Name\":\"Rodney Mitchell\",\"SecondaryIdentification\":\"1101001016737792\"},\"CreditorPostalAddress\":{\"AddressType\":\"DeliveryTo\",\"Department\":\"isoaprebivfo\",\"SubDepartment\":\"kodoacfe\",\"StreetName\":\"Idosa Lane\",\"BuildingNumber\":\"3819400364818432\",\"PostCode\":\"A2K 8V6\",\"TownName\":\"Leona Hughes\",\"CountrySubDivision\":\"Mauritius\",\"Country\":\"JI\",\"AddressLine\":[\"zasvuphewhoifeawdahsejinniweobukezabulariwuggohafacsirurl\",\"jehnupoavenodoluhagigjallonupadahudufzokwezdaukhoawheovcafujtagicem\",\"ijvidhonemulelninwalarobnefwukuhgodwekahuwococeface\",\"kisatneehemegcidkohiravikutdauwk\",\"pukoguvafuhadualuhugazeulnisinobruwobinuvginugaduulvolru\"]},\"RemittanceInformation\":{\"Unstructured\":\"sajedjizuavbuzu\",\"Reference\":\"vehzuzti\"},\"SupplementaryData\":{\"DebitAccountReference\":{\"Reference\":\"wewapewtu\"}}},\"Authorisation\":{\"AuthorisationType\":\"Any\",\"CompletionDateTime\":\"2004-06-05T21:52:10.515Z\"},\"SCASupportData\":{\"RequestedSCAExemptionType\":\"EcommerceServices\",\"AppliedAuthenticationApproach\":\"SCA\",\"ReferencePaymentOrderId\":\"4104655835496448\"}},\"Risk\":{\"PaymentContextCode\":\"BillingGoodsAndServicesInAdvance\",\"MerchantCategoryCode\":\"vozegka\"
Show more open_in_new
const request = require('request');

const options = {
  method: 'POST',
  url: 'https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents',
  headers: {
    Authorization: 'REPLACE_THIS_VALUE',
    'x-idempotency-key': 'REPLACE_THIS_VALUE',
    'x-fapi-financial-id': 'REPLACE_THIS_VALUE',
    'x-fapi-customer-last-logged-time': 'REPLACE_THIS_VALUE',
    'x-fapi-interaction-id': 'REPLACE_THIS_VALUE',
    'x-jws-signature': 'REPLACE_THIS_VALUE',
    'content-type': 'application/json;charset=UTF-8',
    accept: 'application/json;charset=UTF-8'
  },
  body: '{"Data":{"Permission":"Create","ReadRefundAccount":"No","Initiation":{"InstructionIdentification":"2818313772072960","EndToEndIdentification":"4434295705829376","LocalInstrument":"UK:Bacs","RequestedExecutionDateTime":"4/18/2108","InstructedAmount":{"Amount":"486928618339.14","Currency":"GBP"},"DebtorAccount":{"SchemeName":"IBAN","Identification":"2657728990281728","Name":"Nathaniel Williams","SecondaryIdentification":"4945527812653056"},"CreditorAccount":{"SchemeName":"SortCodeAccountNumber","Identification":"1724724742717440","Name":"Rodney Mitchell","SecondaryIdentification":"1101001016737792"},"CreditorPostalAddress":{"AddressType":"DeliveryTo","Department":"isoaprebivfo","SubDepartment":"kodoacfe","StreetName":"Idosa Lane","BuildingNumber":"3819400364818432","PostCode":"A2K 8V6","TownName":"Leona Hughes","CountrySubDivision":"Mauritius","Country":"JI","AddressLine":["zasvuphewhoifeawdahsejinniweobukezabulariwuggohafacsirurl","jehnupoavenodoluhagigjallonupadahudufzokwezdaukhoawheovcafujtagicem","ijvidhonemulelninwalarobnefwukuhgodwekahuwococeface","kisatneehemegcidkohiravikutdauwk","pukoguvafuhadualuhugazeulnisinobruwobinuvginugaduulvolru"]},"RemittanceInformation":{"Unstructured":"sajedjizuavbuzu","Reference":"vehzuzti"},"SupplementaryData":{"DebitAccountReference":{"Reference":"wewapewtu"}}},"Authorisation":{"AuthorisationType":"Any","CompletionDateTime":"2004
Show more open_in_new
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents"

	payload := strings.NewReader("{\"Data\":{\"Permission\":\"Create\",\"ReadRefundAccount\":\"No\",\"Initiation\":{\"InstructionIdentification\":\"2818313772072960\",\"EndToEndIdentification\":\"4434295705829376\",\"LocalInstrument\":\"UK:Bacs\",\"RequestedExecutionDateTime\":\"4/18/2108\",\"InstructedAmount\":{\"Amount\":\"486928618339.14\",\"Currency\":\"GBP\"},\"DebtorAccount\":{\"SchemeName\":\"IBAN\",\"Identification\":\"2657728990281728\",\"Name\":\"Nathaniel Williams\",\"SecondaryIdentification\":\"4945527812653056\"},\"CreditorAccount\":{\"SchemeName\":\"SortCodeAccountNumber\",\"Identification\":\"1724724742717440\",\"Name\":\"Rodney Mitchell\",\"SecondaryIdentification\":\"1101001016737792\"},\"CreditorPostalAddress\":{\"AddressType\":\"DeliveryTo\",\"Department\":\"isoaprebivfo\",\"SubDepartment\":\"kodoacfe\",\"StreetName\":\"Idosa Lane\",\"BuildingNumber\":\"3819400364818432\",\"PostCode\":\"A2K 8V6\",\"TownName\":\"Leona Hughes\",\"CountrySubDivision\":\"Mauritius\",\"Country\":\"JI\",\"AddressLine\":[\"zasvuphewhoifeawdahsejinniweobukezabulariwuggohafacsirurl\",\"jehnupoavenodoluhagigjallonupadahudufzokwezdaukhoawheovcafujtagicem\",\"ijvidhonemulelninwalarobnefwukuhgodwekahuwococeface\",\"kisatneehemegcidkohiravikutdauwk\",\"pukoguvafuhadualuhugazeulnisinobruwobinuvginugaduulvolru\"]},\"RemittanceInformation\":{\"Unstructured\":\"sajedjizuavbuzu\",\"Reference\":\"vehzuzti\"},\"SupplementaryData\":{\"DebitAccountReference\":{\"Reference\":\"wewapewtu\"}}},\"Authorisation\":{\"AuthorisationType\":\"Any\",\"CompletionDateTime\":\"2004-06-05T21:52:10.515Z\"},\"SCASupportData\":{\"RequestedSCAExemptionType\":\"EcommerceServices\",\"AppliedAuthenticationApproach\":\"SCA\",\"ReferencePaymentOrderId\":\"4104655835496448\"}},\"Risk\":{\"PaymentContextCode\":\"Bil
Show more open_in_new
import Foundation

let headers = [
  "Authorization": "REPLACE_THIS_VALUE",
  "x-idempotency-key": "REPLACE_THIS_VALUE",
  "x-fapi-financial-id": "REPLACE_THIS_VALUE",
  "x-fapi-customer-last-logged-time": "REPLACE_THIS_VALUE",
  "x-fapi-interaction-id": "REPLACE_THIS_VALUE",
  "x-jws-signature": "REPLACE_THIS_VALUE",
  "content-type": "application/json;charset=UTF-8",
  "accept": "application/json;charset=UTF-8"
]

let postData = NSData(data: "{"Data":{"Permission":"Create","ReadRefundAccount":"No","Initiation":{"InstructionIdentification":"2818313772072960","EndToEndIdentification":"4434295705829376","LocalInstrument":"UK:Bacs","RequestedExecutionDateTime":"4/18/2108","InstructedAmount":{"Amount":"486928618339.14","Currency":"GBP"},"DebtorAccount":{"SchemeName":"IBAN","Identification":"2657728990281728","Name":"Nathaniel Williams","SecondaryIdentification":"4945527812653056"},"CreditorAccount":{"SchemeName":"SortCodeAccountNumber","Identification":"1724724742717440","Name":"Rodney Mitchell","SecondaryIdentification":"1101001016737792"},"CreditorPostalAddress":{"AddressType":"DeliveryTo","Department":"isoaprebivfo","SubDepartment":"kodoacfe","StreetName":"Idosa Lane","BuildingNumber":"3819400364818432","PostCode":"A2K 8V6","TownName":"Leona Hughes","CountrySubDivision":"Mauritius","Country":"JI","AddressLine":["zasvuphewhoifeawdahsejinniweobukezabulariwuggohafacsirurl","jehnupoavenodoluhagigjallonupadahudufzokwezdaukhoawheovcafujtagicem","ijvidhonemulelninwalarobnefwukuhgodwekahuwococeface","kisatneehemegcidkohiravikutdauwk","pukoguvafuhadualuhugazeulnisinobruwobinuvginugaduulvolru"]},"RemittanceInformation":{"Unstructured":"sajedjizuavbuzu","Reference":"vehzuzti"},"SupplementaryData":{"DebitAccountReference":{"Reference":"wewapewtu"}}},"Authorisation":{"AuthorisationType":"Any","CompletionDateTime":"2004-06-05T21:52:10.515Z"},"SCASupportData":{"RequestedSCAExemptionType":"EcommerceServices","AppliedAuthenticationApproach":"SCA","ReferencePaymentOrderId":"410465583
Show more open_in_new
Example Response
POST https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents
{
  "Data": {
    "ConsentId": "1277613620330496",
    "CreationDateTime": "2015-01-25T17:25:26.171Z",
    "Status": "Rejected",
    "StatusUpdateDateTime": "2005-05-30T17:27:54.224Z",
    "Permission": "Create",
    "ReadRefundAccount": "No",
    "CutOffDateTime": "2024-11-13T13:30:34.195Z",
    "ExpectedExecutionDateTime": "2018-02-04T22:11:03.846Z",
    "ExpectedSettlementDateTime": "2021-10-20T21:56:38.614Z",
    "Charges": [
      {
        "ChargeBearer": "Shared",
        "Type": "zojnabi",
        "Amount": {
          "Amount": "691486293910",
          "Currency": "GBP"
        }
      },
      {
        "ChargeBearer": "Shared",
        "Type": "rizbuuporu",
        "Amount": {
          "Amount": "5593.2",
          "Currency": "GBP"
        }
      },
      {
        "ChargeBearer": "BorneByDebtor",
        "Type": "rifocorusoh",
        "Amount": {
          "Amount": "478812",
          "Currency": "GBP"
        }
      }
    ],
    "Initiation": {
      "InstructionIden
Show more open_in_new
Try this operation
https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents
Login to test this API.
payments
content-type
accept
x-idempotency-key
x-fapi-financial-id
x-fapi-customer-last-logged-time
x-fapi-interaction-id
x-jws-signature
Authorization

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

get /domestic-scheduled-payment-consents/{ConsentId}
Domestic Scheduled Payment Consents

Get a domestic scheduled payment consents.

Get a Domestic Scheduled Payment Consents.

TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)

TPP client credential authorisation flow with the ASPSP

Token URL
https://secure-api.halifax.co.uk/prod01/lbg/hfx/oidc-api/v1.1/token
Scopes
payments
Generic payment scopes
ConsentId
Required in path
string

A unique identifier used to identify the consent

x-fapi-financial-id
Required in header
string

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-time
Optional in header
string

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

{
    "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} (GMT|UTC)$"
}
x-fapi-interaction-id
Optional in header
string

An RFC4122 UID used as a correlation ID.

{
    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}
Authorization
Required in header
string

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Accept
Optional in header
string
application/json;charset=UTF-8
200

OK

DomesticScheduledPaymentConsentResponse
401

Unauthorized

403

Forbidden

404

Resource not found

500

Internal server error

Example Request
curl --request GET \
  --url https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/REPLACE_CONSENTID \
  --header 'Authorization: REPLACE_THIS_VALUE' \
  --header 'accept: application/json;charset=UTF-8' \
  --header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
  --header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
  --header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/REPLACE_CONSENTID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'REPLACE_THIS_VALUE'
request["x-fapi-financial-id"] = 'REPLACE_THIS_VALUE'
request["x-fapi-customer-last-logged-time"] = 'REPLACE_THIS_VALUE'
request["x-fapi-interaction-id"] = 'REPLACE_THIS_VALUE'
request["accept"] = 'application/json;charset=UTF-8'

response = http.request(request)
puts response.read_body
import http.client

conn = http.client.HTTPSConnection("secure-api.lloydsbank.com")

headers = {
    'Authorization': "REPLACE_THIS_VALUE",
    'x-fapi-financial-id': "REPLACE_THIS_VALUE",
    'x-fapi-customer-last-logged-time': "REPLACE_THIS_VALUE",
    'x-fapi-interaction-id': "REPLACE_THIS_VALUE",
    'accept': "application/json;charset=UTF-8"
    }

conn.request("GET", "/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/REPLACE_CONSENTID", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/REPLACE_CONSENTID",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: REPLACE_THIS_VALUE",
    "accept: application/json;charset=UTF-8",
    "x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE",
    "x-fapi-financial-id: REPLACE_THIS_VALUE",
    "x-fapi-interaction-id: REPLACE_THIS_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/REPLACE_CONSENTID")
  .get()
  .addHeader("Authorization", "REPLACE_THIS_VALUE")
  .addHeader("x-fapi-financial-id", "REPLACE_THIS_VALUE")
  .addHeader("x-fapi-customer-last-logged-time", "REPLACE_THIS_VALUE")
  .addHeader("x-fapi-interaction-id", "REPLACE_THIS_VALUE")
  .addHeader("accept", "application/json;charset=UTF-8")
  .build();

Response response = client.newCall(request).execute();
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/REPLACE_CONSENTID',
  headers: {
    Authorization: 'REPLACE_THIS_VALUE',
    'x-fapi-financial-id': 'REPLACE_THIS_VALUE',
    'x-fapi-customer-last-logged-time': 'REPLACE_THIS_VALUE',
    'x-fapi-interaction-id': 'REPLACE_THIS_VALUE',
    accept: 'application/json;charset=UTF-8'
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/REPLACE_CONSENTID"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "REPLACE_THIS_VALUE")
	req.Header.Add("x-fapi-financial-id", "REPLACE_THIS_VALUE")
	req.Header.Add("x-fapi-customer-last-logged-time", "REPLACE_THIS_VALUE")
	req.Header.Add("x-fapi-interaction-id", "REPLACE_THIS_VALUE")
	req.Header.Add("accept", "application/json;charset=UTF-8")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
import Foundation

let headers = [
  "Authorization": "REPLACE_THIS_VALUE",
  "x-fapi-financial-id": "REPLACE_THIS_VALUE",
  "x-fapi-customer-last-logged-time": "REPLACE_THIS_VALUE",
  "x-fapi-interaction-id": "REPLACE_THIS_VALUE",
  "accept": "application/json;charset=UTF-8"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/REPLACE_CONSENTID")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
Example Response
GET https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/{ConsentId}
{
  "Data": {
    "ConsentId": "2737346084601856",
    "CreationDateTime": "2016-11-24T10:23:25.968Z",
    "Status": "Rejected",
    "StatusUpdateDateTime": "2020-07-07T15:54:44.457Z",
    "Permission": "Create",
    "ReadRefundAccount": "No",
    "CutOffDateTime": "2025-01-24T08:27:36.227Z",
    "ExpectedExecutionDateTime": "2017-03-27T01:24:36.435Z",
    "ExpectedSettlementDateTime": "2006-01-06T14:02:43.880Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByDebtor",
        "Type": "bibtujmij",
        "Amount": {
          "Amount": "176192",
          "Currency": "GBP"
        }
      },
      {
        "ChargeBearer": "FollowingServiceLevel",
        "Type": "fazjaguwa",
        "Amount": {
          "Amount": "26624104.83",
          "Currency": "GBP"
        }
      },
      {
        "ChargeBearer": "Shared",
        "Type": "rumibjorkuwg",
        "Amount": {
          "Amount": "759007274",
          "Currency": "GBP"
        }
      }
    ],
    "Initiation": {
Show more open_in_new
Try this operation
https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/{ConsentId}
Login to test this API.
payments
accept
x-fapi-financial-id
x-fapi-customer-last-logged-time
x-fapi-interaction-id
Authorization
ConsentId

/domestic-scheduled-payments

post /domestic-scheduled-payments
Domestic Scheduled Payments

Creates a domestic scheduled payments resource.

Creates a Domestic Scheduled Payments resource.

PSUOAuth2Security
PSUOAuth2Security
(oauth2 accessCode)

OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU. Please refer to the well known endpoint or the Technical Implementation Guide for any additional information.

Authorization URL
https://authorise-api.halifax-online.co.uk/prod01/lbg/hfx/personal/oidc-api/v1.1/authorize
Token URL
https://secure-api.halifax.co.uk/prod01/lbg/hfx/oidc-api/v1.1/token
Scopes
payments
Generic payment scope
x-idempotency-key
Required in header
string

Every request will be processed only once per x-idempotency-key.

x-fapi-financial-id
Required in header
string

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-time
Optional in header
string

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

{
    "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} (GMT|UTC)$"
}
x-fapi-interaction-id
Optional in header
string

An RFC4122 UID used as a correlation ID.

{
    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}
body
Required in body
object

Domestic Scheduled Payment POST body

{
    "schema": {
        "type": "object",
        "required": [
            "Data",
            "Risk"
        ],
        "properties": {
            "Data": {
                "$ref": "#\/definitions\/DomesticScheduledPaymentData"
            },
            "Risk": {
                "$ref": "#\/definitions\/Risk"
            }
        }
    }
}
x-jws-signature
Required in header
string

A detached JWS signature of the body of the payload.

Authorization
Required in header
string

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Content-Type
Optional in header
string
application/json;charset=UTF-8
Accept
Optional in header
string
application/json;charset=UTF-8
201

Created

DomesticScheduledPaymentResponse
400

Bad request

ErrorResponse
401

Unauthorized

403

Forbidden

404

Not found

500

Internal server error

ErrorResponse
Example Request
curl --request POST \
  --url https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments \
  --header 'Authorization: REPLACE_THIS_VALUE' \
  --header 'accept: application/json;charset=UTF-8' \
  --header 'content-type: application/json;charset=UTF-8' \
  --header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
  --header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
  --header 'x-fapi-interaction-id: REPLACE_THIS_VALUE' \
  --header 'x-idempotency-key: REPLACE_THIS_VALUE' \
  --header 'x-jws-signature: REPLACE_THIS_VALUE' \
  --data '{"Data":{"ConsentId":"678122951278592","Initiation":{"InstructionIdentification":"8203155265290240","EndToEndIdentification":"8423496600256512","LocalInstrument":"UK:Bacs","RequestedExecutionDateTime":"12/23/2067","InstructedAmount":{"Amount":"6767821","Currency":"GBP"},"DebtorAccount":{"SchemeName":"SortCodeAccountNumber","Identification":"8072151515004928","Name":"Gabriel Andrews","SecondaryIdentification":"7539455145541632"},"CreditorAccount":{"SchemeName":"IBAN","Identification":"7560283128070144","Name":"Hulda Diaz","SecondaryIdentification":"1572210802163712"},"CreditorPostalAddress":{"AddressType":"Statement","Department":"tenkagjirib","SubDepartment":"ileveparjecu","StreetName":"Kane Highway","BuildingNumber":"2458930603098112","PostCode":"T7L 9T8","TownName":"Elmer Hunter","CountrySubDivision":"Antarctica","Country":"IJ","AddressLine":["berumugcuavadudullivvemawigmi","hirupbeacusabistetwizmudmog","dofurniadanenudnuutuceefoweorozaplugovgujdapinfisewmupage","fefehehtarukgosupmawahvejfasguvumzawawlurobage","pewucetog"]},"RemittanceInformation":{"Unstructured":"gidob","Reference":"jegatiuda"},"SupplementaryData":{"DebitAccountReference":{"Reference":"jurpefafkabh"}}},"SCASupportData":{"RequestedSCAExemptionType":"ContactlessTravel","AppliedAuthenticationApproach":"SCA","ReferencePaymentOrderId":"8256429163020288"}},"Risk":{"PaymentContextCode":"BillingGoodsAndServicesInArrears","Merc
Show more open_in_new
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'REPLACE_THIS_VALUE'
request["x-idempotency-key"] = 'REPLACE_THIS_VALUE'
request["x-fapi-financial-id"] = 'REPLACE_THIS_VALUE'
request["x-fapi-customer-last-logged-time"] = 'REPLACE_THIS_VALUE'
request["x-fapi-interaction-id"] = 'REPLACE_THIS_VALUE'
request["x-jws-signature"] = 'REPLACE_THIS_VALUE'
request["content-type"] = 'application/json;charset=UTF-8'
request["accept"] = 'application/json;charset=UTF-8'
request.body = "{\"Data\":{\"ConsentId\":\"678122951278592\",\"Initiation\":{\"InstructionIdentification\":\"8203155265290240\",\"EndToEndIdentification\":\"8423496600256512\",\"LocalInstrument\":\"UK:Bacs\",\"RequestedExecutionDateTime\":\"12/23/2067\",\"InstructedAmount\":{\"Amount\":\"6767821\",\"Currency\":\"GBP\"},\"DebtorAccount\":{\"SchemeName\":\"SortCodeAccountNumber\",\"Identification\":\"8072151515004928\",\"Name\":\"Gabriel Andrews\",\"SecondaryIdentification\":\"7539455145541632\"},\"CreditorAccount\":{\"SchemeName\":\"IBAN\",\"Identification\":\"7560283128070144\",\"Name\":\"Hulda Diaz\",\"SecondaryIdentification\":\"1572210802163712\"},\"CreditorPostalAddress\":{\"AddressType\":\"Statement\",\"Department\":\"tenkagjirib\",\"SubDepartment\":\"ileveparjecu\",\"StreetName\":\"Kane Highway\",\"BuildingNumber\":\"2458930603098112\",\"PostCode\":\"T7L 9T8\",\"TownName\":\"Elmer Hunter\",\"CountrySubDivision\":\"Antarctica\",\"Country\":\"IJ\",\"AddressLine\":[\"berumugcuavadudullivvemawigmi\",\"hirupbeacusabistetwizmudmog\",\"dofurniadanenudnuutuceefoweorozaplugovgujdapinfisewmupage\",\"fefehehtarukgosupmawahvejfasguvumzawawlurobage\",\"pewucetog\"]},\"RemittanceInformation\":{\"Unstructured\":\"gidob\",\"Reference\":\"jegat
Show more open_in_new
import http.client

conn = http.client.HTTPSConnection("secure-api.lloydsbank.com")

payload = "{\"Data\":{\"ConsentId\":\"678122951278592\",\"Initiation\":{\"InstructionIdentification\":\"8203155265290240\",\"EndToEndIdentification\":\"8423496600256512\",\"LocalInstrument\":\"UK:Bacs\",\"RequestedExecutionDateTime\":\"12/23/2067\",\"InstructedAmount\":{\"Amount\":\"6767821\",\"Currency\":\"GBP\"},\"DebtorAccount\":{\"SchemeName\":\"SortCodeAccountNumber\",\"Identification\":\"8072151515004928\",\"Name\":\"Gabriel Andrews\",\"SecondaryIdentification\":\"7539455145541632\"},\"CreditorAccount\":{\"SchemeName\":\"IBAN\",\"Identification\":\"7560283128070144\",\"Name\":\"Hulda Diaz\",\"SecondaryIdentification\":\"1572210802163712\"},\"CreditorPostalAddress\":{\"AddressType\":\"Statement\",\"Department\":\"tenkagjirib\",\"SubDepartment\":\"ileveparjecu\",\"StreetName\":\"Kane Highway\",\"BuildingNumber\":\"2458930603098112\",\"PostCode\":\"T7L 9T8\",\"TownName\":\"Elmer Hunter\",\"CountrySubDivision\":\"Antarctica\",\"Country\":\"IJ\",\"AddressLine\":[\"berumugcuavadudullivvemawigmi\",\"hirupbeacusabistetwizmudmog\",\"dofurniadanenudnuutuceefoweorozaplugovgujdapinfisewmupage\",\"fefehehtarukgosupmawahvejfasguvumzawawlurobage\",\"pewucetog\"]},\"RemittanceInformation\":{\"Unstructured\":\"gidob\",\"Reference\":\"jegatiuda\"},\"SupplementaryData\":{\"DebitAccountReference\":{\"Reference\":\"jurpefafkabh\"}}},\"SCASupportData\":{\"RequestedSCAExemptionType\":\"ContactlessTravel\",\"AppliedAuthenticationApproach\":\"SCA\",\"ReferencePaymentOrderId\":\"8256429163020288\"}},\"Risk\":{\"PaymentContextCode\":\"BillingGoodsAndServicesInArrears\",\"MerchantCategoryCode\":\"avniobnepewuj\",\"MerchantCustomerIdentification\":\"6690728541421568\",\"ContractPresentInidicator\":true,\"BeneficiaryPrepopulatedIndicator\":false,\"PaymentPurposeCode\":\"dal\",\"BeneficiaryAccountType\":\"Pension\",\"DeliveryAddress\":{\"AddressLine\":[\"addokvehhogpajsizjakzededbenulmetezabekmima\"],\"Stre
Show more open_in_new
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"Data\":{\"ConsentId\":\"678122951278592\",\"Initiation\":{\"InstructionIdentification\":\"8203155265290240\",\"EndToEndIdentification\":\"8423496600256512\",\"LocalInstrument\":\"UK:Bacs\",\"RequestedExecutionDateTime\":\"12/23/2067\",\"InstructedAmount\":{\"Amount\":\"6767821\",\"Currency\":\"GBP\"},\"DebtorAccount\":{\"SchemeName\":\"SortCodeAccountNumber\",\"Identification\":\"8072151515004928\",\"Name\":\"Gabriel Andrews\",\"SecondaryIdentification\":\"7539455145541632\"},\"CreditorAccount\":{\"SchemeName\":\"IBAN\",\"Identification\":\"7560283128070144\",\"Name\":\"Hulda Diaz\",\"SecondaryIdentification\":\"1572210802163712\"},\"CreditorPostalAddress\":{\"AddressType\":\"Statement\",\"Department\":\"tenkagjirib\",\"SubDepartment\":\"ileveparjecu\",\"StreetName\":\"Kane Highway\",\"BuildingNumber\":\"2458930603098112\",\"PostCode\":\"T7L 9T8\",\"TownName\":\"Elmer Hunter\",\"CountrySubDivision\":\"Antarctica\",\"Country\":\"IJ\",\"AddressLine\":[\"berumugcuavadudullivvemawigmi\",\"hirupbeacusabistetwizmudmog\",\"dofurniadanenudnuutuceefoweorozaplugovgujdapinfisewmupage\",\"fefehehtarukgosupmawahvejfasguvumzawawlurobage\",\"pewucetog\"]},\"RemittanceInformation\":{\"Unstructured\":\"gidob\",\"Reference\":\"jegatiuda\"},\"SupplementaryData\":{\"DebitAccountReference\":{\"Reference\":\"jurpefafkabh\"}}},\"SCASupportData\":{\"RequestedSCAExemptionType\":\"ContactlessTravel\",\"AppliedAuthenticationApproach\":\"SCA\",\"ReferencePaymentOrderId\":\"8256429163020288\"}},\"Risk\":{\"PaymentContextCode\":\"BillingGoodsAndServicesInArrears\",\"MerchantCategoryCode\":\"avniobnepewu
Show more open_in_new
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json;charset=UTF-8");
RequestBody body = RequestBody.create(mediaType, "{\"Data\":{\"ConsentId\":\"678122951278592\",\"Initiation\":{\"InstructionIdentification\":\"8203155265290240\",\"EndToEndIdentification\":\"8423496600256512\",\"LocalInstrument\":\"UK:Bacs\",\"RequestedExecutionDateTime\":\"12/23/2067\",\"InstructedAmount\":{\"Amount\":\"6767821\",\"Currency\":\"GBP\"},\"DebtorAccount\":{\"SchemeName\":\"SortCodeAccountNumber\",\"Identification\":\"8072151515004928\",\"Name\":\"Gabriel Andrews\",\"SecondaryIdentification\":\"7539455145541632\"},\"CreditorAccount\":{\"SchemeName\":\"IBAN\",\"Identification\":\"7560283128070144\",\"Name\":\"Hulda Diaz\",\"SecondaryIdentification\":\"1572210802163712\"},\"CreditorPostalAddress\":{\"AddressType\":\"Statement\",\"Department\":\"tenkagjirib\",\"SubDepartment\":\"ileveparjecu\",\"StreetName\":\"Kane Highway\",\"BuildingNumber\":\"2458930603098112\",\"PostCode\":\"T7L 9T8\",\"TownName\":\"Elmer Hunter\",\"CountrySubDivision\":\"Antarctica\",\"Country\":\"IJ\",\"AddressLine\":[\"berumugcuavadudullivvemawigmi\",\"hirupbeacusabistetwizmudmog\",\"dofurniadanenudnuutuceefoweorozaplugovgujdapinfisewmupage\",\"fefehehtarukgosupmawahvejfasguvumzawawlurobage\",\"pewucetog\"]},\"RemittanceInformation\":{\"Unstructured\":\"gidob\",\"Reference\":\"jegatiuda\"},\"SupplementaryData\":{\"DebitAccountReference\":{\"Reference\":\"jurpefafkabh\"}}},\"SCASupportData\":{\"RequestedSCAExemptionType\":\"ContactlessTravel\",\"AppliedAuthenticationApproach\":\"SCA\",\"ReferencePaymentOrderId\":\"8256429163020288\"}},\"Risk\":{\"PaymentContextCode\":\"BillingGoodsAndServicesInArrears\",\"MerchantCategoryCode\":\"avniobnepewuj\",\"MerchantCustomerIdentification\":\"6690728541421568\",\"ContractPresentInidicator\":true,\"BeneficiaryPrepopulatedIndicator\":false,\"PaymentPurposeCode\":\"dal\",\"BeneficiaryAccountType\":\"Pension\",\"DeliveryAddress\":{\"
Show more open_in_new
const request = require('request');

const options = {
  method: 'POST',
  url: 'https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments',
  headers: {
    Authorization: 'REPLACE_THIS_VALUE',
    'x-idempotency-key': 'REPLACE_THIS_VALUE',
    'x-fapi-financial-id': 'REPLACE_THIS_VALUE',
    'x-fapi-customer-last-logged-time': 'REPLACE_THIS_VALUE',
    'x-fapi-interaction-id': 'REPLACE_THIS_VALUE',
    'x-jws-signature': 'REPLACE_THIS_VALUE',
    'content-type': 'application/json;charset=UTF-8',
    accept: 'application/json;charset=UTF-8'
  },
  body: '{"Data":{"ConsentId":"678122951278592","Initiation":{"InstructionIdentification":"8203155265290240","EndToEndIdentification":"8423496600256512","LocalInstrument":"UK:Bacs","RequestedExecutionDateTime":"12/23/2067","InstructedAmount":{"Amount":"6767821","Currency":"GBP"},"DebtorAccount":{"SchemeName":"SortCodeAccountNumber","Identification":"8072151515004928","Name":"Gabriel Andrews","SecondaryIdentification":"7539455145541632"},"CreditorAccount":{"SchemeName":"IBAN","Identification":"7560283128070144","Name":"Hulda Diaz","SecondaryIdentification":"1572210802163712"},"CreditorPostalAddress":{"AddressType":"Statement","Department":"tenkagjirib","SubDepartment":"ileveparjecu","StreetName":"Kane Highway","BuildingNumber":"2458930603098112","PostCode":"T7L 9T8","TownName":"Elmer Hunter","CountrySubDivision":"Antarctica","Country":"IJ","AddressLine":["berumugcuavadudullivvemawigmi","hirupbeacusabistetwizmudmog","dofurniadanenudnuutuceefoweorozaplugovgujdapinfisewmupage","fefehehtarukgosupmawahvejfasguvumzawawlurobage","pewucetog"]},"RemittanceInformation":{"Unstructured":"gidob","Reference":"jegatiuda"},"SupplementaryData":{"DebitAccountReference":{"Reference":"jurpefafkabh"}}},"SCASupportData":{"RequestedSCAExemptionType":"ContactlessTravel","AppliedAuthenticationApproach":"SCA","ReferencePaymentOrderId":"8256429163020288"}},"Risk":{"PaymentContextCode":"BillingGoodsAndServicesI
Show more open_in_new
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments"

	payload := strings.NewReader("{\"Data\":{\"ConsentId\":\"678122951278592\",\"Initiation\":{\"InstructionIdentification\":\"8203155265290240\",\"EndToEndIdentification\":\"8423496600256512\",\"LocalInstrument\":\"UK:Bacs\",\"RequestedExecutionDateTime\":\"12/23/2067\",\"InstructedAmount\":{\"Amount\":\"6767821\",\"Currency\":\"GBP\"},\"DebtorAccount\":{\"SchemeName\":\"SortCodeAccountNumber\",\"Identification\":\"8072151515004928\",\"Name\":\"Gabriel Andrews\",\"SecondaryIdentification\":\"7539455145541632\"},\"CreditorAccount\":{\"SchemeName\":\"IBAN\",\"Identification\":\"7560283128070144\",\"Name\":\"Hulda Diaz\",\"SecondaryIdentification\":\"1572210802163712\"},\"CreditorPostalAddress\":{\"AddressType\":\"Statement\",\"Department\":\"tenkagjirib\",\"SubDepartment\":\"ileveparjecu\",\"StreetName\":\"Kane Highway\",\"BuildingNumber\":\"2458930603098112\",\"PostCode\":\"T7L 9T8\",\"TownName\":\"Elmer Hunter\",\"CountrySubDivision\":\"Antarctica\",\"Country\":\"IJ\",\"AddressLine\":[\"berumugcuavadudullivvemawigmi\",\"hirupbeacusabistetwizmudmog\",\"dofurniadanenudnuutuceefoweorozaplugovgujdapinfisewmupage\",\"fefehehtarukgosupmawahvejfasguvumzawawlurobage\",\"pewucetog\"]},\"RemittanceInformation\":{\"Unstructured\":\"gidob\",\"Reference\":\"jegatiuda\"},\"SupplementaryData\":{\"DebitAccountReference\":{\"Reference\":\"jurpefafkabh\"}}},\"SCASupportData\":{\"RequestedSCAExemptionType\":\"ContactlessTravel\",\"AppliedAuthenticationApproach\":\"SCA\",\"ReferencePaymentOrderId\":\"8256429163020288\"}},\"Risk\":{\"PaymentContextCode\":\"BillingGoodsAndServicesInArrears\",\"MerchantCategoryCode\":\"avniobnepewuj\",\"MerchantCustomerIdentification\":\"6690728541421568\",\"ContractPresentInidicator\":true,\"BeneficiaryPrepopulatedIndicator\":false,\"PaymentPurposeCode\":\"dal\",\"
Show more open_in_new
import Foundation

let headers = [
  "Authorization": "REPLACE_THIS_VALUE",
  "x-idempotency-key": "REPLACE_THIS_VALUE",
  "x-fapi-financial-id": "REPLACE_THIS_VALUE",
  "x-fapi-customer-last-logged-time": "REPLACE_THIS_VALUE",
  "x-fapi-interaction-id": "REPLACE_THIS_VALUE",
  "x-jws-signature": "REPLACE_THIS_VALUE",
  "content-type": "application/json;charset=UTF-8",
  "accept": "application/json;charset=UTF-8"
]

let postData = NSData(data: "{"Data":{"ConsentId":"678122951278592","Initiation":{"InstructionIdentification":"8203155265290240","EndToEndIdentification":"8423496600256512","LocalInstrument":"UK:Bacs","RequestedExecutionDateTime":"12/23/2067","InstructedAmount":{"Amount":"6767821","Currency":"GBP"},"DebtorAccount":{"SchemeName":"SortCodeAccountNumber","Identification":"8072151515004928","Name":"Gabriel Andrews","SecondaryIdentification":"7539455145541632"},"CreditorAccount":{"SchemeName":"IBAN","Identification":"7560283128070144","Name":"Hulda Diaz","SecondaryIdentification":"1572210802163712"},"CreditorPostalAddress":{"AddressType":"Statement","Department":"tenkagjirib","SubDepartment":"ileveparjecu","StreetName":"Kane Highway","BuildingNumber":"2458930603098112","PostCode":"T7L 9T8","TownName":"Elmer Hunter","CountrySubDivision":"Antarctica","Country":"IJ","AddressLine":["berumugcuavadudullivvemawigmi","hirupbeacusabistetwizmudmog","dofurniadanenudnuutuceefoweorozaplugovgujdapinfisewmupage","fefehehtarukgosupmawahvejfasguvumzawawlurobage","pewucetog"]},"RemittanceInformation":{"Unstructured":"gidob","Reference":"jegatiuda"},"SupplementaryData":{"DebitAccountReference":{"Reference":"jurpefafkabh"}}},"SCASupportData":{"RequestedSCAExemptionType":"ContactlessTravel","AppliedAuthenticationApproach":"SCA","ReferencePaymentOrderId":"8256429163020288"}},"Risk":{"PaymentContextCode":"BillingGoodsAndServicesInArrears","MerchantCategoryCode":"avniobnepewuj","MerchantCustomerIdentification":"6690728541421568","ContractPresentInidicator":true,"BeneficiaryPrepopula
Show more open_in_new
Example Response
POST https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments
{
  "Data": {
    "DomesticScheduledPaymentId": "8855502337343488",
    "CreationDateTime": "2018-04-05T12:21:07.243Z",
    "Status": "Consumed",
    "StatusUpdateDateTime": "2017-07-26T19:35:56.214Z",
    "CutOffDateTime": "2019-08-07T09:04:28.901Z",
    "Refund": {
      "Account": {
        "SchemeName": "Adelaide Reese",
        "Identification": "2438800942825472",
        "Name": "Jay Joseph",
        "SecondaryIdentification": "7363106051194880"
      }
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "duloz",
        "Amount": {
          "Amount": "4509661801152",
          "Currency": "GBP"
        }
      },
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "duaksi",
        "Amount": {
          "Amount": "0585125",
          "Currency": "GBP"
        }
      },
      {
        "ChargeBearer": "Shared",
        "Type": "sumothepewaigupo",
        "Amount": {
          "Amount": "7716657970268.3",
          "Currency
Show more open_in_new
Try this operation
https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments
Login to test this API.
payments
content-type
accept
x-idempotency-key
x-fapi-financial-id
x-fapi-customer-last-logged-time
x-fapi-interaction-id
x-jws-signature
Authorization

/domestic-scheduled-payments/{DomesticScheduledPaymentId}

get /domestic-scheduled-payments/{DomesticScheduledPaymentId}
Domestic Scheduled Payment

Get a domestic scheduled payment.

Get a Domestic Scheduled Payment.

TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)

TPP client credential authorisation flow with the ASPSP

Token URL
https://secure-api.halifax.co.uk/prod01/lbg/hfx/oidc-api/v1.1/token
Scopes
payments
Generic payment scopes
DomesticScheduledPaymentId
Required in path
string

A unique identifier used to identify the domestic scheduled payment.

x-fapi-financial-id
Required in header
string

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-time
Optional in header
string

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

{
    "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} (GMT|UTC)$"
}
x-fapi-interaction-id
Optional in header
string

An RFC4122 UID used as a correlation ID.

{
    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}
Authorization
Required in header
string

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Accept
Optional in header
string
application/json;charset=UTF-8
200

OK

DomesticScheduledPaymentResponse
400

Bad request

ErrorResponse
401

Unauthorized

403

Forbidden

404

Not found

500

Internal server error

ErrorResponse
Example Request
curl --request GET \
  --url https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments/REPLACE_DOMESTICSCHEDULEDPAYMENTID \
  --header 'Authorization: REPLACE_THIS_VALUE' \
  --header 'accept: application/json;charset=UTF-8' \
  --header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
  --header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
  --header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments/REPLACE_DOMESTICSCHEDULEDPAYMENTID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'REPLACE_THIS_VALUE'
request["x-fapi-financial-id"] = 'REPLACE_THIS_VALUE'
request["x-fapi-customer-last-logged-time"] = 'REPLACE_THIS_VALUE'
request["x-fapi-interaction-id"] = 'REPLACE_THIS_VALUE'
request["accept"] = 'application/json;charset=UTF-8'

response = http.request(request)
puts response.read_body
import http.client

conn = http.client.HTTPSConnection("secure-api.lloydsbank.com")

headers = {
    'Authorization': "REPLACE_THIS_VALUE",
    'x-fapi-financial-id': "REPLACE_THIS_VALUE",
    'x-fapi-customer-last-logged-time': "REPLACE_THIS_VALUE",
    'x-fapi-interaction-id': "REPLACE_THIS_VALUE",
    'accept': "application/json;charset=UTF-8"
    }

conn.request("GET", "/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments/REPLACE_DOMESTICSCHEDULEDPAYMENTID", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments/REPLACE_DOMESTICSCHEDULEDPAYMENTID",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: REPLACE_THIS_VALUE",
    "accept: application/json;charset=UTF-8",
    "x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE",
    "x-fapi-financial-id: REPLACE_THIS_VALUE",
    "x-fapi-interaction-id: REPLACE_THIS_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments/REPLACE_DOMESTICSCHEDULEDPAYMENTID")
  .get()
  .addHeader("Authorization", "REPLACE_THIS_VALUE")
  .addHeader("x-fapi-financial-id", "REPLACE_THIS_VALUE")
  .addHeader("x-fapi-customer-last-logged-time", "REPLACE_THIS_VALUE")
  .addHeader("x-fapi-interaction-id", "REPLACE_THIS_VALUE")
  .addHeader("accept", "application/json;charset=UTF-8")
  .build();

Response response = client.newCall(request).execute();
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments/REPLACE_DOMESTICSCHEDULEDPAYMENTID',
  headers: {
    Authorization: 'REPLACE_THIS_VALUE',
    'x-fapi-financial-id': 'REPLACE_THIS_VALUE',
    'x-fapi-customer-last-logged-time': 'REPLACE_THIS_VALUE',
    'x-fapi-interaction-id': 'REPLACE_THIS_VALUE',
    accept: 'application/json;charset=UTF-8'
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments/REPLACE_DOMESTICSCHEDULEDPAYMENTID"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "REPLACE_THIS_VALUE")
	req.Header.Add("x-fapi-financial-id", "REPLACE_THIS_VALUE")
	req.Header.Add("x-fapi-customer-last-logged-time", "REPLACE_THIS_VALUE")
	req.Header.Add("x-fapi-interaction-id", "REPLACE_THIS_VALUE")
	req.Header.Add("accept", "application/json;charset=UTF-8")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
import Foundation

let headers = [
  "Authorization": "REPLACE_THIS_VALUE",
  "x-fapi-financial-id": "REPLACE_THIS_VALUE",
  "x-fapi-customer-last-logged-time": "REPLACE_THIS_VALUE",
  "x-fapi-interaction-id": "REPLACE_THIS_VALUE",
  "accept": "application/json;charset=UTF-8"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments/REPLACE_DOMESTICSCHEDULEDPAYMENTID")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
Example Response
GET https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments/{DomesticScheduledPaymentId}
{
  "Data": {
    "DomesticScheduledPaymentId": "8116838061834240",
    "CreationDateTime": "2014-01-04T14:47:48.542Z",
    "Status": "AwaitingAuthorisation",
    "StatusUpdateDateTime": "2012-11-09T10:49:21.761Z",
    "CutOffDateTime": "2024-04-19T03:46:25.010Z",
    "Refund": {
      "Account": {
        "SchemeName": "Hallie Hunter",
        "Identification": "5891844040818688",
        "Name": "Trevor Kim",
        "SecondaryIdentification": "4916310750265344"
      }
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "peeghofpiihpali",
        "Amount": {
          "Amount": "855142547660",
          "Currency": "GBP"
        }
      },
      {
        "ChargeBearer": "FollowingServiceLevel",
        "Type": "nevewizewlicam",
        "Amount": {
          "Amount": "03187284.3",
          "Currency": "GBP"
        }
      },
      {
        "ChargeBearer": "BorneByDebtor",
        "Type": "ivijon",
        "Amount": {
          "Amount": "56
Show more open_in_new
Try this operation
https://secure-api.lloydsbank.com/prod01/lbg/hfx/open-banking/v3.1/pisp/domestic-scheduled-payments/{DomesticScheduledPaymentId}
Login to test this API.
payments
accept
x-fapi-financial-id
x-fapi-customer-last-logged-time
x-fapi-interaction-id
Authorization
DomesticScheduledPaymentId

Definitions

Supporting Data provided by TPP, when requesting SCA Exemption.

{
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "RequestedSCAExemptionType": {
            "description": "This field allows a PISP to request specific SCA Exemption for a Payment Initiation",
            "type": "string",
            "enum": [
                "BillPayment",
                "ContactlessTravel",
                "EcommerceGoods",
                "EcommerceServices",
                "Kiosk",
                "Parking",
                "PartyToParty"
            ]
        },
        "AppliedAuthenticationApproach": {
            "description": "Specifies a character string with a maximum length of 40 characters.\nUsage: This field indicates whether the PSU was subject to SCA performed by the TPP",
            "type": "string",
            "enum": [
                "CA",
                "SCA"
            ]
        },
        "ReferencePaymentOrderId": {
            "description": "Specifies a character string with a maximum length of 140 characters.\nUsage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        }
    }
}
              
{
    "type": "object",
    "required": [
        "Data",
        "Risk"
    ],
    "properties": {
        "Data": {
            "$ref": "#/definitions/DomesticScheduledPaymentData"
        },
        "Risk": {
            "$ref": "#/definitions/Risk"
        }
    }
}
              
{
    "type": "object",
    "required": [
        "ConsentId",
        "Initiation"
    ],
    "properties": {
        "ConsentId": {
            "$ref": "#/definitions/ConsentId"
        },
        "Initiation": {
            "$ref": "#/definitions/Initiation"
        },
        "SCASupportData": {
            "type": "object",
            "additionalProperties": false,
            "description": "Supporting Data provided by TPP, when requesting SCA Exemption.",
            "properties": {
                "RequestedSCAExemptionType": {
                    "description": "This field allows a PISP to request specific SCA Exemption for a Payment Initiation",
                    "type": "string",
                    "enum": [
                        "BillPayment",
                        "ContactlessTravel",
                        "EcommerceGoods",
                        "EcommerceServices",
                        "Kiosk",
                        "Parking",
                        "PartyToParty"
                    ]
                },
                "AppliedAuthenticationApproach": {
                    "description": "Specifies a character string with a maximum length of 40 characters.\nUsage: This field indicates whether the PSU was subject to SCA performed by the TPP",
                    "type": "string",
                    "maxLength": 40,
                    "enum": [
                        "CA",
                        "SCA"
                    ]
                },
                "ReferencePaymentOrderId": {
                    "description": "Specifies a character string with a maximum length of 140 characters.\nUsage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 40
                }
            }
        }
    }
}
              
{
    "type": "object",
    "required": [
        "Data",
        "Risk"
    ],
    "properties": {
        "Data": {
            "$ref": "#/definitions/DomesticScheduledPaymentConsentData"
        },
        "Risk": {
            "$ref": "#/definitions/Risk"
        }
    }
}
              
{
    "type": "object",
    "required": [
        "Permission",
        "Initiation"
    ],
    "properties": {
        "Permission": {
            "$ref": "#/definitions/Permission"
        },
        "ReadRefundAccount": {
            "description": "Specifies to share the refund account details with PISP",
            "type": "string",
            "enum": [
                "No",
                "Yes"
            ]
        },
        "Initiation": {
            "$ref": "#/definitions/Initiation"
        },
        "Authorisation": {
            "$ref": "#/definitions/Authorisation"
        },
        "SCASupportData": {
            "$ref": "#/definitions/SCASupportDataResDef"
        }
    }
}
              
{
    "type": "object",
    "required": [
        "Data",
        "Risk"
    ],
    "properties": {
        "Data": {
            "$ref": "#/definitions/DomesticScheduledPaymentResponseData"
        },
        "Risk": {
            "$ref": "#/definitions/Risk"
        }
    }
}
              
{
    "type": "object",
    "required": [
        "DomesticScheduledPaymentId",
        "CreationDateTime",
        "Status",
        "StatusUpdateDateTime",
        "Initiation"
    ],
    "properties": {
        "DomesticScheduledPaymentId": {
            "$ref": "#/definitions/DomesticScheduledPaymentId"
        },
        "CreationDateTime": {
            "$ref": "#/definitions/CreationDateTime"
        },
        "Status": {
            "$ref": "#/definitions/Status"
        },
        "StatusUpdateDateTime": {
            "$ref": "#/definitions/StatusUpdateDateTime"
        },
        "CutOffDateTime": {
            "$ref": "#/definitions/CutOffDateTime"
        },
        "Refund": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "Account"
            ],
            "description": "Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.",
            "properties": {
                "Account": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                        "SchemeName",
                        "Identification",
                        "Name"
                    ],
                    "description": "Provides the details to identify an account.",
                    "properties": {
                        "SchemeName": {
                            "$ref": "#/definitions/OBExternalAccountIdentification4Code"
                        },
                        "Identification": {
                            "$ref": "#/definitions/Identification_0"
                        },
                        "Name": {
                            "description": "Name of the account, as assigned by the account servicing institution.\nUsage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 350
                        },
                        "SecondaryIdentification": {
                            "$ref": "#/definitions/SecondaryIdentification"
                        }
                    }
                }
            }
        },
        "Charges": {
            "$ref": "#/definitions/Charges"
        },
        "Initiation": {
            "$ref": "#/definitions/Initiation"
        },
        "Debtor": {
            "$ref": "#/definitions/OBDebtorIdentification1"
        },
        "SCASupportData": {
            "$ref": "#/definitions/SCASupportDataResDef"
        }
    }
}
              
{
    "type": "string",
    "maxLength": 128
}
              
{
    "type": "string",
    "enum": [
        "Create"
    ]
}
              
{
    "type": "object",
    "required": [
        "InstructionIdentification",
        "RequestedExecutionDateTime",
        "InstructedAmount",
        "CreditorAccount"
    ],
    "properties": {
        "InstructionIdentification": {
            "$ref": "#/definitions/InstructionIdentification"
        },
        "EndToEndIdentification": {
            "$ref": "#/definitions/EndToEndIdentification"
        },
        "LocalInstrument": {
            "$ref": "#/definitions/LocalInstrument"
        },
        "RequestedExecutionDateTime": {
            "$ref": "#/definitions/RequestedExecutionDateTime"
        },
        "InstructedAmount": {
            "$ref": "#/definitions/InstructedAmount"
        },
        "DebtorAccount": {
            "$ref": "#/definitions/DebtorAccount"
        },
        "CreditorAccount": {
            "$ref": "#/definitions/CreditorAccount"
        },
        "CreditorPostalAddress": {
            "$ref": "#/definitions/CreditorPostalAddress"
        },
        "RemittanceInformation": {
            "$ref": "#/definitions/RemittanceInformation"
        },
        "SupplementaryData": {
            "$ref": "#/definitions/OBSupplementaryData1"
        }
    }
}
              
{
    "type": "string",
    "minLength": 1,
    "maxLength": 35
}
              
{
    "type": "string",
    "minLength": 1,
    "maxLength": 35
}
              
{
    "type": "string",
    "enum": [
        "UK:FasterPayments",
        "UK:Bacs",
        "UK:CHAPS",
        "UK:Link"
    ]
}
              
{
    "type": "string"
}
              
{
    "type": "object",
    "required": [
        "Amount",
        "Currency"
    ],
    "properties": {
        "Amount": {
            "type": "string",
            "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,2}$"
        },
        "Currency": {
            "type": "string",
            "enum": [
                "GBP"
            ]
        }
    }
}

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

{
    "type": "object",
    "title": "DebtorAccount",
    "properties": {
        "SchemeName": {
            "description": "Name of the identification scheme, in a coded form as published in an external list.",
            "title": "SchemeName",
            "type": "string",
            "enum": [
                "IBAN",
                "SortCodeAccountNumber",
                "BBAN"
            ]
        },
        "Identification": {
            "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
            "type": "string",
            "minLength": 1,
            "maxLength": 34
        },
        "Name": {
            "description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.",
            "type": "string",
            "minLength": 1,
            "maxLength": 350
        },
        "SecondaryIdentification": {
            "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
            "type": "string",
            "minLength": 1,
            "maxLength": 34
        }
    },
    "required": [
        "SchemeName",
        "Identification"
    ],
    "additionalProperties": false
}

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

{
    "title": "CreditorAccount",
    "type": "object",
    "properties": {
        "SchemeName": {
            "description": "Name of the identification scheme, in a coded form as published in an external list.",
            "title": "SchemeName",
            "type": "string",
            "enum": [
                "IBAN",
                "SortCodeAccountNumber"
            ]
        },
        "Identification": {
            "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
            "type": "string",
            "minLength": 1,
            "maxLength": 34
        },
        "Name": {
            "description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number. ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
            "type": "string",
            "minLength": 1,
            "maxLength": 350
        },
        "SecondaryIdentification": {
            "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
            "type": "string",
            "minLength": 1,
            "maxLength": 34
        }
    },
    "required": [
        "SchemeName",
        "Identification",
        "Name"
    ],
    "additionalProperties": false
}
              
{
    "type": "object",
    "properties": {
        "AddressType": {
            "type": "string",
            "enum": [
                "Business",
                "Correspondence",
                "DeliveryTo",
                "MailTo",
                "POBox",
                "Postal",
                "Residential",
                "Statement"
            ]
        },
        "Department": {
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "SubDepartment": {
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "StreetName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "BuildingNumber": {
            "type": "string",
            "minLength": 1,
            "maxLength": 16
        },
        "PostCode": {
            "type": "string",
            "minLength": 1,
            "maxLength": 16
        },
        "TownName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "CountrySubDivision": {
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "Country": {
            "type": "string",
            "pattern": "[A-Z]{2,2}"
        },
        "AddressLine": {
            "type": "array",
            "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 70
            },
            "minItems": 0,
            "maxItems": 7
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "Unstructured": {
            "type": "string",
            "minLength": 1,
            "maxLength": 140
        },
        "Reference": {
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        }
    }
}
              
{
    "type": "object",
    "required": [
        "AuthorisationType"
    ],
    "properties": {
        "AuthorisationType": {
            "type": "string",
            "enum": [
                "Any",
                "Single"
            ]
        },
        "CompletionDateTime": {
            "type": "string",
            "format": "date-time"
        }
    }
}
              
{
    "type": "object",
    "required": [
        "PaymentContextCode"
    ],
    "properties": {
        "PaymentContextCode": {
            "type": "string",
            "enum": [
                "BillPayment",
                "EcommerceGoods",
                "EcommerceServices",
                "Other",
                "PartyToParty",
                "BillingGoodsAndServicesInAdvance",
                "BillingGoodsAndServicesInArrears",
                "PispPayee",
                "EcommerceMerchantInitiatedPayment",
                "FaceToFacePointOfSale",
                "TransferToSelf",
                "TransferToThirdParty"
            ]
        },
        "MerchantCategoryCode": {
            "type": "string"
        },
        "MerchantCustomerIdentification": {
            "type": "string"
        },
        "ContractPresentInidicator": {
            "type": "boolean",
            "description": "Indicates if Payee has a contractual relationship with the PISP."
        },
        "BeneficiaryPrepopulatedIndicator": {
            "type": "boolean",
            "description": "Indicates if PISP has immutably prepopulated payment details in for the PSU."
        },
        "PaymentPurposeCode": {
            "type": "string",
            "minLength": 3,
            "maxLength": 4,
            "description": "Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List"
        },
        "BeneficiaryAccountType": {
            "$ref": "#/definitions/OBExternalExtendedAccountType1Code"
        },
        "DeliveryAddress": {
            "$ref": "#/definitions/DeliveryAddress"
        }
    }
}

Specifies the extended type of account.

{
    "type": "string",
    "enum": [
        "Business",
        "BusinessSavingsAccount",
        "Charity",
        "Collection",
        "Corporate",
        "Ewallet",
        "Government",
        "Investment",
        "ISA",
        "JointPersonal",
        "Pension",
        "Personal",
        "PersonalSavingsAccount",
        "Premier",
        "Wealth"
    ]
}

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

{
    "type": "object",
    "required": [
        "TownName",
        "Country"
    ],
    "properties": {
        "AddressLine": {
            "description": "Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.",
            "type": "array",
            "items": {
                "description": "maxLength 70 text",
                "type": "string",
                "minLength": 1,
                "maxLength": 70
            },
            "minItems": 0,
            "maxItems": 2
        },
        "StreetName": {
            "description": "Name of a street or thoroughfare",
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "BuildingNumber": {
            "description": "Number that identifies the position of a building on a street.",
            "type": "string",
            "minLength": 1,
            "maxLength": 16
        },
        "PostCode": {
            "description": "Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail",
            "type": "string",
            "minLength": 1,
            "maxLength": 16
        },
        "TownName": {
            "description": "Name of a built-up area, with defined boundaries, and a local government.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "CountrySubDivision": {
            "description": "Identifies a subdivision of a country, for instance state, region, county.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "Country": {
            "description": "Nation with its own government, occupying a particular territory.",
            "type": "string",
            "pattern": "[A-Z]{2}"
        }
    },
    "additionalProperties": false
}
              
{
    "type": "array",
    "items": {
        "type": "object",
        "required": [
            "Data",
            "Risk"
        ],
        "properties": {
            "Data": {
                "$ref": "#/definitions/DomesticScheduledPaymentConsentResponseData"
            },
            "Risk": {
                "$ref": "#/definitions/Risk"
            }
        }
    }
}
              
{
    "type": "object",
    "required": [
        "Data",
        "Risk"
    ],
    "properties": {
        "Data": {
            "$ref": "#/definitions/DomesticScheduledPaymentConsentResponseData"
        },
        "Risk": {
            "$ref": "#/definitions/Risk"
        }
    }
}
              
{
    "type": "object",
    "required": [
        "ConsentId",
        "CreationDateTime",
        "Status",
        "StatusUpdateDateTime",
        "Permission",
        "Initiation"
    ],
    "properties": {
        "ConsentId": {
            "$ref": "#/definitions/ConsentId"
        },
        "CreationDateTime": {
            "$ref": "#/definitions/CreationDateTime"
        },
        "Status": {
            "$ref": "#/definitions/Status"
        },
        "StatusUpdateDateTime": {
            "$ref": "#/definitions/StatusUpdateDateTime"
        },
        "Permission": {
            "$ref": "#/definitions/Permission"
        },
        "ReadRefundAccount": {
            "description": "Specifies to share the refund account details with PISP",
            "type": "string",
            "enum": [
                "No",
                "Yes"
            ]
        },
        "CutOffDateTime": {
            "$ref": "#/definitions/CutOffDateTime"
        },
        "ExpectedExecutionDateTime": {
            "$ref": "#/definitions/ExpectedExecutionDateTime"
        },
        "ExpectedSettlementDateTime": {
            "$ref": "#/definitions/ExpectedSettlementDateTime"
        },
        "Charges": {
            "$ref": "#/definitions/Charges"
        },
        "Initiation": {
            "$ref": "#/definitions/Initiation"
        },
        "Authorisation": {
            "$ref": "#/definitions/Authorisation"
        },
        "SCASupportData": {
            "$ref": "#/definitions/SCASupportDataResDef"
        },
        "Debtor": {
            "$ref": "#/definitions/OBDebtorIdentification1"
        }
    }
}

Name of the identification scheme, in a coded form as published in an external list.

{
    "type": "string",
    "x-namespaced-enum": [
        "UK.OBIE.BBAN",
        "UK.OBIE.IBAN",
        "UK.OBIE.PAN",
        "UK.OBIE.Paym",
        "UK.OBIE.SortCodeAccountNumber"
    ]
}

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

{
    "type": "string",
    "minLength": 1,
    "maxLength": 34
}

Identification assigned by an institution to identify an account. This identification is known by the account owner.

{
    "type": "string",
    "minLength": 1,
    "maxLength": 256
}

Set of elements used to identify a person or an organisation.

{
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "Name": {
            "type": "string",
            "description": "The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account."
        },
        "SchemeName": {
            "type": "string",
            "enum": [
                "IBAN",
                "SortCodeAccountNumber",
                "BBAN"
            ]
        },
        "Identification": {
            "type": "string"
        },
        "SecondaryIdentification": {
            "type": "string"
        }
    }
}
              
{
    "type": "string",
    "maxLength": 128
}
              
{
    "type": "string",
    "format": "date-time"
}
              
{
    "type": "string",
    "enum": [
        "Authorised",
        "AwaitingAuthorisation",
        "Consumed",
        "Rejected"
    ]
}
              
{
    "type": "string",
    "format": "date-time"
}
              
{
    "type": "string",
    "format": "date-time"
}
              
{
    "type": "string",
    "format": "date-time"
}
              
{
    "type": "string",
    "format": "date-time"
}
              
{
    "type": "array",
    "items": {
        "type": "object",
        "required": [
            "ChargeBearer",
            "Type",
            "Amount"
        ],
        "properties": {
            "ChargeBearer": {
                "type": "string",
                "enum": [
                    "BorneByCreditor",
                    "BorneByDebtor",
                    "FollowingServiceLevel",
                    "Shared"
                ]
            },
            "Type": {
                "type": "string",
                "maxLength": 40
            },
            "Amount": {
                "type": "object",
                "required": [
                    "Amount",
                    "Currency"
                ],
                "properties": {
                    "Amount": {
                        "type": "string",
                        "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,2}$"
                    },
                    "Currency": {
                        "type": "string",
                        "enum": [
                            "GBP"
                        ]
                    }
                }
            }
        }
    }
}
              
{
    "type": "object",
    "required": [
        "Code",
        "Message",
        "Errors"
    ],
    "properties": {
        "Code": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "Id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "Message": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500
        },
        "Errors": {
            "items": {
                "$ref": "#/definitions/Error"
            },
            "type": "array",
            "minItems": 1
        }
    }
}

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

{
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "DebitAccountReference": {
            "type": "object",
            "properties": {
                "Reference": {
                    "type": "string"
                }
            }
        }
    }
}
              
{
    "type": "object",
    "required": [
        "ErrorCode",
        "Message"
    ],
    "properties": {
        "ErrorCode": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
        },
        "Message": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500
        },
        "Path": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500
        },
        "Url": {
            "type": "string"
        }
    }
}