Skip to main content

Page contents

What this API does:

This API lets you create a domestic-standing-order-consent resource and submit domestic standing order payment request. It also lets you check the domestic standing order payment status.

Endpoint configuration

Sandbox:  cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/domestic-standing-order-consents

Production:  api.openbanking.virginmoney.com/open-banking/v3.1/pisp/domestic-standing-order-consents

The API endpoint lets you ask Virgin Money to create a new domestic-standing-order-consents resource:

  • The POST action tells Virgin Money that a domestic standing order payment consent has been staged. At this point, it does not identify the customer to Virgin Money; the request payload may not contain information about the account to be debited.
  • The endpoint lets you send a copy of the consent between the customer and you, to Virgin Money for the customer to authorise.

Virgin Money will create a domestic-standing-order-consents resource and provide a unique ConsentId.

Before calling the API, you must have an access token issued by Virgin Money using a 'Client Credentials' grant.

Sandbox:  cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/domestic-standing-order-consents/{ConsentId}

Production:  api.openbanking.virginmoney.com/open-banking/v3.1/pisp/domestic-standing-order-consents/{ConsentId}

Check the status of the domestic-standing-order-consents. 

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

Sandbox:  cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/domestic-standing-orders

Production:  api.openbanking.virginmoney.com/open-banking/v3.1/pisp/domestic-standing-orders

Once the customer has authorized the domestic standing order consent, you can submit the payment for processing:

  • This request instructs Virgin Money to begin the payment journey.
  • The Initiation and Risk sections of the payment must match the corresponding sections of the payment consent resource. Any discrepancy will generate an error response and request will not be processed.

Before calling the API, you must have an access token issued by Virgin Money using 'Authorization Code' grant.

Sandbox:  cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/domestic-standing-orders/{DomesticPaymentId}

Production:  api.openbanking.virginmoney.com/open-banking/v3.1/pisp/domestic-standing-orders/{DomesticPaymentId}

Check the status of the domestic standing order payment.

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

API calls

Domestic Standing Orders

NameDescription
x-fapi-auth-date
string
(header)

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

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)
An RFC4122 UID used as a correlation id.
Authorization *
string
(header)

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

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The
Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)
JOSE signature of the body of the payload.
body *
(body)

{
  "Data": {
    "Permission": "Create",
    "Initiation": {
      "Frequency": "string",
      "Reference": "string",
      "NumberOfPayments": "string",
      "FirstPaymentDateTime": "2024-06-14T13:12:16.967Z",
      "FinalPaymentDateTime": "2024-06-14T13:12:16.967Z",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "string",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}
#/definitions/OBWriteDomesticStandingOrderConsent4OBWriteDomesticStandingOrderConsent4{
Data*{
Permission*string
Specifies the Open Banking service request types.

Enum:
[ Create ]
Initiation*{
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.
Frequency*string
pattern: ^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Individual Definitions:
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-2 to -1, 1 to 31)
Individual Patterns:
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
IntrvlWkDay:0[1-9]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01])
Full Regular Expression:
^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Referencestring
minLength: 1
maxLength: 35

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.

NumberOfPaymentsstring
minLength: 1
maxLength: 35
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
FirstPaymentDateTime*string($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FinalPaymentDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FirstPaymentAmount*{
description:
The amount of the first Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
RecurringPaymentAmount{
description:
The amount of the recurring Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
FinalPaymentAmount{
description:
The amount of the final Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
DebtorAccount{
description:
Provides the details to identify the debtor account.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Namestring
minLength: 1
maxLength: 70

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.

}
CreditorAccount*{
description:
Identification assigned by an institution to identify an account. This identification is known by the account owner.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}
}
}
Risk*#/definitions/OBRisk1OBRisk1{
description:
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
PaymentContextCodestring
Specifies the payment context

Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCodestring
minLength: 3
maxLength: 4

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

MerchantCustomerIdentificationstring
minLength: 1
maxLength: 70
The unique customer identifier of the PSU with the merchant.
DeliveryAddress{
description:

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

AddressLine[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 70

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

]
PostCodePostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName*TownNamestring

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 35

Identifies a subdivision of a country, for instance state, region, county.

]
Country*string
pattern: ^[A-Z]{2,2}$

Nation with its own government, occupying a particular territory.

}
}
}

Responses

