This API provides the ability for authorised payment initiation service providers (PISPs, TPPs � third party providers) to initiate and set up new domestic, international and file based payments. The TPPs will be able to initiate requests directly from the customer�s (PSU- payment service user) current - personal or business - accounts, after being granted consent. Within Domestic Payments, Faster and CHAPS immediate payments can be initiated. This API is developed according to the Open Banking Read/Write API Specifications and fulfils PSD2 regulation, see https://www.openbanking.org.uk
API Information
| Title | Payment Initiation V3 |
|---|---|
| Protocol | TLS-MA |
| Open Banking Specification Version | 3.1 |
| Access | Free to use but subscription is required |
Key Features:
- Domestic payments (in GBP)
- Domestic scheduled payments (in GBP)
- Domestic standing orders (in GBP)
- International payments
- File payments (Domestic payments in GBP, File Status & Report File)
Not in this version:
Domestic Payments
Santander do not support the object "Authorisation" for the domestic-payment-consents endpoint. If a PISP consent request is received with this object, it will be rejected as a HTTP 400 BAD request.
International Payments
Santander do not support "InstructionPriority" for the international-payment-consents endpoint. If a PISP consent request is received with this, it will be rejected as a HTTP 400 BAD request.
Santander only support DebtorAccount/SchemeName equal to UK.OBIE.SortCodeAccountNumber or SortCodeAccountNumber for the international-payment-consents endpoint, when populated in the request. If a PISP consent request is received with a different DebtorAccount/SchemeName, (or with a DebtorAccount structure but the SchemeName value = NULL), it will be rejected as a HTTP 400 BAD request.
Santander only support a CreditorAgent/SchemeName of UK.OBIE.BICFI or BICFI for the international-payment-consents endpoint. If a PISP consent request is received with a different CreditorAgent/SchemeName, (or with UK.OBIE.BICFI or BICFI but further validations are not passed), it will be rejected as a HTTP 400 BAD request. A request for sending USD to US can provide the NCCCode and NCCIdentification in SupplementaryData instead of the CreditorAgent SchemeName and Identification (see below).
Santander only support an international payment request where the CreditorAccount/SchemeName is UK.OBIE.IBAN or UK.Santander.OtherAccount (or IBAN or OtherAccount) for the international-payment-consents endpoint. If a PISP consent request is received with a different CreditorAccount/SchemeName it will be rejected as a HTTP 400 BAD request.
Please note that customers executing an international payment will not have visibility of personalised charges/final charges and exchange rates until the requested payment has been executed by Santander UK.
Execution of any SEPA payments for Corporate customers is not available.
File Payments
Santander only supports Bulk Faster Payment File processing (1 debit for multiple credit payments) for SBBI & Corporate Business Customers. OB File Payments processing is not supported for Retail Santander customers (including Cahoot).
Santander will only support payment files uploaded in the 'UK.OBIE.PaymentInitiation.3.1' format. Any other type of file format uploaded will result in the file being rejected.
Santander will only accept domestic payments specified in the PaymentInitiation file that will be processed via faster payment scheme. The payments will need to have the LocalInstrument value set to �UK.OBIE.FPS�. Any other payment type will result in the file being rejected.
Santander does not currently support scheduled payments for domestic file payments processing.
Santander does not currently support multi-auth processing for BULK faster payments file processing.
Santander will not currently provide individual payment status details in the report-file for BULK file payments.
Endpoint for Open Banking TLS MA only
Paths
/domestic-payment-consents
/domestic-payment-consents/{ConsentId}
/domestic-payment-consents/{ConsentId}/funds-confirmation
/domestic-payments
Create Domestic Payments
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
Default
{
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"ConsentId",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"InstructedAmount",
"CreditorAccount"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"EndToEndIdentification": {
"description": "Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
},
"InstructedAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\nUsage: This amount has to be transported unchanged through the transaction chain.",
"properties": {
"Amount": {
"$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#\/definitions\/ActiveOrHistoricCurrencyCode"
}
}
},
"DebtorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification"
],
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_0"
},
"Name": {
"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.\nNote, the account name is not the product name or the nickname of the account.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#\/definitions\/SecondaryIdentification"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_0"
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, 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"
}
}
},
"CreditorPostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
},
"RemittanceInformation": {
"type": "object",
"additionalProperties": false,
"description": "Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.",
"properties": {
"Unstructured": {
"description": "Information supplied to enable the matching\/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Reference": {
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.\nOB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.",
"type": "string",
"minLength": 1,
"maxLength": 35
}
}
},
"SupplementaryData": {
"$ref": "#\/definitions\/OBSupplementaryData1"
}
}
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
}The time when the PSU last logged in with the TPP. All 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)$"
}The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
{
"pattern": "^(?!\\s)(.*)(\\S)$",
"maxLength": 40
}A detached JWS signature of the body of the payload.
Indicates the user-agent that the PSU is using.
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/domestic-payments/{DomesticPaymentId}
Get Domestic Payments
TPP client credential authorisation flow with the ASPSP
DomesticPaymentId
The time when the PSU last logged in with the TPP. All 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)$"
}The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/domestic-scheduled-payment-consents
/domestic-scheduled-payment-consents/{ConsentId}
/domestic-scheduled-payments
Create Domestic Scheduled Payments
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
Default
{
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"ConsentId",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"RequestedExecutionDateTime",
"InstructedAmount",
"CreditorAccount"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"EndToEndIdentification": {
"description": "Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
},
"RequestedExecutionDateTime": {
"description": "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00",
"type": "string",
"format": "date-time"
},
"InstructedAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\nUsage: This amount has to be transported unchanged through the transaction chain.",
"properties": {
"Amount": {
"$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#\/definitions\/ActiveOrHistoricCurrencyCode"
}
}
},
"DebtorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification"
],
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_0"
},
"Name": {
"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.\nNote, the account name is not the product name or the nickname of the account.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#\/definitions\/SecondaryIdentification"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_0"
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, 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"
}
}
},
"CreditorPostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
},
"RemittanceInformation": {
"type": "object",
"additionalProperties": false,
"description": "Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.",
"properties": {
"Unstructured": {
"description": "Information supplied to enable the matching\/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Reference": {
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.\nOB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.",
"type": "string",
"minLength": 1,
"maxLength": 35
}
}
},
"SupplementaryData": {
"$ref": "#\/definitions\/OBSupplementaryData1"
}
}
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
}The time when the PSU last logged in with the TPP. All 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)$"
}The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
{
"pattern": "^(?!\\s)(.*)(\\S)$",
"maxLength": 40
}A detached JWS signature of the body of the payload.
Indicates the user-agent that the PSU is using.
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/domestic-scheduled-payments/{DomesticScheduledPaymentId}
Get Domestic Scheduled Payments
TPP client credential authorisation flow with the ASPSP
DomesticScheduledPaymentId
The time when the PSU last logged in with the TPP. All 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)$"
}The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/domestic-standing-order-consents
/domestic-standing-order-consents/{ConsentId}
/domestic-standing-orders
Create Domestic Standing Orders
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
Default
{
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"ConsentId",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"Frequency",
"FirstPaymentDateTime",
"FirstPaymentAmount",
"CreditorAccount"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.",
"properties": {
"Frequency": {
"description": "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$",
"type": "string",
"pattern": "^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$"
},
"Reference": {
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"NumberOfPayments": {
"description": "Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"FirstPaymentDateTime": {
"description": "The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00",
"type": "string",
"format": "date-time"
},
"RecurringPaymentDateTime": {
"description": "The date on which the first recurring payment for a Standing Order schedule will be made. \nUsage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00",
"type": "string",
"format": "date-time"
},
"FinalPaymentDateTime": {
"description": "The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00",
"type": "string",
"format": "date-time"
},
"FirstPaymentAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"description": "The amount of the first Standing Order",
"properties": {
"Amount": {
"$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#\/definitions\/ActiveOrHistoricCurrencyCode"
}
}
},
"RecurringPaymentAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"description": "The amount of the recurring Standing Order",
"properties": {
"Amount": {
"$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#\/definitions\/ActiveOrHistoricCurrencyCode"
}
}
},
"FinalPaymentAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"description": "The amount of the final Standing Order",
"properties": {
"Amount": {
"$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#\/definitions\/ActiveOrHistoricCurrencyCode"
}
}
},
"DebtorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification"
],
"description": "Provides the details to identify the debtor account.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_0"
},
"Name": {
"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.\nNote, the account name is not the product name or the nickname of the account.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#\/definitions\/SecondaryIdentification"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_0"
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, 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"
}
}
},
"SupplementaryData": {
"$ref": "#\/definitions\/OBSupplementaryData1"
}
}
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
}The time when the PSU last logged in with the TPP. All 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)$"
}The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
{
"pattern": "^(?!\\s)(.*)(\\S)$",
"maxLength": 40
}A detached JWS signature of the body of the payload.
Indicates the user-agent that the PSU is using.
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/domestic-standing-orders/{DomesticStandingOrderId}
Get Domestic Standing Orders
TPP client credential authorisation flow with the ASPSP
DomesticStandingOrderId
The time when the PSU last logged in with the TPP. All 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)$"
}The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found