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)
- Variable Recurring Payments
https://www.openbanking.org.uk/terms
production
https://openbanking-ma.santander.co.uk/sanuk/external
Endpoint for Open Banking TLS MA only
Santander Internal Release Version: 3.1.10
Paths
/domestic-payment-consents
/domestic-payment-consents/{ConsentId}
/domestic-payment-consents/{ConsentId}/funds-confirmation
/domestic-payments
post /domestic-payments
Domestic Payments
This endpoint allows the PISP to submit a domestic payment for processing.
Once the domestic payment consent has been authorised by the PSU, the PISP can proceed to submitting the domestic payment for processing. This request is an instruction to the ASPSP to begin the domestic single immediate payment journey. The domestic payment must be submitted immediately where possible. The PISP must ensure that the Initiation and Risk sections of the domestic payment match that of the corresponding consent resource. If the two do not match, the ASPSP must not process the request and must respond with a 400 (Bad Request). Any operations on the domestic payment resource will not result in a status change for the domestic payment 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
Authorization URL
https://authserver.example/authorization
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
OBWriteDomestic2Param
Required in body
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"
}
}
}
}x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
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
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Content-Type
Optional in header
string
application/json; charset=utf-8
Accept
Optional in header
string
application/json; charset=utf-8
201
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
405
Attribute description not found
406
Attribute description not found
415
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
POST https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/domestic-payments
Try this operation
/domestic-payments/{DomesticPaymentId}
get /domestic-payments/{DomesticPaymentId}
Domestic Payments
This endpoint allows the retrieval of a domestic payment to check its status.
Retrieves the latest execution status of a previously, successfully submitted domestic payment. Status could be Pending, Rejected, AcceptedSettlementInProcess, AcceptedSettlementCompleted, AcceptedWithoutPosting or AcceptedCreditSettlementCompleted.
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
DomesticPaymentId
Required in path
string
DomesticPaymentId
x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
200
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/domestic-payments/{DomesticPaymentId}
Try this operation
/domestic-scheduled-payment-consents
/domestic-scheduled-payment-consents/{ConsentId}
/domestic-scheduled-payments
post /domestic-scheduled-payments
Domestic Scheduled Payments
This endpoint allows the PISP to submit a domestic scheduled payment for processing.
This request is an instruction to the ASPSP to begin the domestic scheduled payment journey. The PISP must submit the domestic scheduled payment immediately where possible. The PISP must ensure that the Initiation and Risk sections of the domestic scheduled payment match that of the corresponding consent resource. If the two do not match, the ASPSP must not process the request and must respond with a 400 (Bad Request). Any operations on the domestic scheduled payment resource will not result in a Status change for the domestic scheduled payment 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
Authorization URL
https://authserver.example/authorization
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
OBWriteDomesticScheduled2Param
Required in body
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"
}
}
}
}x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
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
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Content-Type
Optional in header
string
application/json; charset=utf-8
Accept
Optional in header
string
application/json; charset=utf-8
201
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
415
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
POST https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/domestic-scheduled-payments
Try this operation
/domestic-scheduled-payments/{DomesticScheduledPaymentId}
get /domestic-scheduled-payments/{DomesticScheduledPaymentId}
Domestic Scheduled Payments
This endpoint allows the retrieval of a domestic scheduled payment to check its status.
Retrieves the latest status of a previously, successfully submitted domestic scheduled payment. Status could be InitiationPending, InitiationFailed, InitiationCompleted or Cancelled.
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
DomesticScheduledPaymentId
Required in path
string
DomesticScheduledPaymentId
x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
200
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/domestic-scheduled-payments/{DomesticScheduledPaymentId}
Try this operation
/domestic-standing-order-consents
/domestic-standing-order-consents/{ConsentId}
/domestic-standing-orders
post /domestic-standing-orders
Domestic Standing Orders
This endpoint allows the PISP to submit a domestic standing order payment for processing.
This request is an instruction to the ASPSP to begin the domestic standing order journey. The PISP must submit the domestic standing order immediately where possible. The PISP must ensure that the Initiation and Risk sections of the domestic standing order match that of the corresponding consent resource. If the two do not match, the ASPSP must not process the request and must respond with a 400 (Bad Request). Any operations on the domestic standing order resource will not result in a Status change for the domestic standing order 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
Authorization URL
https://authserver.example/authorization
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
OBWriteDomesticStandingOrder3Param
Required in body
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"
}
}
}
}x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
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
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Content-Type
Optional in header
string
application/json; charset=utf-8
Accept
Optional in header
string
application/json; charset=utf-8
201
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
415
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
POST https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/domestic-standing-orders
Try this operation
/domestic-standing-orders/{DomesticStandingOrderId}
get /domestic-standing-orders/{DomesticStandingOrderId}
Domestic Standing Orders
This endpoint allows the retrieval of a domestic standing order payment to check its status.
Retrieves the latest status of a previously, successfully submitted domestic sranding order payment. Status could be InitiationPending, InitiationFailed, InitiationCompleted or Cancelled.
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
DomesticStandingOrderId
Required in path
string
DomesticStandingOrderId
x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
200
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/domestic-standing-orders/{DomesticStandingOrderId}
Try this operation
/file-payment-consents
/file-payment-consents/{ConsentId}
/file-payment-consents/{ConsentId}/file
/file-payments
post /file-payments
File Payments
This endpoint allows the PISP to submit a payment file for processing.
Allows a file to be submitted for execution, once the file has been uploaded, accepted as valid and the associated file payment consent has been authorised.
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
Authorization URL
https://authserver.example/authorization
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
OBWriteFile2Param
Required in body
Default
{
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"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": [
"FileType",
"FileHash"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.",
"properties": {
"FileType": {
"description": "Specifies the payment file type.",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.PaymentInitiation.3.1",
"UK.OBIE.pain.001.001.08"
]
},
"FileHash": {
"description": "A base64 encoding of a SHA256 hash of the file to be uploaded.",
"type": "string",
"minLength": 1,
"maxLength": 44
},
"FileReference": {
"description": "Reference for the file.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"NumberOfTransactions": {
"description": "Number of individual transactions contained in the payment information group.",
"type": "string",
"pattern": "[0-9]{1,15}"
},
"ControlSum": {
"description": "Total of all individual amounts included in the group, irrespective of currencies.",
"type": "number"
},
"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"
},
"LocalInstrument": {
"$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
},
"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"
}
}
},
"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"
}
}
}
}
}
}
}
}x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
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
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Content-Type
Optional in header
string
application/json; charset=utf-8
Accept
Optional in header
string
application/json; charset=utf-8
201
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
415
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
POST https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/file-payments
Try this operation
/file-payments/{FilePaymentId}
get /file-payments/{FilePaymentId}
File Payments
This endpoint allows the retrieval of execution status for a submitted payment file.
Retrieves the latest, overall status of a previously, successfully submitted payment file. Status could be InitiationPending, InitiationFailed or InitiationComplete.
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
FilePaymentId
Required in path
string
FilePaymentId
x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
200
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/file-payments/{FilePaymentId}
Try this operation
/file-payments/{FilePaymentId}/report-file
get /file-payments/{FilePaymentId}/report-file
File Payments
This endpoint allows the PISP to download a payment report for a previously submitted payment file.
This provides more detailed status information than the get status consent endpoint and returns a report on the processing results of Payments within the file. The report is returned in the HTTP response body.
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
FilePaymentId
Required in path
string
FilePaymentId
x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
*/*
200
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/file-payments/{FilePaymentId}/report-file
Try this operation
/international-payment-consents
/international-payment-consents/{ConsentId}
/international-payment-consents/{ConsentId}/funds-confirmation
/international-payments
post /international-payments
International Payments
This endpoint allows the PISP to submit an international payment for processing.
Once the international payment consent has been authorised by the PSU, the PISP can proceed to submitting the international payment for processing. This request is an instruction to the ASPSP to begin the international single immediate payment journey. The international payment must be submitted immediately where possible. The PISP must ensure that the Initiation and Risk sections of the international payment match that of the corresponding consent resource. If the two do not match, the ASPSP must not process the request and must respond with a 400 (Bad Request). Any operations on the international payment resource will not result in a status change for the international payment 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
Authorization URL
https://authserver.example/authorization
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
OBWriteInternational3Param
Required in body
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",
"CurrencyOfTransfer",
"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 international 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"
},
"InstructionPriority": {
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.",
"type": "string",
"enum": [
"Normal",
"Urgent"
]
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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"
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"RateType"
],
"description": "Provides details on the currency exchange rate and contract.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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"
}
}
},
"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"
}
}
}
}x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
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
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Content-Type
Optional in header
string
application/json; charset=utf-8
Accept
Optional in header
string
application/json; charset=utf-8
201
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
415
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
POST https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/international-payments
Try this operation
/international-payments/{InternationalPaymentId}
get /international-payments/{InternationalPaymentId}
International Payments
This endpoint allows the retrieval of an international payment to check its status.
Retrieves the latest status of a previously, successfully submitted international payment. Status could be Pending, Rejected, AcceptedSettlementInProcess, AcceptedSettlementCompleted, AcceptedWithoutPosting or AcceptedCreditSettlementCompleted.
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
InternationalPaymentId
Required in path
string
InternationalPaymentId
x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
200
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/international-payments/{InternationalPaymentId}
Try this operation
/international-scheduled-payment-consents
/international-scheduled-payment-consents/{ConsentId}
/international-scheduled-payment-consents/{ConsentId}/funds-confirmation
/international-scheduled-payments
post /international-scheduled-payments
International Scheduled Payments
This endpoint allows the PISP to submit an international scheduled payment for processing.
Once the international scheduled payment consent has been authorised by the PSU, the PISP can proceed to submitting the international scheduled payment for processing. This request is an instruction to the ASPSP to begin the international scheduled payment payment journey. The international scheduled payment must be submitted immediately where possible. The PISP must ensure that the Initiation and Risk sections of the international scheduled payment match that of the corresponding consent resource. If the two do not match, the ASPSP must not process the request and must respond with a 400 (Bad Request). Any operations on the international scheduled payment resource will not result in a status change for the international scheduled payment 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
Authorization URL
https://authserver.example/authorization
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
OBWriteInternationalScheduled3Param
Required in body
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",
"CurrencyOfTransfer",
"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 international 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"
},
"InstructionPriority": {
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.",
"type": "string",
"enum": [
"Normal",
"Urgent"
]
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"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"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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"
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"RateType"
],
"description": "Provides details on the currency exchange rate and contract.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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"
}
}
},
"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"
}
}
}
}x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
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
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
Content-Type
Optional in header
string
application/json; charset=utf-8
Accept
Optional in header
string
application/json; charset=utf-8
201
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
415
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
POST https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/international-scheduled-payments
Try this operation
/international-scheduled-payments/{InternationalScheduledPaymentId}
get /international-scheduled-payments/{InternationalScheduledPaymentId}
International Scheduled Payments
This endpoint allows the retrieval of an international scheduled payment to check its status.
Retrieves the latest status of a previously, successfully submitted international scheduled payment. Status could be InitiationPending, InitiationFailed, InitiationCompleted or Cancelled.
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
InternationalScheduledPaymentId
Required in path
string
InternationalScheduledPaymentId
x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
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
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/international-scheduled-payments/{InternationalScheduledPaymentId}
Try this operation
/domestic-vrp-consents
/domestic-vrp-consents/{ConsentId}
/domestic-vrp-consents/{ConsentId}/funds-confirmation
/domestic-vrps
post /domestic-vrps
Domestic VRPs
This endpoint allows the PISP to submit a domestic variable recurring payment for processing.
This request is an instruction to the ASPSP to begin the domestic single immediate payment journey. The domestic payment must be executed immediately where possible. The TPP must ensure that the Initiation and Risk section matches the values specified in the consent. The ASPSP must ensure that the payment instruction adheres to the limitations set by the corresponding VRP consent's ControlParameters. When a payment would breach a limitation set by one or more ControlParameters, the ASPSP must return an error details of the rule(s) that were breached.
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
OBDomesticVRPRequestParam
Required in body
Default
{
"schema": {
"type": "object",
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"required": [
"ConsentId",
"PSUAuthenticationMethod",
"Initiation",
"Instruction"
],
"properties": {
"ConsentId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Identifier for the Domestic VRP Consent that this payment is made under."
},
"PSUAuthenticationMethod": {
"allOf": [
{
"$ref": "#\/definitions\/OBVRPAuthenticationMethods"
},
{
"description": "The authentication method that was used to authenticate the PSU."
}
]
},
"Initiation": {
"$ref": "#\/definitions\/OBDomesticVRPInitiation"
},
"Instruction": {
"$ref": "#\/definitions\/OBDomesticVRPInstruction"
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
}x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
x-idempotency-key
Required in header
string
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
}Content-Type
Optional in header
string
application/json; charset=utf-8
Accept
Optional in header
string
application/json; charset=utf-8
201
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
405
Attribute description not found
406
Attribute description not found
415
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
POST https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/domestic-vrps
Try this operation
/domestic-vrps/{DomesticVRPId}
get /domestic-vrps/{DomesticVRPId}
Domestic VRPs
This endpoint allows the retrieval of an domestic variable recurring payment to check its status.
Retrieves the latest status of a previously, successfully domestic variable recurring payment payment. Status could be Pending, Rejected, AcceptedSettlementInProcess, AcceptedSettlementCompleted, AcceptedWithoutPosting or AcceptedCreditSettlementCompleted.
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://authserver.example/token
Scopes
payments
Generic payment scope
DomesticVRPId
Required in path
string
DomesticVRPId
x-fapi-auth-date
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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
200
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
405
Attribute description not found
406
Attribute description not found
415
Attribute description not found
429
Attribute description not found
500
Attribute description not found
502
Attribute description not found
503
Attribute description not found
504
Attribute description not found
Example Request
Example Response
GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp/domestic-vrps/{DomesticVRPId}
Try this operation
Definitions
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
{
"type": "string",
"pattern": "^[A-Z]{3,3}$"
}
Number that identifies the position of a building on a street.
{
"type": "string",
"minLength": 1,
"maxLength": 16
}
Nation with its own government.
{
"type": "string",
"pattern": "^[A-Z]{2,2}$"
}
Identifies a subdivision of a country such as state, region, county.
{
"type": "string",
"minLength": 1,
"maxLength": 35
}
Identification of a division of a large organisation or building.
{
"type": "string",
"minLength": 1,
"maxLength": 70
}
{
"type": "object",
"additionalProperties": false,
"properties": []
}
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
{
"type": "string",
"format": "date-time"
}
Identification assigned by an institution to identify an account. This identification is known by the account owner.
{
"type": "string",
"minLength": 1,
"maxLength": 256
}
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
{
"type": "string",
"minLength": 1,
"maxLength": 35
}
Links relevant to the payload
{
"type": "object",
"additionalProperties": false,
"properties": {
"Self": {
"type": "string",
"format": "uri"
},
"First": {
"type": "string",
"format": "uri"
},
"Prev": {
"type": "string",
"format": "uri"
},
"Next": {
"type": "string",
"format": "uri"
},
"Last": {
"type": "string",
"format": "uri"
}
},
"required": [
"Self"
]
}
Meta Data relevant to the payload
{
"title": "MetaData",
"type": "object",
"additionalProperties": false,
"properties": {
"TotalPages": {
"type": "integer",
"format": "int32"
},
"FirstAvailableDateTime": {
"$ref": "#\/definitions\/ISODateTime"
},
"LastAvailableDateTime": {
"$ref": "#\/definitions\/ISODateTime"
}
}
}
Meta Data relevant to the payload. At present no fields are used for VRP.
{
"title": "MetaData",
"type": "object"
}
Name by which an agent is known and which is usually used to identify that agent.
{
"type": "string",
"minLength": 1,
"maxLength": 140
}
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
{
"type": "string",
"pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$"
}
Amount of money associated with the charge type.
{
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"properties": {
"Amount": {
"$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#\/definitions\/ActiveOrHistoricCurrencyCode"
}
}
}
Identifies the nature of the postal address.
{
"type": "string",
"enum": [
"Business",
"Correspondence",
"DeliveryTo",
"MailTo",
"POBox",
"Postal",
"Residential",
"Statement"
]
}
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
{
"type": "string",
"enum": [
"BorneByCreditor",
"BorneByDebtor",
"FollowingServiceLevel",
"Shared"
]
}
{
"type": "object",
"additionalProperties": false,
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.Field.Expected",
"UK.OBIE.Field.Invalid",
"UK.OBIE.Field.InvalidDate",
"UK.OBIE.Field.Missing",
"UK.OBIE.Field.Unexpected",
"UK.OBIE.Header.Invalid",
"UK.OBIE.Header.Missing",
"UK.OBIE.Reauthenticate",
"UK.OBIE.Resource.ConsentMismatch",
"UK.OBIE.Resource.InvalidConsentStatus",
"UK.OBIE.Resource.InvalidFormat",
"UK.OBIE.Resource.NotFound",
"UK.OBIE.Rules.AfterCutOffDateTime",
"UK.OBIE.Rules.DuplicateReference",
"UK.OBIE.Rules.FailsControlParameters",
"UK.OBIE.Signature.Invalid",
"UK.OBIE.Signature.InvalidClaim",
"UK.OBIE.Signature.Malformed",
"UK.OBIE.Signature.Missing",
"UK.OBIE.Signature.MissingClaim",
"UK.OBIE.Signature.Unexpected",
"UK.OBIE.UnexpectedError",
"UK.OBIE.Unsupported.AccountIdentifier",
"UK.OBIE.Unsupported.AccountSecondaryIdentifier",
"UK.OBIE.Unsupported.Currency",
"UK.OBIE.Unsupported.Frequency",
"UK.OBIE.Unsupported.LocalInstrument",
"UK.OBIE.Unsupported.Scheme"
]
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode",
"Message"
],
"minProperties": 1
}
An array of detail error codes, and messages, and URLs to documentation to help remediation.
{
"type": "object",
"additionalProperties": false,
"properties": {
"Code": {
"description": "High level textual error code, to help categorize the errors.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown\/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Message": {
"description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Errors": {
"items": {
"$ref": "#\/definitions\/OBError1"
},
"type": "array",
"minItems": 1
}
},
"required": [
"Code",
"Message",
"Errors"
]
}
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"
]
}
Name of the identification scheme, in a coded form as published in an external list.
{
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.BICFI"
]
}
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
{
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.BACS",
"UK.OBIE.BalanceTransfer",
"UK.OBIE.CHAPS",
"UK.OBIE.Euro1",
"UK.OBIE.FPS",
"UK.OBIE.Link",
"UK.OBIE.MoneyTransfer",
"UK.OBIE.Paym",
"UK.OBIE.SEPACreditTransfer",
"UK.OBIE.SEPAInstantCreditTransfer",
"UK.OBIE.SWIFT",
"UK.OBIE.Target2"
]
}
Charge type, in a coded form.
{
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.CHAPSOut",
"UK.OBIE.BalanceTransferOut",
"UK.OBIE.MoneyTransferOut"
]
}
Information that locates and identifies a specific address, as defined by postal services.
{
"type": "object",
"additionalProperties": false,
"properties": {
"AddressType": {
"$ref": "#\/definitions\/OBAddressTypeCode"
},
"Department": {
"$ref": "#\/definitions\/Department"
},
"SubDepartment": {
"$ref": "#\/definitions\/SubDepartment"
},
"StreetName": {
"$ref": "#\/definitions\/StreetName"
},
"BuildingNumber": {
"$ref": "#\/definitions\/BuildingNumber"
},
"PostCode": {
"$ref": "#\/definitions\/PostCode"
},
"TownName": {
"$ref": "#\/definitions\/TownName"
},
"CountrySubDivision": {
"$ref": "#\/definitions\/CountrySubDivision"
},
"Country": {
"$ref": "#\/definitions\/CountryCode"
},
"AddressLine": {
"type": "array",
"items": {
"description": "Information that locates and identifies a specific address, as defined by postal services, presented in free format text.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"minItems": 0,
"maxItems": 7
}
}
}
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.",
"minLength": 0,
"maxLength": 350
}
}
}
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
{
"type": "object",
"additionalProperties": false,
"properties": {
"PaymentContextCode": {
"description": "Specifies the payment context",
"type": "string",
"enum": [
"BillingGoodsAndServicesInAdvance",
"BillingGoodsAndServicesInArrears",
"PispPayee",
"EcommerceMerchantInitiatedPayment",
"FaceToFacePointOfSale",
"TransferToSelf",
"TransferToThirdParty",
"BillPayment",
"EcommerceGoods",
"EcommerceServices",
"Other",
"PartyToParty"
]
},
"MerchantCategoryCode": {
"description": "Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.",
"type": "string",
"minLength": 3,
"maxLength": 4
},
"MerchantCustomerIdentification": {
"description": "The unique customer identifier of the PSU with the merchant.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"ContractPresentIndicator": {
"description": "Indicates if Payee has a contractual relationship with the PISP",
"type": "boolean"
},
"BeneficiaryPrepopulatedIndicator": {
"description": "Indicates if PISP has immutably prepopulated payment details in for the PSU",
"type": "boolean"
},
"PaymentPurposeCode": {
"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",
"type": "string",
"minLength": 3,
"maxLength": 4
},
"BeneficiaryAccountType": {
"$ref": "#\/definitions\/OBExternalExtendedAccountType1Code"
},
"DeliveryAddress": {
"type": "object",
"additionalProperties": false,
"required": [
"TownName",
"Country"
],
"description": "Information that locates and identifies a specific address, as defined by postal services or in free format text.",
"properties": {
"AddressLine": {
"type": "array",
"items": {
"description": "Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"minItems": 0,
"maxItems": 2
},
"StreetName": {
"$ref": "#\/definitions\/StreetName"
},
"BuildingNumber": {
"$ref": "#\/definitions\/BuildingNumber"
},
"PostCode": {
"$ref": "#\/definitions\/PostCode"
},
"TownName": {
"$ref": "#\/definitions\/TownName"
},
"CountrySubDivision": {
"$ref": "#\/definitions\/CountrySubDivision"
},
"Country": {
"description": "Nation with its own government, occupying a particular territory.",
"type": "string",
"pattern": "^[A-Z]{2,2}$"
}
}
}
}
}
Additional information that can not be captured in the structured fields and/or any other specific block.
{
"type": "object",
"properties": [],
"additionalProperties": true
}
Specifies the extended type of account.
{
"type": "string",
"enum": [
"Business",
"BusinessSavingsAccount",
"Charity",
"Collection",
"Corporate",
"Ewallet",
"Government",
"Investment",
"ISA",
"JointPersonal",
"Pension",
"Personal",
"PersonalSavingsAccount",
"Premier",
"Wealth"
]
}
{
"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"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"Initiation"
],
"properties": {
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the resource was created.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"
},
"Status": {
"description": "Specifies the status of consent resource in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Consumed",
"Rejected"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.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"
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"CutOffDateTime": {
"description": "Specified cut-off date and time for the payment consent.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"
},
"ExpectedExecutionDateTime": {
"description": "Expected execution date and time for the payment resource.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"
},
"ExpectedSettlementDateTime": {
"description": "Expected settlement date and time for the payment resource.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"
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"DomesticPaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"DomesticPaymentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the message was created.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"
},
"Status": {
"description": "Specifies the status of the payment information group.",
"type": "string",
"enum": [
"AcceptedCreditSettlementCompleted",
"AcceptedSettlementCompleted",
"AcceptedSettlementInProcess",
"AcceptedWithoutPosting",
"Pending",
"Rejected"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.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"
},
"ExpectedExecutionDateTime": {
"description": "Expected execution date and time for the payment resource.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"
},
"ExpectedSettlementDateTime": {
"description": "Expected settlement date and time for the payment resource.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"
},
"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": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"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"
}
}
},
"MultiAuthorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"Status"
],
"description": "The multiple authorisation flow response from the ASPSP.",
"properties": {
"Status": {
"description": "Specifies the status of the authorisation flow in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingFurtherAuthorisation",
"Rejected"
]
},
"NumberRequired": {
"description": "Number of authorisations required for payment order (total required at the start of the multi authorisation journey).",
"type": "integer"
},
"NumberReceived": {
"description": "Number of authorisations received.",
"type": "integer"
},
"LastUpdateDateTime": {
"description": "Last date and time at the authorisation flow was updated.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"
},
"ExpirationDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"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"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"Permission",
"Initiation"
],
"properties": {
"Permission": {
"description": "Specifies the Open Banking service request types.",
"type": "string",
"enum": [
"Create"
]
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Permission",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the resource was created.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"
},
"Status": {
"description": "Specifies the status of consent resource in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Consumed",
"Rejected"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the consent resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \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"
},
"Permission": {
"description": "Specifies the Open Banking service request types.",
"type": "string",
"enum": [
"Create"
]
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"CutOffDateTime": {
"description": "Specified cut-off date and time for the payment consent.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"
},
"ExpectedExecutionDateTime": {
"description": "Expected execution date and time for the payment resource.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"
},
"ExpectedSettlementDateTime": {
"description": "Expected settlement date and time for the payment resource.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"
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"DomesticScheduledPaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"DomesticScheduledPaymentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the message was created.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"
},
"Status": {
"description": "Specifies the status of the payment order resource.",
"type": "string",
"enum": [
"Cancelled",
"InitiationCompleted",
"InitiationFailed",
"InitiationPending"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.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"
},
"ExpectedExecutionDateTime": {
"description": "Expected execution date and time for the payment resource.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"
},
"ExpectedSettlementDateTime": {
"description": "Expected settlement date and time for the payment resource.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"
},
"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": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"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"
}
}
},
"MultiAuthorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"Status"
],
"description": "The multiple authorisation flow response from the ASPSP.",
"properties": {
"Status": {
"description": "Specifies the status of the authorisation flow in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingFurtherAuthorisation",
"Rejected"
]
},
"NumberRequired": {
"description": "Number of authorisations required for payment order (total required at the start of the multi authorisation journey).",
"type": "integer"
},
"NumberReceived": {
"description": "Number of authorisations received.",
"type": "integer"
},
"LastUpdateDateTime": {
"description": "Last date and time at the authorisation flow was updated.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"
},
"ExpirationDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"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"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"Permission",
"Initiation"
],
"properties": {
"Permission": {
"description": "Specifies the Open Banking service request types.",
"type": "string",
"enum": [
"Create"
]
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Permission",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the resource was created.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"
},
"Status": {
"description": "Specifies the status of consent resource in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Consumed",
"Rejected"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.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"
},
"Permission": {
"description": "Specifies the Open Banking service request types.",
"type": "string",
"enum": [
"Create"
]
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"CutOffDateTime": {
"description": "Specified cut-off date and time for the payment consent.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"
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"DomesticStandingOrderId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"DomesticStandingOrderId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order resource.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the resource was created.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"
},
"Status": {
"description": "Specifies the status of the payment order resource.",
"type": "string",
"enum": [
"Cancelled",
"InitiationCompleted",
"InitiationFailed",
"InitiationPending"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.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"
},
"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": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"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"
}
}
},
"MultiAuthorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"Status"
],
"description": "The multiple authorisation flow response from the ASPSP.",
"properties": {
"Status": {
"description": "Specifies the status of the authorisation flow in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingFurtherAuthorisation",
"Rejected"
]
},
"NumberRequired": {
"description": "Number of authorisations required for payment order (total required at the start of the multi authorisation journey).",
"type": "integer"
},
"NumberReceived": {
"description": "Number of authorisations received.",
"type": "integer"
},
"LastUpdateDateTime": {
"description": "Last date and time at the authorisation flow was updated.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"
},
"ExpirationDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"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": [
"FileType",
"FileHash"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.",
"properties": {
"FileType": {
"description": "Specifies the payment file type.",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.PaymentInitiation.3.1",
"UK.OBIE.pain.001.001.08"
]
},
"FileHash": {
"description": "A base64 encoding of a SHA256 hash of the file to be uploaded.",
"type": "string",
"minLength": 1,
"maxLength": 44
},
"FileReference": {
"description": "Reference for the file.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"NumberOfTransactions": {
"description": "Number of individual transactions contained in the payment information group.",
"type": "string",
"pattern": "[0-9]{1,15}"
},
"ControlSum": {
"description": "Total of all individual amounts included in the group, irrespective of currencies.",
"type": "number"
},
"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"
},
"LocalInstrument": {
"$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
},
"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"
}
}
},
"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"
}
}
}
}
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"Initiation"
],
"properties": {
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"FileType",
"FileHash"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.",
"properties": {
"FileType": {
"description": "Specifies the payment file type.",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.PaymentInitiation.3.1",
"UK.OBIE.pain.001.001.08"
]
},
"FileHash": {
"description": "A base64 encoding of a SHA256 hash of the file to be uploaded.",
"type": "string",
"minLength": 1,
"maxLength": 44
},
"FileReference": {
"description": "Reference for the file.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"NumberOfTransactions": {
"description": "Number of individual transactions contained in the payment information group.",
"type": "string",
"pattern": "[0-9]{1,15}"
},
"ControlSum": {
"description": "Total of all individual amounts included in the group, irrespective of currencies.",
"type": "number"
},
"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"
},
"LocalInstrument": {
"$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
},
"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"
}
}
},
"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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
}
}
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the resource was created.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"
},
"Status": {
"description": "Specifies the status of consent resource in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"AwaitingUpload",
"Consumed",
"Rejected"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the consent resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \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"
},
"CutOffDateTime": {
"description": "Specified cut-off date and time for the payment consent.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"
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"FileType",
"FileHash"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.",
"properties": {
"FileType": {
"description": "Specifies the payment file type.",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.PaymentInitiation.3.1",
"UK.OBIE.pain.001.001.08"
]
},
"FileHash": {
"description": "A base64 encoding of a SHA256 hash of the file to be uploaded.",
"type": "string",
"minLength": 1,
"maxLength": 44
},
"FileReference": {
"description": "Reference for the file.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"NumberOfTransactions": {
"description": "Number of individual transactions contained in the payment information group.",
"type": "string",
"pattern": "[0-9]{1,15}"
},
"ControlSum": {
"description": "Total of all individual amounts included in the group, irrespective of currencies.",
"type": "number"
},
"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"
},
"LocalInstrument": {
"$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
},
"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"
}
}
},
"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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"FilePaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"FilePaymentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the message was created.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"
},
"Status": {
"description": "Specifies the status of the payment order resource.",
"type": "string",
"enum": [
"InitiationCompleted",
"InitiationFailed",
"InitiationPending"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.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"
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"FileType",
"FileHash"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.",
"properties": {
"FileType": {
"description": "Specifies the payment file type.",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.PaymentInitiation.3.1",
"UK.OBIE.pain.001.001.08"
]
},
"FileHash": {
"description": "A base64 encoding of a SHA256 hash of the file to be uploaded.",
"type": "string",
"minLength": 1,
"maxLength": 44
},
"FileReference": {
"description": "Reference for the file.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"NumberOfTransactions": {
"description": "Number of individual transactions contained in the payment information group.",
"type": "string",
"pattern": "[0-9]{1,15}"
},
"ControlSum": {
"description": "Total of all individual amounts included in the group, irrespective of currencies.",
"type": "number"
},
"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"
},
"LocalInstrument": {
"$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
},
"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"
}
}
},
"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"
}
}
},
"MultiAuthorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"Status"
],
"description": "The multiple authorisation flow response from the ASPSP.",
"properties": {
"Status": {
"description": "Specifies the status of the authorisation flow in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingFurtherAuthorisation",
"Rejected"
]
},
"NumberRequired": {
"description": "Number of authorisations required for payment order (total required at the start of the multi authorisation journey).",
"type": "integer"
},
"NumberReceived": {
"description": "Number of authorisations received.",
"type": "integer"
},
"LastUpdateDateTime": {
"description": "Last date and time at the authorisation flow was updated.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"
},
"ExpirationDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"properties": {
"FundsAvailableResult": {
"type": "object",
"additionalProperties": false,
"required": [
"FundsAvailableDateTime",
"FundsAvailable"
],
"description": "Result of a funds availability check.",
"properties": {
"FundsAvailableDateTime": {
"description": "Date and time at which the funds availability check was generated.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"
},
"FundsAvailable": {
"description": "Flag to indicate the availability of funds given the Amount in the consent request.",
"type": "boolean"
}
}
},
"SupplementaryData": {
"$ref": "#\/definitions\/OBSupplementaryData1"
}
}
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"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",
"CurrencyOfTransfer",
"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 international 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"
},
"InstructionPriority": {
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.",
"type": "string",
"enum": [
"Normal",
"Urgent"
]
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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"
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"RateType"
],
"description": "Provides details on the currency exchange rate and contract.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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"
}
}
},
"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"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"Initiation"
],
"properties": {
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"CurrencyOfTransfer",
"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 international 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"
},
"InstructionPriority": {
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.",
"type": "string",
"enum": [
"Normal",
"Urgent"
]
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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"
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"RateType"
],
"description": "Provides details on the currency exchange rate and contract.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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"
}
}
},
"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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the resource was created.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"
},
"Status": {
"description": "Specifies the status of consent resource in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Consumed",
"Rejected"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.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"
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"CutOffDateTime": {
"description": "Specified cut-off date and time for the payment consent.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"
},
"ExpectedExecutionDateTime": {
"description": "Expected execution date and time for the payment resource.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"
},
"ExpectedSettlementDateTime": {
"description": "Expected settlement date and time for the payment resource.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"
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"ExchangeRate",
"RateType"
],
"description": "Further detailed information on the exchange rate that has been used in the payment transaction.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"ExpirationDateTime": {
"description": "Specified date and time the exchange rate agreement will expire.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"
}
}
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"CurrencyOfTransfer",
"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 international 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"
},
"InstructionPriority": {
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.",
"type": "string",
"enum": [
"Normal",
"Urgent"
]
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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"
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"RateType"
],
"description": "Provides details on the currency exchange rate and contract.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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"
}
}
},
"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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"InternationalPaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"InternationalPaymentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the international payment resource.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the message was created.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"
},
"Status": {
"description": "Specifies the status of the payment information group.",
"type": "string",
"enum": [
"AcceptedCreditSettlementCompleted",
"AcceptedSettlementCompleted",
"AcceptedSettlementInProcess",
"AcceptedWithoutPosting",
"Pending",
"Rejected"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.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"
},
"ExpectedExecutionDateTime": {
"description": "Expected execution date and time for the payment resource.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"
},
"ExpectedSettlementDateTime": {
"description": "Expected settlement date and time for the payment resource.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"
},
"Refund": {
"type": "object",
"additionalProperties": false,
"required": [
"Account"
],
"properties": {
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to identify a person or an organisation.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"Agent": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"ExchangeRate",
"RateType"
],
"description": "Further detailed information on the exchange rate that has been used in the payment transaction.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"ExpirationDateTime": {
"description": "Specified date and time the exchange rate agreement will expire.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"
}
}
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"CurrencyOfTransfer",
"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 international 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"
},
"InstructionPriority": {
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.",
"type": "string",
"enum": [
"Normal",
"Urgent"
]
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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"
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"RateType"
],
"description": "Provides details on the currency exchange rate and contract.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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"
}
}
},
"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"
}
}
},
"MultiAuthorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"Status"
],
"description": "The multiple authorisation flow response from the ASPSP.",
"properties": {
"Status": {
"description": "Specifies the status of the authorisation flow in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingFurtherAuthorisation",
"Rejected"
]
},
"NumberRequired": {
"description": "Number of authorisations required for payment order (total required at the start of the multi authorisation journey).",
"type": "integer"
},
"NumberReceived": {
"description": "Number of authorisations received.",
"type": "integer"
},
"LastUpdateDateTime": {
"description": "Last date and time at the authorisation flow was updated.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"
},
"ExpirationDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"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",
"CurrencyOfTransfer",
"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 international 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"
},
"InstructionPriority": {
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.",
"type": "string",
"enum": [
"Normal",
"Urgent"
]
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"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"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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"
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"RateType"
],
"description": "Provides details on the currency exchange rate and contract.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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"
}
}
},
"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"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"Permission",
"Initiation"
],
"properties": {
"Permission": {
"description": "Specifies the Open Banking service request types.",
"type": "string",
"enum": [
"Create"
]
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"RequestedExecutionDateTime",
"CurrencyOfTransfer",
"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 international 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"
},
"InstructionPriority": {
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.",
"type": "string",
"enum": [
"Normal",
"Urgent"
]
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"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"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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"
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"RateType"
],
"description": "Provides details on the currency exchange rate and contract.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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"
}
}
},
"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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Permission",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the resource was created.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"
},
"Status": {
"description": "Specifies the status of consent resource in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Consumed",
"Rejected"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.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"
},
"Permission": {
"description": "Specifies the Open Banking service request types.",
"type": "string",
"enum": [
"Create"
]
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"CutOffDateTime": {
"description": "Specified cut-off date and time for the payment consent.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"
},
"ExpectedExecutionDateTime": {
"description": "Expected execution date and time for the payment resource.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"
},
"ExpectedSettlementDateTime": {
"description": "Expected settlement date and time for the payment resource.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"
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"ExchangeRate",
"RateType"
],
"description": "Further detailed information on the exchange rate that has been used in the payment transaction.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"ExpirationDateTime": {
"description": "Specified date and time the exchange rate agreement will expire.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"
}
}
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"RequestedExecutionDateTime",
"CurrencyOfTransfer",
"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 international 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"
},
"InstructionPriority": {
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.",
"type": "string",
"enum": [
"Normal",
"Urgent"
]
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"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"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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"
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"RateType"
],
"description": "Provides details on the currency exchange rate and contract.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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"
}
}
},
"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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"InternationalScheduledPaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"InternationalScheduledPaymentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the message was created.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"
},
"Status": {
"description": "Specifies the status of the payment order resource.",
"type": "string",
"enum": [
"Cancelled",
"InitiationCompleted",
"InitiationFailed",
"InitiationPending"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.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"
},
"ExpectedExecutionDateTime": {
"description": "Expected execution date and time for the payment resource.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"
},
"ExpectedSettlementDateTime": {
"description": "Expected settlement date and time for the payment resource.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"
},
"Refund": {
"type": "object",
"additionalProperties": false,
"required": [
"Account"
],
"properties": {
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to identify a person or an organisation.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"Agent": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"ExchangeRate",
"RateType"
],
"description": "Further detailed information on the exchange rate that has been used in the payment transaction.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"ExpirationDateTime": {
"description": "Specified date and time the exchange rate agreement will expire.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"
}
}
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"RequestedExecutionDateTime",
"CurrencyOfTransfer",
"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 international 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"
},
"InstructionPriority": {
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.",
"type": "string",
"enum": [
"Normal",
"Urgent"
]
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"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"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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"
}
}
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"required": [
"UnitCurrency",
"RateType"
],
"description": "Provides details on the currency exchange rate and contract.",
"properties": {
"UnitCurrency": {
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"type": "number"
},
"RateType": {
"description": "Specifies the type used to complete the currency exchange.",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party\/creditor and the debtor agent.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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"
}
}
},
"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"
}
}
},
"MultiAuthorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"Status"
],
"description": "The multiple authorisation flow response from the ASPSP.",
"properties": {
"Status": {
"description": "Specifies the status of the authorisation flow in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingFurtherAuthorisation",
"Rejected"
]
},
"NumberRequired": {
"description": "Number of authorisations required for payment order (total required at the start of the multi authorisation journey).",
"type": "integer"
},
"NumberReceived": {
"description": "Number of authorisations received.",
"type": "integer"
},
"LastUpdateDateTime": {
"description": "Last date and time at the authorisation flow was updated.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"
},
"ExpirationDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"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",
"CurrencyOfTransfer",
"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 an international 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"
},
"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"
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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": "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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.\nThis is the servicer of the beneficiary account.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"description": "Unique and unambiguous identification of the servicing institution.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Provides the details to identify the beneficiary 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.\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"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"Permission",
"Initiation"
],
"properties": {
"Permission": {
"description": "Specifies the Open Banking service request types.",
"type": "string",
"enum": [
"Create"
]
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"Frequency",
"FirstPaymentDateTime",
"CurrencyOfTransfer",
"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 an international 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"
},
"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"
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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": "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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.\nThis is the servicer of the beneficiary account.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"description": "Unique and unambiguous identification of the servicing institution.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Provides the details to identify the beneficiary 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.\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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Permission",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the resource was created.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"
},
"Status": {
"description": "Specifies the status of resource in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Consumed",
"Rejected"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.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"
},
"Permission": {
"description": "Specifies the Open Banking service request types.",
"type": "string",
"enum": [
"Create"
]
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"CutOffDateTime": {
"description": "Specified cut-off date and time for the payment consent.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"
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"Frequency",
"FirstPaymentDateTime",
"CurrencyOfTransfer",
"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 an international 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"
},
"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"
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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": "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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.\nThis is the servicer of the beneficiary account.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"description": "Unique and unambiguous identification of the servicing institution.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Provides the details to identify the beneficiary 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.\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"
}
}
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"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",
"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": 128
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"InternationalStandingOrderId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"InternationalStandingOrderId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the international standing order resource.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the resource was created.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"
},
"Status": {
"description": "Specifies the status of resource in code form.",
"type": "string",
"enum": [
"Cancelled",
"InitiationCompleted",
"InitiationFailed",
"InitiationPending"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.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"
},
"Refund": {
"type": "object",
"additionalProperties": false,
"required": [
"Account"
],
"properties": {
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to identify a person or an organisation.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"Agent": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_1"
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"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": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"Frequency",
"FirstPaymentDateTime",
"CurrencyOfTransfer",
"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 an international 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"
},
"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"
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.",
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExtendedPurpose": {
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"CurrencyOfTransfer": {
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"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": "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"
}
}
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "Party to which an amount of money is due.",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.\nThis is the servicer of the beneficiary account.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"description": "Unique and unambiguous identification of the servicing institution.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Name": {
"$ref": "#\/definitions\/Name"
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Provides the details to identify the beneficiary 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.\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"
}
}
},
"MultiAuthorisation": {
"type": "object",
"additionalProperties": false,
"required": [
"Status"
],
"description": "The multiple authorisation flow response from the ASPSP.",
"properties": {
"Status": {
"description": "Specifies the status of the authorisation flow in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingFurtherAuthorisation",
"Rejected"
]
},
"NumberRequired": {
"description": "Number of authorisations required for payment order (total required at the start of the multi authorisation journey).",
"type": "integer"
},
"NumberReceived": {
"description": "Number of authorisations received.",
"type": "integer"
},
"LastUpdateDateTime": {
"description": "Last date and time at the authorisation flow was updated.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"
},
"ExpirationDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.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"
}
}
},
"Debtor": {
"$ref": "#\/definitions\/OBDebtorIdentification1"
}
}
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"properties": {
"PaymentStatus": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Payment status details.",
"required": [
"PaymentTransactionId",
"Status",
"StatusUpdateDateTime"
],
"properties": {
"PaymentTransactionId": {
"description": "Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.",
"type": "string",
"minLength": 1,
"maxLength": 210
},
"Status": {
"description": "Status of a transfe, as assigned by the transaction administrator.",
"type": "string",
"enum": [
"Accepted",
"AcceptedCancellationRequest",
"AcceptedCreditSettlementCompleted",
"AcceptedCustomerProfile",
"AcceptedFundsChecked",
"AcceptedSettlementCompleted",
"AcceptedSettlementInProcess",
"AcceptedTechnicalValidation",
"AcceptedWithChange",
"AcceptedWithoutPosting",
"Cancelled",
"NoCancellationProcess",
"PartiallyAcceptedCancellationRequest",
"PartiallyAcceptedTechnicalCorrect",
"PaymentCancelled",
"Pending",
"PendingCancellationRequest",
"Received",
"Rejected",
"RejectedCancellationRequest"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the status was assigned to the transfer.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"
},
"StatusDetail": {
"type": "object",
"additionalProperties": false,
"required": [
"Status"
],
"description": "Payment status details as per underlying Payment Rail.",
"properties": {
"LocalInstrument": {
"$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
},
"Status": {
"description": "Status of a transfer, as assigned by the transaction administrator.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"StatusReason": {
"description": "Reason Code provided for the status of a transfer.",
"type": "string",
"enum": [
"Cancelled",
"PendingFailingSettlement",
"PendingSettlement",
"Proprietary",
"ProprietaryRejection",
"Suspended",
"Unmatched"
]
},
"StatusReasonDescription": {
"description": "Reason provided for the status of a transfer.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
}
}
}
}
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Meta"
}
}
}
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
}
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
}
Name of a street or thoroughfare.
{
"type": "string",
"minLength": 1,
"maxLength": 70
}
Identification of a sub-division of a large organisation or building.
{
"type": "string",
"minLength": 1,
"maxLength": 70
}
Name of a built-up area, with defined boundaries, and a local government.
{
"type": "string",
"minLength": 1,
"maxLength": 35
}
{
"type": "object",
"required": [
"Data",
"Risk",
"Links",
"Meta"
],
"properties": {
"Data": {
"type": "object",
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"ControlParameters",
"Initiation"
],
"properties": {
"ReadRefundAccount": {
"type": "string",
"enum": [
"Yes",
"No"
],
"description": "Indicates whether information about RefundAccount should be included in the payment response.\n"
},
"ConsentId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique identification as assigned by the ASPSP to uniquely identify the consent resource.\n"
},
"CreationDateTime": {
"type": "string",
"format": "date-time",
"description": "Date and time at which the resource was created.\n"
},
"Status": {
"type": "string",
"description": "Specifies the status of resource in code form.\n",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Rejected",
"Expired"
]
},
"StatusUpdateDateTime": {
"type": "string",
"format": "date-time",
"description": "Date and time at which the resource status was updated.\n"
},
"ControlParameters": {
"$ref": "#\/definitions\/OBDomesticVRPControlParameters"
},
"Initiation": {
"$ref": "#\/definitions\/OBDomesticVRPInitiation"
},
"DebtorAccount": {
"description": "The value must be populated for GET responses once the consent is approved.",
"$ref": "#\/definitions\/OBCashAccountDebtorWithName"
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/VrpMeta"
}
}
}
{
"type": "object",
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"required": [
"ControlParameters",
"Initiation"
],
"properties": {
"ReadRefundAccount": {
"type": "string",
"enum": [
"Yes",
"No"
],
"description": "Indicates whether information about RefundAccount should be included in the payment response.\n"
},
"ControlParameters": {
"$ref": "#\/definitions\/OBDomesticVRPControlParameters"
},
"Initiation": {
"$ref": "#\/definitions\/OBDomesticVRPInitiation"
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
{
"type": "object",
"required": [
"VRPType",
"PSUAuthenticationMethods",
"MaximumIndividualAmount",
"PeriodicLimits"
],
"properties": {
"ValidFromDateTime": {
"type": "string",
"format": "date-time",
"description": "Start date time for which the consent remains valid."
},
"ValidToDateTime": {
"type": "string",
"format": "date-time",
"description": "End date time for which the consent remains valid."
},
"MaximumIndividualAmount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
},
"PeriodicLimits": {
"type": "array",
"items": {
"type": "object",
"required": [
"PeriodType",
"PeriodAlignment",
"Amount",
"Currency"
],
"properties": {
"PeriodType": {
"type": "string",
"enum": [
"Day",
"Week",
"Fortnight",
"Month",
"Half-year",
"Year"
],
"description": "Period type for this period limit"
},
"PeriodAlignment": {
"type": "string",
"enum": [
"Consent",
"Calendar"
],
"description": "Specifies whether the period starts on the date of consent creation or lines up with a calendar"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#\/definitions\/ActiveOrHistoricCurrencyCode"
}
}
}
},
"VRPType": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OBVRPConsentType"
},
"minItems": 1,
"description": "The types of payments that can be made under this VRP consent. This can be used to indicate whether this include sweeping payment or other ecommerce payments."
},
"PSUAuthenticationMethods": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OBVRPAuthenticationMethods"
},
"minItems": 1,
"description": "Indicates that the PSU authentication methods supported."
},
"PSUInteractionTypes": {
"type": "array",
"items": {
"$ref": "#\/definitions\/OBVRPInteractionTypes"
},
"description": "Indicates interaction type, currently if customer is present or not present."
},
"SupplementaryData": {
"type": "object",
"description": "Additional information that can not be captured in the structured fields and\/or any other specific block"
}
}
}
{
"type": "object",
"properties": {
"DebtorAccount": {
"$ref": "#\/definitions\/OBCashAccountDebtorWithName"
},
"CreditorAgent": {
"$ref": "#\/definitions\/OBBranchAndFinancialInstitutionIdentification6"
},
"CreditorPostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
},
"CreditorAccount": {
"$ref": "#\/definitions\/OBCashAccountCreditor3"
},
"RemittanceInformation": {
"type": "object",
"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": {
"type": "string",
"minLength": 1,
"maxLength": 140,
"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."
},
"Reference": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage - 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. If 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": "object",
"required": [
"SchemeName",
"Identification",
"Name"
],
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalAccountIdentification4Code"
},
"Identification": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner."
},
"Name": {
"type": "string",
"minLength": 1,
"maxLength": 350,
"description": "Name of the account, as assigned by the account servicing institution. Usage 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."
},
"SecondaryIdentification": {
"type": "string",
"minLength": 1,
"maxLength": 34,
"description": "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": "object",
"required": [
"SchemeName",
"Identification",
"Name"
],
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalAccountIdentification4Code",
"description": "Name of the identification scheme, in a coded form as published in an external list."
},
"Identification": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner."
},
"Name": {
"type": "string",
"minLength": 1,
"maxLength": 350,
"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.\nThe account name is not the product name or the nickname of the account."
},
"SecondaryIdentification": {
"type": "string",
"minLength": 1,
"maxLength": 34,
"description": "This is secondary identification of the account, as assigned by the account servicing institution.\nThis 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": "object",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution."
},
"Name": {
"type": "string",
"minLength": 1,
"maxLength": 140,
"description": "Name by which an agent is known and which is usually used to identify that agent."
},
"PostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
}
}
}
{
"type": "object",
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"required": [
"ConsentId",
"PSUAuthenticationMethod",
"Initiation",
"Instruction"
],
"properties": {
"ConsentId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Identifier for the Domestic VRP Consent that this payment is made under."
},
"PSUAuthenticationMethod": {
"allOf": [
{
"$ref": "#\/definitions\/OBVRPAuthenticationMethods"
},
{
"description": "The authentication method that was used to authenticate the PSU."
}
]
},
"Initiation": {
"$ref": "#\/definitions\/OBDomesticVRPInitiation"
},
"Instruction": {
"$ref": "#\/definitions\/OBDomesticVRPInstruction"
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
{
"type": "object",
"required": [
"Data",
"Risk",
"Links",
"Meta"
],
"properties": {
"Data": {
"type": "object",
"required": [
"DomesticVRPId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation",
"Instruction"
],
"properties": {
"DomesticVRPId": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"description": "Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.\n"
},
"ConsentId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Identifier for the Domestic VRP Consent that this payment is made under.\n"
},
"CreationDateTime": {
"type": "string",
"format": "date-time",
"description": "Date and time at which the resource was created.\n"
},
"Status": {
"type": "string",
"description": "Specifies the status of the payment information group.",
"enum": [
"AcceptedCreditSettlementCompleted",
"AcceptedWithoutPosting",
"AcceptedSettlementCompleted",
"AcceptedSettlementInProcess",
"Pending",
"Rejected"
]
},
"StatusReason": {
"$ref": "#\/definitions\/OBVRPStatusReasonCode"
},
"StatusReasonDescription": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "Description related to provided Status\/StatusReason \n"
},
"StatusUpdateDateTime": {
"type": "string",
"format": "date-time",
"description": "Date and time at which the resource status was updated.\n"
},
"ExpectedExecutionDateTime": {
"type": "string",
"format": "date-time",
"description": "Expected execution date and time for the payment resource.\n"
},
"ExpectedSettlementDateTime": {
"type": "string",
"format": "date-time",
"description": "Expected settlement date and time for the payment resource.\n"
},
"Refund": {
"$ref": "#\/definitions\/OBCashAccountDebtorWithName",
"description": "Only included in the response if `Data.ReadRefundAccount` is set to `Yes` in the consent.\n"
},
"Charges": {
"type": "array",
"items": {
"required": [
"Amount",
"ChargeBearer",
"Type"
],
"type": "object",
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
},
"description": "Set of elements used to provide details of a charge for the payment initiation."
}
},
"Initiation": {
"$ref": "#\/definitions\/OBDomesticVRPInitiation"
},
"Instruction": {
"$ref": "#\/definitions\/OBDomesticVRPInstruction"
},
"DebtorAccount": {
"$ref": "#\/definitions\/OBCashAccountDebtorWithName"
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/VrpMeta"
}
}
}
The OBVRPFundsConfirmationRequest object must be used to request funds availability for a specific amount in the Debtor Account included in the VRP consents.
{
"type": "object",
"properties": {
"Data": {
"type": "object",
"required": [
"ConsentId",
"InstructedAmount"
],
"properties": {
"ConsentId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource."
},
"Reference": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Unique reference, as assigned by the PISP, to unambiguously refer to the request related to the payment transaction."
},
"InstructedAmount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
}
}
The confirmation of funds response contains the result of a funds availability check.
{
"type": "object",
"properties": {
"Data": {
"type": "object",
"required": [
"FundsConfirmationId",
"ConsentId",
"CreationDateTime",
"FundsAvailableResult",
"InstructedAmount"
],
"properties": {
"FundsConfirmationId": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"description": "Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation resource."
},
"ConsentId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource."
},
"CreationDateTime": {
"type": "string",
"format": "date-time",
"description": "Date and time at which the resource was created."
},
"Reference": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction."
},
"FundsAvailableResult": {
"$ref": "#\/definitions\/OBPAFundsAvailableResult1"
},
"InstructedAmount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
}
}
Availability result, clearly indicating the availability of funds given the Amount in the request.
{
"type": "object",
"required": [
"FundsAvailableDateTime",
"FundsAvailable"
],
"properties": {
"FundsAvailableDateTime": {
"type": "string",
"format": "date-time",
"description": "Date and time at which the funds availability check was generated."
},
"FundsAvailable": {
"type": "string",
"description": "Availability result, clearly indicating the availability of funds given the Amount in the request.",
"enum": [
"Available",
"NotAvailable"
]
}
}
}
{
"type": "object",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#\/definitions\/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
{
"type": "string",
"enum": [
"Authorised",
"AwaitingFurtherAuthorisation",
"Rejected"
]
}
{
"type": "object",
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"InstructedAmount",
"CreditorAccount"
],
"properties": {
"InstructionIdentification": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"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.\nIt can be included in several messages related to the instruction."
},
"EndToEndIdentification": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Unique identification assigned by the initiating party to unambiguously identify the transaction.\nThis 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.\nIt can be included in several messages related to the transaction.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field"
},
"RemittanceInformation": {
"$ref": "#\/definitions\/OBVRPRemittanceInformation"
},
"LocalInstrument": {
"$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
},
"InstructedAmount": {
"$ref": "#\/definitions\/OBActiveOrHistoricCurrencyAndAmount"
},
"CreditorAgent": {
"$ref": "#\/definitions\/OBBranchAndFinancialInstitutionIdentification6"
},
"CreditorPostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
},
"CreditorAccount": {
"$ref": "#\/definitions\/OBCashAccountCreditor3"
},
"SupplementaryData": {
"type": "object",
"description": "Additional information that can not be captured in the structured fields and\/or any other specific block.\n"
}
}
}
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.
{
"type": "object",
"properties": {
"Unstructured": {
"type": "string",
"minLength": 1,
"maxLength": 140,
"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."
},
"Reference": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. The PISP must populate this with the same value as specified in the `Data.Initiation.RemittanceInformation.Reference` of the consent."
}
}
}
Reason Code provided for the status of a VRP. To be documented in the Developer Portal.
{
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.ExemptionNotApplied",
"UK.OBIE.OtherReason"
]
}
{
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.VRPType.Sweeping",
"UK.OBIE.VRPType.Other"
]
}
{
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.SCA",
"UK.OBIE.SCANotRequired"
]
}
{
"type": "string",
"enum": [
"InSession",
"OffSession"
]
}