CodeDescription
201
Created

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2024-06-14T14:27:30.414Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2024-06-14T14:27:30.414Z",
    "Permission": "Create",
    "Initiation": {
      "Frequency": "string",
      "Reference": "string",
      "NumberOfPayments": "string",
      "FirstPaymentDateTime": "2024-06-14T14:27:30.414Z",
      "RecurringPaymentDateTime": "2024-06-14T14:27:30.414Z",
      "FinalPaymentDateTime": "2024-06-14T14:27:30.414Z",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "string",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-14T14:27:30.414Z",
    "LastAvailableDateTime": "2024-06-14T14:27:30.414Z"
  }
}
#/definitions/OBWriteDomesticStandingOrderConsentResponse4OBWriteDomesticStandingOrderConsentResponse4{
Data*{
ConsentId*string
minLength: 1
maxLength: 128

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

CreationDateTime*string($date-time)

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

Status*string
Specifies the status of consent resource in code form.

Enum:
[ Authorised, AwaitingAuthorisation, Consumed, Rejected ]
StatusUpdateDateTime*string($date-time)

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

Permission*string
Specifies the Open Banking service request types.

Enum:
[ Create ]
Initiation*{
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.
Frequency*string
pattern: ^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Individual Definitions:
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-2 to -1, 1 to 31)
Individual Patterns:
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
IntrvlWkDay:0[1-9]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01])
Full Regular Expression:
^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Referencestring
minLength: 1
maxLength: 35

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.

NumberOfPaymentsstring
minLength: 1
maxLength: 35
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
FirstPaymentDateTime*string($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

RecurringPaymentDateTimestring($date-time)

The date on which the first recurring payment for a Standing Order schedule will be made.
Usage: 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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FinalPaymentDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FirstPaymentAmount*{
description:
The amount of the first Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
RecurringPaymentAmount{
description:
The amount of the recurring Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
FinalPaymentAmount{
description:
The amount of the final Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
DebtorAccount{
description:
Provides the details to identify the debtor account.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Namestring
minLength: 1
maxLength: 70

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.

}
CreditorAccount*{
description:
Identification assigned by an institution to identify an account. This identification is known by the account owner.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}
}
}
Risk*#/definitions/OBRisk1OBRisk1{
description:
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
PaymentContextCodestring
Specifies the payment context

Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCodestring
minLength: 3
maxLength: 4

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

MerchantCustomerIdentificationstring
minLength: 1
maxLength: 70
The unique customer identifier of the PSU with the merchant.
DeliveryAddress{
description:

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

AddressLine[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 70

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

]
PostCodePostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName*TownNamestring

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 35

Identifies a subdivision of a country, for instance state, region, county.

]
Country*string
pattern: ^[A-Z]{2,2}$

Nation with its own government, occupying a particular territory.

}
}
Links#/definitions/LinksLinks{
description:
Links relevant to the payload
Self*string
Firststring
Prevstring
Nextstring
Laststring
}
Meta#/definitions/MetaMeta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
400
Bad request

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
401
Unauthorized

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
403
Forbidden

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
404
Not found

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
405
Method Not Allowed

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
406
Not Acceptable

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
integer
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
NameDescription
ConsentId *
string
(path)
ConsentId
x-fapi-auth-date
string
(header)

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

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)
An RFC4122 UID used as a correlation id.
Authorization *
string
(header)

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

Responses

CodeDescription
200
OK

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2024-06-14T14:40:03.443Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2024-06-14T14:40:03.443Z",
    "Permission": "Create",
    "Initiation": {
      "Frequency": "string",
      "Reference": "string",
      "NumberOfPayments": "string",
      "FirstPaymentDateTime": "2024-06-14T14:40:03.443Z",
      "RecurringPaymentDateTime": "2024-06-14T14:40:03.443Z",
      "FinalPaymentDateTime": "2024-06-14T14:40:03.443Z",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "string",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-14T14:40:03.443Z",
    "LastAvailableDateTime": "2024-06-14T14:40:03.443Z"
  }
}
#/definitions/OBWriteDomesticStandingOrderConsentResponse4OBWriteDomesticStandingOrderConsentResponse4{
Data*{
ConsentId*string
minLength: 1
maxLength: 128

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

CreationDateTime*string($date-time)

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

Status*string
Specifies the status of consent resource in code form.

Enum:
[ Authorised, AwaitingAuthorisation, Consumed, Rejected ]
StatusUpdateDateTime*string($date-time)

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

Permission*string
Specifies the Open Banking service request types.

Enum:
[ Create ]
Initiation*{
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.
Frequency*string
pattern: ^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Individual Definitions:
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-2 to -1, 1 to 31)
Individual Patterns:
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
IntrvlWkDay:0[1-9]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01])
Full Regular Expression:
^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Referencestring
minLength: 1
maxLength: 35

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.

NumberOfPaymentsstring
minLength: 1
maxLength: 35
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
FirstPaymentDateTime*string($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

RecurringPaymentDateTimestring($date-time)

The date on which the first recurring payment for a Standing Order schedule will be made.
Usage: 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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FinalPaymentDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FirstPaymentAmount*{
description:
The amount of the first Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
RecurringPaymentAmount{
description:
The amount of the recurring Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
FinalPaymentAmount{
description:
The amount of the final Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
DebtorAccount{
description:
Provides the details to identify the debtor account.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Namestring
minLength: 1
maxLength: 70

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.

}
CreditorAccount*{
description:
Identification assigned by an institution to identify an account. This identification is known by the account owner.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}
}
}
Risk*#/definitions/OBRisk1OBRisk1{
description:
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
PaymentContextCodestring
Specifies the payment context

Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCodestring
minLength: 3
maxLength: 4

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

MerchantCustomerIdentificationstring
minLength: 1
maxLength: 70
The unique customer identifier of the PSU with the merchant.
DeliveryAddress{
description:

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

AddressLine[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 70

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

]
PostCodePostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName*TownNamestring

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 35

Identifies a subdivision of a country, for instance state, region, county.

]
Country*string
pattern: ^[A-Z]{2,2}$

Nation with its own government, occupying a particular territory.

}
}
Links#/definitions/LinksLinks{
description:
Links relevant to the payload
Self*string
Firststring
Prevstring
Nextstring
Laststring
}
Meta#/definitions/MetaMeta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
400
Bad request

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
401
Unauthorized

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
403
Forbidden

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
404
Not found

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
405
Method Not Allowed

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
406
Not Acceptable

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
integer
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
NameDescription
x-fapi-auth-date
string
(header)

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

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)
An RFC4122 UID used as a correlation id.
Authorization *
string
(header)

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

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The
Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)
JSOE signature of the body of the payload.
body *
(body)

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "Frequency": "string",
      "Reference": "string",
      "NumberOfPayments": "string",
      "FirstPaymentDateTime": "2024-06-14T13:12:17.009Z",
      "FinalPaymentDateTime": "2024-06-14T13:12:17.009Z",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "string",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}
#/definitions/OBWriteDomesticStandingOrder3OBWriteDomesticStandingOrder3{
Data*{
ConsentId*string
minLength: 1
maxLength: 128

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

Initiation*{
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.
Frequency*string
pattern: ^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Individual Definitions:
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)
Individual Patterns:
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
IntrvlWkDay:0[1-9]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01])
Full Regular Expression:
^(IntrvlWkDay:0[1-9]:0[1-7])$|(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Referencestring
minLength: 1
maxLength: 35

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.

NumberOfPaymentsstring
minLength: 1
maxLength: 35
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
FirstPaymentDateTime*string($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FinalPaymentDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FirstPaymentAmount*{
description:
The amount of the first Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
RecurringPaymentAmount{
description:
The amount of the recurring Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
FinalPaymentAmount{
description:
The amount of the final Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
DebtorAccount{
description:
Provides the details to identify the debtor account.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Namestring
minLength: 1
maxLength: 70

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.

}
CreditorAccount*{
description:
Identification assigned by an institution to identify an account. This identification is known by the account owner.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}
}
}
Risk*#/definitions/OBRisk1OBRisk1{
description:
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
PaymentContextCodestring
Specifies the payment context

Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCodestring
minLength: 3
maxLength: 4

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

MerchantCustomerIdentificationstring
minLength: 1
maxLength: 70
The unique customer identifier of the PSU with the merchant.
DeliveryAddress{
description:

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

AddressLine[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 70

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

]
PostCodePostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName*TownNamestring

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 35

Identifies a subdivision of a country, for instance state, region, county.

]
Country*string
pattern: ^[A-Z]{2,2}$

Nation with its own government, occupying a particular territory.

}
}
}

Responses

CodeDescription
201
Created

{
  "Data": {
    "DomesticStandingOrderId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2024-06-14T14:53:47.877Z",
    "Status": "Cancelled",
    "StatusUpdateDateTime": "2024-06-14T14:53:47.877Z",
    "Initiation": {
      "Frequency": "string",
      "Reference": "string",
      "FirstPaymentDateTime": "2024-06-14T14:53:47.877Z",
      "RecurringPaymentDateTime": "2024-06-14T14:53:47.877Z",
      "FinalPaymentDateTime": "2024-06-14T14:53:47.877Z",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      }
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-14T14:53:47.877Z",
    "LastAvailableDateTime": "2024-06-14T14:53:47.877Z"
  }
}
#/definitions/OBWriteDomesticStandingOrderResponse4OBWriteDomesticStandingOrderResponse4{
Data*{
DomesticStandingOrderId*string
minLength: 1
maxLength: 40

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

ConsentId*string
minLength: 1
maxLength: 128

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

CreationDateTime*string($date-time)

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

Status*string
Specifies the status of the payment order resource.

Enum:
[ Cancelled, InitiationCompleted, InitiationFailed, InitiationPending ]
StatusUpdateDateTime*string($date-time)

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

Initiation*{
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.
Frequency*string
pattern: ^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$||^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Individual Definitions:
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-2 to -1, 1 to 31)
Individual Patterns:
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
IntrvlWkDay:0[1-9]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01])
Full Regular Expression:
^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Referencestring
minLength: 1
maxLength: 35

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.

FirstPaymentDateTime*string($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

RecurringPaymentDateTimestring($date-time)

The date on which the first recurring payment for a Standing Order schedule will be made.
Usage: 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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FinalPaymentDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FirstPaymentAmount*{
description:
The amount of the first Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
RecurringPaymentAmount{
description:
The amount of the recurring Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
FinalPaymentAmount{
description:
The amount of the final Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
DebtorAccount{
description:
Provides the details to identify the debtor account.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Namestring
minLength: 1
maxLength: 70

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.

}
CreditorAccount*{
description:
Identification assigned by an institution to identify an account. This identification is known by the account owner.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}
}
}
Links#/definitions/LinksLinks{
description:
Links relevant to the payload
Self*string
Firststring
Prevstring
Nextstring
Laststring
}
Meta#/definitions/MetaMeta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
400
Bad request

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
401
Unauthorized

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
403
Forbidden

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
404
Not found

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
405
Method Not Allowed

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
406
Not Acceptable

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
integer
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
NameDescription
DomesticStandingOrderId *
string
(path)
DomesticStandingOrderId
x-fapi-auth-date
string
(header)

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

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)
An RFC4122 UID used as a correlation id.
Authorization *
string
(header)

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

Responses

CodeDescription
200
OK

{
  "Data": {
    "DomesticStandingOrderId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2024-06-14T15:53:29.644Z",
    "Status": "Cancelled",
    "StatusUpdateDateTime": "2024-06-14T15:53:29.644Z",
    "Initiation": {
      "Frequency": "string",
      "Reference": "string",
      "FirstPaymentDateTime": "2024-06-14T15:53:29.644Z",
      "RecurringPaymentDateTime": "2024-06-14T15:53:29.644Z",
      "FinalPaymentDateTime": "2024-06-14T15:53:29.644Z",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      }
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-14T15:53:29.644Z",
    "LastAvailableDateTime": "2024-06-14T15:53:29.644Z"
  }
}
#/definitions/OBWriteDomesticStandingOrderResponse4OBWriteDomesticStandingOrderResponse4{
Data*{
DomesticStandingOrderId*string
minLength: 1
maxLength: 40

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

ConsentId*string
minLength: 1
maxLength: 128

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

CreationDateTime*string($date-time)

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

Status*string
Specifies the status of the payment order resource.

Enum:
[ Cancelled, InitiationCompleted, InitiationFailed, InitiationPending ]
StatusUpdateDateTime*string($date-time)

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

Initiation*{
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.
Frequency*string
pattern: ^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$||^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Individual Definitions:
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-2 to -1, 1 to 31)
Individual Patterns:
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
IntrvlWkDay:0[1-9]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01])
Full Regular Expression:
^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Referencestring
minLength: 1
maxLength: 35

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.

FirstPaymentDateTime*string($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

RecurringPaymentDateTimestring($date-time)

The date on which the first recurring payment for a Standing Order schedule will be made.
Usage: 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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FinalPaymentDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FirstPaymentAmount*{
description:
The amount of the first Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
RecurringPaymentAmount{
description:
The amount of the recurring Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
FinalPaymentAmount{
description:
The amount of the final Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
DebtorAccount{
description:
Provides the details to identify the debtor account.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Namestring
minLength: 1
maxLength: 70

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.

}
CreditorAccount*{
description:
Identification assigned by an institution to identify an account. This identification is known by the account owner.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}
}
}
Links#/definitions/LinksLinks{
description:
Links relevant to the payload
Self*string
Firststring
Prevstring
Nextstring
Laststring
}
Meta#/definitions/MetaMeta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
400
Bad request

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
401
Unauthorized

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
403
Forbidden

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string
404
Not found

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
405
Method Not Allowed

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
406
Not Acceptable

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
integer
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
x-jws-signature
JSOE signature of the body of the payload.
string

Models

AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.

ActiveOrHistoricCurrencyCode_0string

Identification of the currency in which the account is held.
Usage: Currency should only be used in case one and the same account number covers several currencies
and the initiating party needs to identify which currency needs to be used for settlement on the account.

ActiveOrHistoricCurrencyCode_1string

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".

FinalPaymentDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FirstPaymentDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

Frequency_0string

Individual Definitions:
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-2 to -1, 1 to 31)
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
IntrvlWkDay:0[1-9]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01])
Full Regular Expression:^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Frequency_1string

Individual Definitions:
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-2 to -1, 1 to 31)
Individual Patterns:
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
IntrvlWkDay:0[1-9]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01])Full Regular Expression:
^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

FullLegalNamestring
Specifies a character string with a maximum length of 350 characters.

ISODateTimestring($date-time)

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

Meta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}

Name_3string
Long name associated with the code

NextPaymentDateTimestring($date-time)

The date on which the next payment for a Standing Order schedule will be made.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

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

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

OBActiveOrHistoricCurrencyAndAmount_1{
description:
The amount of the next Standing Order.
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCode_1string

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".

}

OBActiveOrHistoricCurrencyAndAmount_2{
description:
The amount of the final Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCode_1string

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".

}

OBActiveOrHistoricCurrencyAndAmount_3{
description:
Amount of money associated with the statement benefit type.
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCode_1string

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".

}

OBActiveOrHistoricCurrencyAndAmount_4{
description:
Amount of money associated with the statement fee type.
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCode_1string

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".

}

OBActiveOrHistoricCurrencyAndAmount_5{
description:
Amount of money associated with the statement interest amount type.
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCode_1string

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".

}

OBActiveOrHistoricCurrencyAndAmount_6{
description:
Amount of money associated with the amount type.
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCode_1string

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".

}

OBActiveOrHistoricCurrencyAndAmount_7{
description:
Amount of money in the cash transaction entry.
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCode_1string

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".

}

OBActiveOrHistoricCurrencyAndAmount_8{
description:
Transaction charges to be paid by the charge bearer.
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCode_1string

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".

}

OBActiveOrHistoricCurrencyAndAmount_9{
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.
Usage: This amount has to be transported unchanged through the transaction chain.

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

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".

}

OBAddressTypeCodestring
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]

OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}

OBErrorResponse1{
description:

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

Code*string
minLength: 1
maxLength: 40

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

Idstring
minLength: 1
maxLength: 40

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

Message*string
minLength: 1
maxLength: 500

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

Errors*[
minItems: 1
#/definitions/OBError1OBError1{
ErrorCode*string

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

Message*string
minLength: 1
maxLength: 500

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

Pathstring
minLength: 1
maxLength: 500

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

Urlstring

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

}]
}

OBExternalAccountIdentification4Codestring

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

OBExternalStandingOrderStatus1Codestring
Specifies the status of the standing order in code form.
Enum:
[ Active, Inactive ]

OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressTypeOBAddressTypeCodestring
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Departmentstring
minLength: 1
maxLength: 70
Identification of a division of a large organisation or building.
SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

PostCodePostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownNameTownNamestring

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Countrystring
pattern: ^[A-Z]{2,2}$
Nation with its own government.
AddressLine[
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

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

]
}

OBRisk2{
description:
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.
}

OBSupplementaryData1{
description:

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

}

OB_CodeMnemonicstring
The four letter Mnemonic used within an XML file to identify a code

OB_FeeCategory1Codestring
Categorisation of fees and charges into standard categories.
Enum:
[ FCOT, FCRE, FCSV ]

PostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Referencestring

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.

SecondaryIdentificationstring

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).

StandingOrderIdstring
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.

StartDateTimestring($date-time)

Date and time at which the statement period starts.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

StatusUpdateDateTimestring($date-time)

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

TownNamestring

Name of a built-up area, with defined boundaries, and a local government.

ValueDateTimestring($date-time)

Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry.
Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date.
For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.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

ActiveOrHistoricCurrencyCodestring

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".

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

OBActiveOrHistoricCurrencyAndAmount{
description:
Amount of money associated with the charge type.
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

OBExternalLocalInstrument1Codestring

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.

OBExternalPaymentChargeType1Codestring

Charge type, in a coded form.

OBRisk1{
description:
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
PaymentContextCodestring
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCodestring
minLength: 3
maxLength: 4

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

MerchantCustomerIdentificationstring
minLength: 1
maxLength: 70
The unique customer identifier of the PSU with the merchant.
DeliveryAddress{
description:

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

AddressLine[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 70

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

]
PostCodePostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName*TownNamestring

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 35

Identifies a subdivision of a country, for instance state, region, county.

]
Country*string
pattern: ^[A-Z]{2,2}$

Nation with its own government, occupying a particular territory.

}
}

OBWriteDomesticConsentResponse3{
Data*{
ConsentId*string
minLength: 1
maxLength: 128

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

CreationDateTime*string($date-time)

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

Status*string
Specifies the status of consent resource in code form.
Enum:
[ Authorised, AwaitingAuthorisation, Consumed, Rejected ]
StatusUpdateDateTime*string($date-time)

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

CutOffDateTimestring($date-time)

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

ExpectedExecutionDateTimestring($date-time)

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

ExpectedSettlementDateTimestring($date-time)

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

Charges[{
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer*OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type*OBExternalPaymentChargeType1Codestring

Charge type, in a coded form.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
description:
Amount of money associated with the charge type.
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
}]
Initiation*{
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.
InstructionIdentification*string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Usage: 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.

EndToEndIdentification*string
minLength: 1
maxLength: 35

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.
Usage: 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.
OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrumentOBExternalLocalInstrument1Codestring

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.

InstructedAmount*{
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.
Usage: This amount has to be transported unchanged through the transaction chain.

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

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".

}
DebtorAccount{
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Namestring
minLength: 1
maxLength: 70

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.

SecondaryIdentificationSecondaryIdentificationstring

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).

}
CreditorAccount*{
description:
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentificationSecondaryIdentificationstring

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).

}
CreditorPostalAddress#/definitions/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressTypeOBAddressTypeCodestring
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Departmentstring
minLength: 1
maxLength: 70
Identification of a division of a large organisation or building.
SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

PostCodePostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownNameTownNamestring

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Countrystring
pattern: ^[A-Z]{2,2}$
Nation with its own government.
AddressLine[
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

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

]
}
RemittanceInformation{
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.

Unstructuredstring
minLength: 1
maxLength: 140

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.

Referencestring
minLength: 1
maxLength: 35

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.
OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.

}
SupplementaryData#/definitions/OBSupplementaryData1OBSupplementaryData1{
description:

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

}
}
Authorisation{
description:
The authorisation type request from the TPP.
AuthorisationType*string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

}
SCASupportData{
description:

Supporting Data provided by TPP, when requesting SCA Exemption.

RequestedSCAExemptionTypestring
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
Enum:
[ BillPayment, ContactlessTravel, EcommerceGoods, EcommerceServices, Kiosk, Parking, PartyToParty ]
AppliedAuthenticationApproachstring

Specifies a character string with a maximum length of 40 characters.
Usage: This field indicates whether the PSU was subject to SCA performed by the TPP

Enum:
[ CA, SCA ]
ReferencePaymentOrderIdstring
minLength: 1
maxLength: 128

Specifies a character string with a maximum length of 140 characters.
Usage: 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.

}
}
Risk*#/definitions/OBRisk1OBRisk1{
description:
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
PaymentContextCodestring
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCodestring
minLength: 3
maxLength: 4

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

MerchantCustomerIdentificationstring
minLength: 1
maxLength: 70
The unique customer identifier of the PSU with the merchant.
DeliveryAddress{
description:

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

AddressLine[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 70

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

]
PostCodePostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName*TownNamestring

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 35

Identifies a subdivision of a country, for instance state, region, county.

]
Country*string
pattern: ^[A-Z]{2,2}$

Nation with its own government, occupying a particular territory.

}
}
Links#/definitions/LinksLinks{
description:
Links relevant to the payload
Self*string
Firststring
Prevstring
Nextstring
Laststring
}
Meta#/definitions/MetaMeta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}
}

OBWriteDomesticResponse3{
Data*{
DomesticPaymentId*string
minLength: 1
maxLength: 40

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

ConsentId*string
minLength: 1
maxLength: 128

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

CreationDateTime*string($date-time)

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

Status*string
Specifies the status of the payment information group.
Enum:
[ AcceptedCreditSettlementCompleted, AcceptedSettlementCompleted, AcceptedSettlementInProcess, AcceptedWithoutPosting, Pending, Rejected ]
StatusUpdateDateTime*string($date-time)

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

ExpectedExecutionDateTimestring($date-time)

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

ExpectedSettlementDateTimestring($date-time)

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

Charges[{
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer*OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type*OBExternalPaymentChargeType1Codestring

Charge type, in a coded form.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
description:
Amount of money associated with the charge type.
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
}]
Initiation*{
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.
InstructionIdentification*string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Usage: 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.

EndToEndIdentification*string
minLength: 1
maxLength: 35

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.
Usage: 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.
OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrumentOBExternalLocalInstrument1Codestring

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.

InstructedAmount*{
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.
Usage: This amount has to be transported unchanged through the transaction chain.

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

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".

}
DebtorAccount{
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Namestring
minLength: 1
maxLength: 70

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.

SecondaryIdentificationSecondaryIdentificationstring

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).

}
CreditorAccount*{
description:
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentificationSecondaryIdentificationstring

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).

}
CreditorPostalAddress#/definitions/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressTypeOBAddressTypeCodestring
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Departmentstring
minLength: 1
maxLength: 70
Identification of a division of a large organisation or building.
SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

PostCodePostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownNameTownNamestring

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Countrystring
pattern: ^[A-Z]{2,2}$
Nation with its own government.
AddressLine[
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

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

]
}
RemittanceInformation{
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.

Unstructuredstring
minLength: 1
maxLength: 140

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.

Referencestring
minLength: 1
maxLength: 35

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.
OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.

}
SupplementaryData#/definitions/OBSupplementaryData1OBSupplementaryData1{
description:

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

}
}
MultiAuthorisation{
description:
The multiple authorisation flow response from the ASPSP.
Status*string
Specifies the status of the authorisation flow in code form.
Enum:
[ Authorised, AwaitingFurtherAuthorisation, Rejected ]
NumberRequiredinteger

Number of authorisations required for payment order (total required at the start of the multi authorisation journey).

NumberReceivedinteger
Number of authorisations received.
LastUpdateDateTimestring($date-time)

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

ExpirationDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

}
}
Links#/definitions/LinksLinks{
description:
Links relevant to the payload
Self*string
Firststring
Prevstring
Nextstring
Laststring
}
Meta#/definitions/MetaMeta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}
}

OBWriteDomesticStandingOrder3{
Data*{
ConsentId*string
minLength: 1
maxLength: 128

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

Initiation*{
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.
Frequency*string
pattern: ^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Individual Definitions:
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)
Individual Patterns:
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
IntrvlWkDay:0[1-9]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01])
Full Regular Expression:
^(IntrvlWkDay:0[1-9]:0[1-7])$|(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Referencestring
minLength: 1
maxLength: 35

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.

NumberOfPaymentsstring
minLength: 1
maxLength: 35
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
FirstPaymentDateTime*string($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FinalPaymentDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FirstPaymentAmount*{
description:
The amount of the first Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
RecurringPaymentAmount{
description:
The amount of the recurring Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
FinalPaymentAmount{
description:
The amount of the final Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
DebtorAccount{
description:
Provides the details to identify the debtor account.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Namestring
minLength: 1
maxLength: 70

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.

}
CreditorAccount*{
description:
Identification assigned by an institution to identify an account. This identification is known by the account owner.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}
}
}
Risk*#/definitions/OBRisk1OBRisk1{
description:
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
PaymentContextCodestring
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCodestring
minLength: 3
maxLength: 4

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

MerchantCustomerIdentificationstring
minLength: 1
maxLength: 70
The unique customer identifier of the PSU with the merchant.
DeliveryAddress{
description:

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

AddressLine[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 70

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

]
PostCodePostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName*TownNamestring

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 35

Identifies a subdivision of a country, for instance state, region, county.

]
Country*string
pattern: ^[A-Z]{2,2}$

Nation with its own government, occupying a particular territory.

}
}
}

OBWriteDomesticStandingOrderConsent4{
Data*{
Permission*string
Specifies the Open Banking service request types.
Enum:
[ Create ]
Initiation*{
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.
Frequency*string
pattern: ^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Individual Definitions:
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-2 to -1, 1 to 31)
Individual Patterns:
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
IntrvlWkDay:0[1-9]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01])
Full Regular Expression:
^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Referencestring
minLength: 1
maxLength: 35

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.

NumberOfPaymentsstring
minLength: 1
maxLength: 35
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
FirstPaymentDateTime*string($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FinalPaymentDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FirstPaymentAmount*{
description:
The amount of the first Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
RecurringPaymentAmount{
description:
The amount of the recurring Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
FinalPaymentAmount{
description:
The amount of the final Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
DebtorAccount{
description:
Provides the details to identify the debtor account.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Namestring
minLength: 1
maxLength: 70

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.

}
CreditorAccount*{
description:
Identification assigned by an institution to identify an account. This identification is known by the account owner.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}
}
}
Risk*#/definitions/OBRisk1OBRisk1{
description:
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
PaymentContextCodestring
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCodestring
minLength: 3
maxLength: 4

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

MerchantCustomerIdentificationstring
minLength: 1
maxLength: 70
The unique customer identifier of the PSU with the merchant.
DeliveryAddress{
description:

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

AddressLine[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 70

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

]
PostCodePostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName*TownNamestring

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 35

Identifies a subdivision of a country, for instance state, region, county.

]
Country*string
pattern: ^[A-Z]{2,2}$

Nation with its own government, occupying a particular territory.

}
}
}

OBWriteDomesticStandingOrderConsentResponse4{
Data*{
ConsentId*string
minLength: 1
maxLength: 128

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

CreationDateTime*string($date-time)

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

Status*string
Specifies the status of consent resource in code form.
Enum:
[ Authorised, AwaitingAuthorisation, Consumed, Rejected ]
StatusUpdateDateTime*string($date-time)

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

Permission*string
Specifies the Open Banking service request types.
Enum:
[ Create ]
Initiation*{
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.
Frequency*string
pattern: ^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Individual Definitions:
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-2 to -1, 1 to 31)
Individual Patterns:
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
IntrvlWkDay:0[1-9]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01])
Full Regular Expression:
^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Referencestring
minLength: 1
maxLength: 35

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.

NumberOfPaymentsstring
minLength: 1
maxLength: 35
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
FirstPaymentDateTime*string($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

RecurringPaymentDateTimestring($date-time)

The date on which the first recurring payment for a Standing Order schedule will be made.
Usage: 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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FinalPaymentDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FirstPaymentAmount*{
description:
The amount of the first Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
RecurringPaymentAmount{
description:
The amount of the recurring Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
FinalPaymentAmount{
description:
The amount of the final Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
DebtorAccount{
description:
Provides the details to identify the debtor account.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Namestring
minLength: 1
maxLength: 70

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.

}
CreditorAccount*{
description:
Identification assigned by an institution to identify an account. This identification is known by the account owner.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}
}
}
Risk*#/definitions/OBRisk1OBRisk1{
description:
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
PaymentContextCodestring
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCodestring
minLength: 3
maxLength: 4

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

MerchantCustomerIdentificationstring
minLength: 1
maxLength: 70
The unique customer identifier of the PSU with the merchant.
DeliveryAddress{
description:

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

AddressLine[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 70

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

]
PostCodePostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName*TownNamestring

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision[
minItems: 0
maxItems: 2
string
minLength: 1
maxLength: 35

Identifies a subdivision of a country, for instance state, region, county.

]
Country*string
pattern: ^[A-Z]{2,2}$

Nation with its own government, occupying a particular territory.

}
}
Links#/definitions/LinksLinks{
description:
Links relevant to the payload
Self*string
Firststring
Prevstring
Nextstring
Laststring
}
Meta#/definitions/MetaMeta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}
}

OBWriteDomesticStandingOrderResponse4{
Data*{
DomesticStandingOrderId*string
minLength: 1
maxLength: 40

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

ConsentId*string
minLength: 1
maxLength: 128

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

CreationDateTime*string($date-time)

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

Status*string
Specifies the status of the payment order resource.
Enum:
[ Cancelled, InitiationCompleted, InitiationFailed, InitiationPending ]
StatusUpdateDateTime*string($date-time)

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

Initiation*{
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.
Frequency*string
pattern: ^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$||^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Individual Definitions:
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-2 to -1, 1 to 31)
Individual Patterns:
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
IntrvlWkDay:0[1-9]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01])
Full Regular Expression:
^(IntrvlWkDay:0[1-9]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-2]|0[1-9]|[12][0-9]|3[01]))$

Referencestring
minLength: 1
maxLength: 35

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.

FirstPaymentDateTime*string($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

RecurringPaymentDateTimestring($date-time)

The date on which the first recurring payment for a Standing Order schedule will be made.
Usage: 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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FinalPaymentDateTimestring($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FirstPaymentAmount*{
description:
The amount of the first Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
RecurringPaymentAmount{
description:
The amount of the recurring Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
FinalPaymentAmount{
description:
The amount of the final Standing Order
Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCodestring

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".

}
DebtorAccount{
description:
Provides the details to identify the debtor account.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Namestring
minLength: 1
maxLength: 70

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.

}
CreditorAccount*{
description:
Identification assigned by an institution to identify an account. This identification is known by the account owner.
SchemeName*OBExternalAccountIdentification4Codestring

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

Identification*Identificationstring
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}
}
}
Links#/definitions/LinksLinks{
description:
Links relevant to the payload
Self*string
Firststring
Prevstring
Nextstring
Laststring
}
Meta#/definitions/MetaMeta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}
}

OBWritePaymentDetailsResponse1{
Data*{
PaymentStatus[{
description:
Payment status details.
PaymentTransactionId*string
minLength: 1
maxLength: 210
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
Status*string

Status of a transfe, as assigned by the transaction administrator.

Enum:
[ Accepted, AcceptedCancellationRequest, AcceptedCreditSettlementCompleted, AcceptedCustomerProfile, AcceptedFundsChecked, AcceptedSettlementCompleted, AcceptedSettlementInProcess, AcceptedTechnicalValidation, AcceptedWithChange, AcceptedWithoutPosting, Cancelled, NoCancellationProcess, PartiallyAcceptedCancellationRequest, PartiallyAcceptedTechnicalCorrect, PaymentCancelled, Pending, PendingCancellationRequest, Received, Rejected, RejectedCancellationRequest ]
StatusUpdateDateTime*string($date-time)

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.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

StatusDetail{
description:
Payment status details as per underlying Payment Rail.
LocalInstrumentOBExternalLocalInstrument1Codestring

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.

Status*string
minLength: 1
maxLength: 128

Status of a transfer, as assigned by the transaction administrator.

StatusReasonstring
Reason Code provided for the status of a transfer.
Enum:
[ Cancelled, PendingFailingSettlement, PendingSettlement, Proprietary, ProprietaryRejection, Suspended, Unmatched ]
StatusReasonDescriptionstring
minLength: 1
maxLength: 256
Reason provided for the status of a transfer.
}
}]
}
Links#/definitions/LinksLinks{
description:
Links relevant to the payload
Self*string
Firststring
Prevstring
Nextstring
Laststring
}
Meta#/definitions/MetaMeta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}
}

Having trouble?

Contact our dedicated team members via our ticketing system or via our support mailbox

OpenBankingResponse@virginmoney.com

Contact us