Skip to main content

Page contents

What this API does:

These APIs provide the ability for payment initiation service providers (PISPs) to initiate a single immediate domestic payments made in GBP.

The API endpoints described here allow a PISP to:

Please note the example responses accurately reflect the response data being returned by Virgin Money. The underlying data dictionary is the Open Banking definitions that includes some optional fields VM will not be returning.

Restrictions

Inline with existing web channels:

Access

Endpoint configuration

Production:  https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/pisp/domestic-payments

Production:  https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/pisp/domestic-payments

Production:  https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/pisp/domestic-payments

Production:  https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/pisp/domestic-payments

Production:  https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/pisp/domestic-payments

Production:  https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/pisp/domestic-scheduled-payments

Production:  https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/pisp/domestic-scheduled-payments

Production:  https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/pisp/domestic-scheduled-payments

Production:  https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/pisp/domestic-scheduled-payments

Domestic Payments

NameDescription
OBWriteDomesticConsent2Param  *
( body )
Default

{
  "Data": {
    "Initiation": {
      "InstructionIdentification": "6611438219034624",
      "EndToEndIdentification": "3482044854173696",
      "LocalInstrument": "UK.OBIE.FPS",
      "InstructedAmount": {
        "Amount": "220.50",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08606467451219",
        "Name": "Mr Robin Hood"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "60132378234512",
        "Name": "Mr Robin Hood"
      }
    }
  },
  "Risk": []
}
#/definitions/OBWriteDomesticConsent2 OBWriteDomesticConsent2 {
Data * #/definitions/OBWriteDataDomesticConsent2 OBWriteDataDomesticConsent2 {
Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
}
x-fapi-financial-id  *
string
( header )
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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 )
A detached JWS signature of the body of the payload.
x-customer-user-agent
string
( header )

Indicates the user-agent that the PSU is using.

Responses

CodeDescription
201
Domestic Payment Consents Created

{
  "Data": {
    "ConsentId": "f5e03fa8-aab5-4749-9c84-7d84c35fc39e",
    "Status": "AwaitingAuthorisation",
    "CreationDateTime": "2019-06-05T15:15:13+00:00",
    "StatusUpdateDateTime": "2019-06-05T15:15:13+00:00",
    "Initiation": {
      "InstructionIdentification": "6611438219034624",
      "EndToEndIdentification": "3482044854173696",
      "LocalInstrument": "UK.OBIE.FPS",
      "InstructedAmount": {
        "Amount": "220.50",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08606467451219",
        "Name": "Mr Robin Hood"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "60132378234512",
        "Name": "Mr Robin Hood"
      }
    }
  },
  "Risk": [],
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/pisp/domestic-payment-consents/f5e03fa8-aab5-4749-9c84-7d84c35fc39e"
  },
  "Meta": []
}
#/definitions/OBWriteDomesticConsentResponse2 OBWriteDomesticConsentResponse2 {
Data * #/definitions/OBWriteDataDomesticConsentResponse2 OBWriteDataDomesticConsentResponse2 {
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 * OBExternalConsentStatus1Code 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

CutOffDateTime string ($ 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
Links * #/definitions/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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
Header containing a detached JWS 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/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
401
Unauthorized
403
Forbidden
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
 integer
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
NameDescription
ConsentId  *
string
( path )
ConsentId
x-fapi-financial-id  *
string
( header )
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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-customer-user-agent
string
( header )

Indicates the user-agent that the PSU is using.

Responses

CodeDescription
200
Domestic Payment Consents Read

{
  "Data": {
    "ConsentId": "f5e03fa8-aab5-4749-9c84-7d84c35fc39e",
    "Status": "AwaitingAuthorisation",
    "CreationDateTime": "2019-06-05T15:15:13+00:00",
    "StatusUpdateDateTime": "2019-06-05T15:15:13+00:00",
    "Initiation": {
      "InstructionIdentification": "6611438219034624",
      "EndToEndIdentification": "3482044854173696",
      "LocalInstrument": "UK.OBIE.FPS",
      "InstructedAmount": {
        "Amount": "220.50",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08606467451219",
        "Name": "Mr Robin Hood"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "60132378234512",
        "Name": "Mr Robin Hood"
      }
    }
  },
  "Risk": [],
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/pisp/domestic-payment-consents/f5e03fa8-aab5-4749-9c84-7d84c35fc39e"
  },
  "Meta": []
}
#/definitions/OBWriteDomesticConsentResponse2 OBWriteDomesticConsentResponse2 {
Data * #/definitions/OBWriteDataDomesticConsentResponse2 OBWriteDataDomesticConsentResponse2 {
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 * OBExternalConsentStatus1Code 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

CutOffDateTime string ($ 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
Links * #/definitions/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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
Header containing a detached JWS 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/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
401
Unauthorized
403
Forbidden
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
 integer
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}

Parameters

NameDescription
ConsentId  *
string
( path )
ConsentId
x-fapi-financial-id  *
string
( header )
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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-customer-user-agent
string
( header )

Indicates the user-agent that the PSU is using.

Responses

CodeDescription
200
Domestic Payment Consents Funds Confirmation Read

{
  "Data": {
    "FundsAvailableResult": {
      "FundsAvailableDateTime": "2019-02-05T15:15:23+00:00",
      "FundsAvailable": true
    }
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/pisp/domestic-payment-consents/f5e03fa8-aab5-4749-9c84-7d84c35fc39e/funds-confirmation"
  },
  "Meta": []
}
#/definitions/OBWriteFundsConfirmationResponse1 OBWriteFundsConfirmationResponse1 {
Data * #/definitions/OBWriteDataFundsConfirmationResponse1 OBWriteDataFundsConfirmationResponse1 {
FundsAvailableResult #/definitions/OBFundsAvailableResult1 OBFundsAvailableResult1 {
description:
Result of a funds availability check.
FundsAvailableDateTime * string ($ date-time )

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

FundsAvailable * boolean
Flag to indicate the availability of funds given the Amount in the consent request.
}
SupplementaryData #/definitions/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Links * #/definitions/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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
Header containing a detached JWS 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/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
401
Unauthorized
403
Forbidden
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
 integer
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
NameDescription
OBWriteDomestic2Param  *
( body )
Default

{
  "Data": {
    "ConsentId": "f5e03fa8-aab5-4749-9c84-7d84c35fc39e",
    "Initiation": {
      "InstructionIdentification": "6611438219034624",
      "EndToEndIdentification": "3482044854173696",
      "LocalInstrument": "UK.OBIE.FPS",
      "InstructedAmount": {
        "Amount": "220.50",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08606467451219",
        "Name": "Mr Robin Hood"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "60132378234512",
        "Name": "Mr Robin Hood"
      },
      "Risk": []
    }
  }
}
#/definitions/OBWriteDomestic2 OBWriteDomestic2 {
Data * #/definitions/OBWriteDataDomestic2 OBWriteDataDomestic2 {
ConsentId * string
minLength : 1
maxLength : 128

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

Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
}
x-fapi-financial-id  *
string
( header )
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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 )
A detached JWS signature of the body of the payload.
x-customer-user-agent
string
( header )

Indicates the user-agent that the PSU is using.

Responses

CodeDescription
201
Domestic Payments Created

{
  "Data": {
    "DomesticPaymentId": "125dfbbe-5c09-4023-8e6a-c343fa2f800c",
    "ConsentId": "f5e03fa8-aab5-4749-9c84-7d84c35fc39e",
    "Status": "AcceptedSettlementInProcess",
    "CreationDateTime": "2019-06-05T15:15:22+00:00",
    "StatusUpdateDateTime": "2019-06-05T15:15:13+00:00",
    "Initiation": {
      "InstructionIdentification": "6611438219034624",
      "EndToEndIdentification": "3482044854173696",
      "LocalInstrument": "UK.OBIE.FPS",
      "InstructedAmount": {
        "Amount": "220.50",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08606467451219",
        "Name": "Mr Robin Hood"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "60132378234512",
        "Name": "Mr Robin Hood"
      }
    }
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/pisp/domestic-payment/125dfbbe-5c09-4023-8e6a-c343fa2f800c"
  },
  "Meta": []
}
#/definitions/OBWriteDomesticResponse2 OBWriteDomesticResponse2 {
Data * #/definitions/OBWriteDataDomesticResponse2 OBWriteDataDomesticResponse2 {
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 * OBTransactionIndividualStatus1Code string
Specifies the status of the payment information group.
Enum:
[ AcceptedSettlementCompleted, AcceptedSettlementInProcess, 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
MultiAuthorisation #/definitions/OBMultiAuthorisation1 OBMultiAuthorisation1 {
description:
The multiple authorisation flow response from the ASPSP.
Status * OBExternalStatus2Code string
Specifies the status of the authorisation flow in code form.
Enum:
[ Authorised, AwaitingFurtherAuthorisation, Rejected ]
NumberRequired integer ($ int32 )

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

NumberReceived integer ($ int32 )

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

LastUpdateDateTime string ($ 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

ExpirationDateTime string ($ 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/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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
Header containing a detached JWS 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"
    }
  ]
}
span class="model"> #/definitions/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
401
Unauthorized
403
Forbidden
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
 integer
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
NameDescription
DomesticPaymentId  *
string
( path )
DomesticPaymentId
x-fapi-financial-id  *
string
( header )
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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-customer-user-agent
string
( header )

Indicates the user-agent that the PSU is using.

Responses

CodeDescription
200
Domestic Payments Read

{
  "Data": {
    "DomesticPaymentId": "125dfbbe-5c09-4023-8e6a-c343fa2f800c",
    "ConsentId": "f5e03fa8-aab5-4749-9c84-7d84c35fc39e",
    "Status": "AcceptedSettlementInProcess",
    "CreationDateTime": "2019-06-05T15:15:22+00:00",
    "StatusUpdateDateTime": "2019-06-05T15:15:13+00:00",
    "Initiation": {
      "InstructionIdentification": "6611438219034624",
      "EndToEndIdentification": "3482044854173696",
      "LocalInstrument": "UK.OBIE.FPS",
      "InstructedAmount": {
        "Amount": "220.50",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08606467451219",
        "Name": "Mr Robin Hood"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "60132378234512",
        "Name": "Mr Robin Hood"
      }
    }
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/pisp/domestic-payment/125dfbbe-5c09-4023-8e6a-c343fa2f800c"
  },
  "Meta": []
}
#/definitions/OBWriteDomesticResponse2 OBWriteDomesticResponse2 {
Data * #/definitions/OBWriteDataDomesticResponse2 OBWriteDataDomesticResponse2 {
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 * OBTransactionIndividualStatus1Code string
Specifies the status of the payment information group.
Enum:
[ AcceptedSettlementCompleted, AcceptedSettlementInProcess, 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
MultiAuthorisation #/definitions/OBMultiAuthorisation1 OBMultiAuthorisation1 {
description:
The multiple authorisation flow response from the ASPSP.
Status * OBExternalStatus2Code string
Specifies the status of the authorisation flow in code form.
Enum:
[ Authorised, AwaitingFurtherAuthorisation, Rejected ]
NumberRequired integer ($ int32 )

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

NumberReceived integer ($ int32 )

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

LastUpdateDateTime string ($ 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

ExpirationDateTime string ($ 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/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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
Header containing a detached JWS 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/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
401
Unauthorized
403
Forbidden
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
 integer
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}

Domestic Scheduled Payments

NameDescription
OBWriteDomesticScheduledConsent2Param  *
( body )
Default

{
  "Data": {
    "Permission": "Create",
    "Initiation": {
      "RequestedExecutionDate": "2019-11-06T00:00:00+00:00",
      "InstructedAmount": {
        "Amount": "100.00",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08606467451219",
        "Name": "Mr Robin Hood"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "60132378234512",
        "Name": "Mr Robin Hood"
      }
    }
  },
  "Risk": []
}
#/definitions/OBWriteDomesticScheduledConsent2 OBWriteDomesticScheduledConsent2 {
Data * #/definitions/OBWriteDataDomesticScheduledConsent2 OBWriteDataDomesticScheduledConsent2 {
Permission * OBExternalPermissions2Code string
Specifies the Open Banking service request types.
Enum:
[ Create ]
Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
}
x-fapi-financial-id  *
string
( header )
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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 )
A detached JWS signature of the body of the payload.
x-customer-user-agent
string
( header )

Indicates the user-agent that the PSU is using.

Responses

CodeDescription
201
Domestic Scheduled Payment Consents Created

{
  "Data": {
    "ConsentId": "fb3405cc-7a77-4fa3-89f9-d53128e954b0",
    "Permission": "Create",
    "Status": "AwaitingAuthorisation",
    "CreationDateTime": "2019-03-05T10:55:18.527Z",
    "StatusUpdateDateTime": "2019-03-05T10:55:18.527Z",
    "Initiation": {
      "RequestedExecutionDate": "2019-11-06T00:00:00+00:00",
      "InstructedAmount": {
        "Amount": "100.00",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08606467451219",
        "Name": "Mr Robin Hood"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "60132378234512",
        "Name": "Mr Robin Hood"
      }
    }
  },
  "Risk": [],
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/fb3405cc-7a77-4fa3-89f9-d53128e954b0"
  },
  "Meta": []
}
#/definitions/OBWriteDomesticScheduledConsentResponse2 OBWriteDomesticScheduledConsentResponse2 {
Data * #/definitions/OBWriteDataDomesticScheduledConsentResponse2 OBWriteDataDomesticScheduledConsentResponse2 {
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 * OBExternalConsentStatus1Code 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 consent 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 * OBExternalPermissions2Code string
Specifies the Open Banking service request types.
Enum:
[ Create ]
CutOffDateTime string ($ 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
Links * #/definitions/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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
Header containing a detached JWS 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/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
 integer
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
NameDescription
ConsentId  *
string
( path )
ConsentId
x-fapi-financial-id  *
string
( header )
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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-customer-user-agent
string
( header )

Indicates the user-agent that the PSU is using.

Responses

CodeDescription
200
Domestic Scheduled Payment Consents Read

{
  "Data": {
    "ConsentId": "fb3405cc-7a77-4fa3-89f9-d53128e954b0",
    "Permission": "Create",
    "Status": "AwaitingAuthorisation",
    "CreationDateTime": "2019-03-05T10:55:18.527Z",
    "StatusUpdateDateTime": "2019-03-05T10:55:18.527Z",
    "Initiation": {
      "RequestedExecutionDate": "2019-11-06T00:00:00+00:00",
      "InstructedAmount": {
        "Amount": "100.00",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08606467451219",
        "Name": "Mr Robin Hood"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "60132378234512",
        "Name": "Mr Robin Hood"
      }
    }
  },
  "Risk": [],
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/fb3405cc-7a77-4fa3-89f9-d53128e954b0"
  },
  "Meta": []
}
#/definitions/OBWriteDomesticScheduledConsentResponse2 OBWriteDomesticScheduledConsentResponse2 {
Data * #/definitions/OBWriteDataDomesticScheduledConsentResponse2 OBWriteDataDomesticScheduledConsentResponse2 {
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 * OBExternalConsentStatus1Code 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 consent 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 * OBExternalPermissions2Code string
Specifies the Open Banking service request types.
Enum:
[ Create ]
CutOffDateTime string ($ 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 { ... }
SupplementaryData #/definitions/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
Links * #/definitions/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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
Header containing a detached JWS 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/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
 integer
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
NameDescription
OBWriteDomesticScheduled2Param  *
( body )
Default

{
  "Data": {
    "ConsentId": "fb3405cc-7a77-4fa3-89f9-d53128e954b0",
    "Initiation": {
      "RequestedExecutionDate": "2019-11-06T00:00:00+00:00",
      "InstructedAmount": {
        "Amount": "100.00",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08606467451219",
        "Name": "Mr Robin Hood"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "60132378234512",
        "Name": "Mr Robin Hood"
      }
    }
  },
  "Risk": []
}
#/definitions/OBWriteDomesticScheduled2 OBWriteDomesticScheduled2 {
Data * #/definitions/OBWriteDataDomesticScheduled2 OBWriteDataDomesticScheduled2 {
ConsentId * string
minLength : 1
maxLength : 128

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

Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
}
x-fapi-financial-id  *
string
( header )
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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 )
A detached JWS signature of the body of the payload.
x-customer-user-agent
string
( header )

Indicates the user-agent that the PSU is using.

Responses

CodeDescription
201
Domestic Scheduled Payments Created

{
  "Data": {
    "ConsentId": "fb3405cc-7a77-4fa3-89f9-d53128e954b0",
    "Status": "InitiationPending",
    "CreationDateTime": "2019-03-05T15:15:13+00:00",
    "StatusUpdateDateTime": "2019-03-05T15:15:13+00:00",
    "Initiation": {
      "RequestedExecutionDate": "2019-11-06T00:00:00+00:00",
      "InstructedAmount": {
        "Amount": "100.00",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08606467451219",
        "Name": "Mr Robin Hood"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "60132378234512",
        "Name": "Mr Robin Hood"
      }
    }
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/pisp/domestic-scheduled-payments/fb3405cc-7a77-4fa3-89f9-d53128e954b0"
  },
  "Meta": []
}
#/definitions/OBWriteDomesticScheduledResponse2 OBWriteDomesticScheduledResponse2 {
Data * #/definitions/OBWriteDataDomesticScheduledResponse2 OBWriteDataDomesticScheduledResponse2 {
DomesticScheduledPaymentId * string
minLength : 1
maxLength : 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule 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 * OBExternalStatus1Code string
Specifies the status of the payment order resource.
Enum:
[ 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
MultiAuthorisation #/definitions/OBMultiAuthorisation1 OBMultiAuthorisation1 {
description:
The multiple authorisation flow response from the ASPSP.
Status * OBExternalStatus2Code string
Specifies the status of the authorisation flow in code form.
Enum:
[ Authorised, AwaitingFurtherAuthorisation, Rejected ]
NumberRequired integer ($ int32 )

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

NumberReceived integer ($ int32 )

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

LastUpdateDateTime string ($ 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

ExpirationDateTime string ($ 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/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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
Header containing a detached JWS 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/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
 integer
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
NameDescription
DomesticScheduledPaymentId  *
string
( path )
DomesticScheduledPaymentId
x-fapi-financial-id  *
string
( header )
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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-customer-user-agent
string
( header )

Indicates the user-agent that the PSU is using.

Responses

CodeDescription
200
Domestic Scheduled Payments Read

{
  "Data": {
    "ConsentId": "fb3405cc-7a77-4fa3-89f9-d53128e954b0",
    "Status": "InitiationPending",
    "CreationDateTime": "2019-03-05T15:15:13+00:00",
    "StatusUpdateDateTime": "2019-03-05T15:15:13+00:00",
    "Initiation": {
      "RequestedExecutionDate": "2019-11-06T00:00:00+00:00",
      "InstructedAmount": {
        "Amount": "100.00",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08606467451219",
        "Name": "Mr Robin Hood"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "60132378234512",
        "Name": "Mr Robin Hood"
      }
    }
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/pisp/domestic-scheduled-payments/fb3405cc-7a77-4fa3-89f9-d53128e954b0"
  },
  "Meta": []
}
#/definitions/OBWriteDomesticScheduledResponse2 OBWriteDomesticScheduledResponse2 {
Data * #/definitions/OBWriteDataDomesticScheduledResponse2 OBWriteDataDomesticScheduledResponse2 {
DomesticScheduledPaymentId * string
minLength : 1
maxLength : 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule 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 * OBExternalStatus1Code string
Specifies the status of the payment order resource.
Enum:
[ 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
MultiAuthorisation #/definitions/OBMultiAuthorisation1 OBMultiAuthorisation1 {
description:
The multiple authorisation flow response from the ASPSP.
Status * OBExternalStatus2Code string
Specifies the status of the authorisation flow in code form.
Enum:
[ Authorised, AwaitingFurtherAuthorisation, Rejected ]
NumberRequired integer ($ int32 )

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

NumberReceived integer ($ int32 )

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

LastUpdateDateTime string ($ 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

ExpirationDateTime string ($ 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/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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
Header containing a detached JWS 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/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
 integer
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1 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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}

Models

OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.

OBActiveOrHistoricCurrencyAndAmount {
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}

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

OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}

OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}

OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}

OBExchangeRate1 {
description:
Provides details on the currency exchange rate and contract.
UnitCurrency * string
pattern : ^[A-Z]{3,3}$

Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.

ExchangeRate number
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
RateType * OBExchangeRateType2Code string
Specifies the type used to complete the currency exchange.
Enum:
[ Actual, Agreed, Indicative ]
ContractIdentification string
minLength : 1
maxLength : 256

Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

OBExchangeRate2 {
description:
Further detailed information on the exchange rate that has been used in the payment transaction.
UnitCurrency * string
pattern : ^[A-Z]{3,3}$

Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.

ExchangeRate * number
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
RateType * OBExchangeRateType2Code string
Specifies the type used to complete the currency exchange.
Enum:
[ Actual, Agreed, Indicative ]
ContractIdentification string
minLength : 1
maxLength : 256

Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

ExpirationDateTime string ($ date-time )

Specified date and time the exchange rate agreement will expire.
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

}

OBExchangeRateType2Code string
Specifies the type used to complete the currency exchange.
Enum:
[ Actual, Agreed, Indicative ]

OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]

OBExternalConsentStatus1Code string
Specifies the status of consent resource in code form.
Enum:
[ Authorised, AwaitingAuthorisation, Consumed, Rejected ]

OBExternalConsentStatus2Code string
Specifies the status of consent resource in code form.
Enum:
[ Authorised, AwaitingAuthorisation, AwaitingUpload, Consumed, Rejected ]

OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]

OBExternalPermissions2Code string
Specifies the Open Banking service request types.
Enum:
[ Create ]

OBExternalStatus1Code string
Specifies the status of the payment order resource.
Enum:
[ InitiationCompleted, InitiationFailed, InitiationPending ]

OBExternalStatus2Code string
Specifies the status of the authorisation flow in code form.
Enum:
[ Authorised, AwaitingFurtherAuthorisation, Rejected ]

OBMultiAuthorisation1 {
description:
The multiple authorisation flow response from the ASPSP.
Status * OBExternalStatus2Code string
Specifies the status of the authorisation flow in code form.
Enum:
[ Authorised, AwaitingFurtherAuthorisation, Rejected ]
NumberRequired integer ($ int32 )

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

NumberReceived integer ($ int32 )

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

LastUpdateDateTime string ($ 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

ExpirationDateTime string ($ 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

}

OBPartyIdentification43 {
description:
Party to which an amount of money is due.
Name string
minLength : 1
maxLength : 140
Name by which a party is known and which is usually used to identify that party.
PostalAddress #/definitions/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
}

OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}

OBPriority2Code string
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Enum:
[ Normal, Urgent ]

OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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.

}

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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}

OBTransactionIndividualStatus1Code string
Specifies the status of the payment information group.
Enum:
[ AcceptedSettlementCompleted, AcceptedSettlementInProcess, Pending, Rejected ]

OBWriteDataDomestic2 {
ConsentId * string
minLength : 1
maxLength : 128

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

Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
}

OBWriteDataDomesticConsent2 {
Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}

OBWriteDataDomesticConsentResponse2 {
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 * OBExternalConsentStatus1Code 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

CutOffDateTime string ($ 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}

OBWriteDataDomesticResponse2 {
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 * OBTransactionIndividualStatus1Code string
Specifies the status of the payment information group.
Enum:
[ AcceptedSettlementCompleted, AcceptedSettlementInProcess, 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
MultiAuthorisation #/definitions/OBMultiAuthorisation1 OBMultiAuthorisation1 {
description:
The multiple authorisation flow response from the ASPSP.
Status * OBExternalStatus2Code string
Specifies the status of the authorisation flow in code form.
Enum:
[ Authorised, AwaitingFurtherAuthorisation, Rejected ]
NumberRequired integer ($ int32 )

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

NumberReceived integer ($ int32 )

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

LastUpdateDateTime string ($ 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

ExpirationDateTime string ($ 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

}
}

OBWriteDataDomesticScheduled2 {
ConsentId * string
minLength : 1
maxLength : 128

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

Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
}

OBWriteDataDomesticScheduledConsent2 {
Permission * OBExternalPermissions2Code string
Specifies the Open Banking service request types.
Enum:
[ Create ]
Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}

OBWriteDataDomesticScheduledConsentResponse2 {
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 * OBExternalConsentStatus1Code 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 consent 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 * OBExternalPermissions2Code string
Specifies the Open Banking service request types.
Enum:
[ Create ]
CutOffDateTime string ($ 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}

OBWriteDataDomesticScheduledResponse2 {
DomesticScheduledPaymentId * string
minLength : 1
maxLength : 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule 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 * OBExternalStatus1Code string
Specifies the status of the payment order resource.
Enum:
[ 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
MultiAuthorisation #/definitions/OBMultiAuthorisation1 OBMultiAuthorisation1 {
description:
The multiple authorisation flow response from the ASPSP.
Status * OBExternalStatus2Code string
Specifies the status of the authorisation flow in code form.
Enum:
[ Authorised, AwaitingFurtherAuthorisation, Rejected ]
NumberRequired integer ($ int32 )

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

NumberReceived integer ($ int32 )

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

LastUpdateDateTime string ($ 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

ExpirationDateTime string ($ 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

}
}

OBWriteDomestic2 {
Data * #/definitions/OBWriteDataDomestic2 OBWriteDataDomestic2 {
ConsentId * string
minLength : 1
maxLength : 128

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

Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
}

OBWriteDomesticConsent2 {
Data * #/definitions/OBWriteDataDomesticConsent2 OBWriteDataDomesticConsent2 {
Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
}

OBWriteDomesticConsentResponse2 {
Data * #/definitions/OBWriteDataDomesticConsentResponse2 OBWriteDataDomesticConsentResponse2 {
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 * OBExternalConsentStatus1Code 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

CutOffDateTime string ($ 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
Links * #/definitions/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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

}
}

OBWriteDomesticResponse2 {
Data * #/definitions/OBWriteDataDomesticResponse2 OBWriteDataDomesticResponse2 {
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 * OBTransactionIndividualStatus1Code string
Specifies the status of the payment information group.
Enum:
[ AcceptedSettlementCompleted, AcceptedSettlementInProcess, 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomestic2 OBDomestic2 {
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
MultiAuthorisation #/definitions/OBMultiAuthorisation1 OBMultiAuthorisation1 {
description:
The multiple authorisation flow response from the ASPSP.
Status * OBExternalStatus2Code string
Specifies the status of the authorisation flow in code form.
Enum:
[ Authorised, AwaitingFurtherAuthorisation, Rejected ]
NumberRequired integer ($ int32 )

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

NumberReceived integer ($ int32 )

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

LastUpdateDateTime string ($ 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

ExpirationDateTime string ($ 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/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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

}
}

OBWriteDomesticScheduled2 {
Data * #/definitions/OBWriteDataDomesticScheduled2 OBWriteDataDomesticScheduled2 {
ConsentId * string
minLength : 1
maxLength : 128

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

Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
}

OBWriteDomesticScheduledConsent2 {
Data * #/definitions/OBWriteDataDomesticScheduledConsent2 OBWriteDataDomesticScheduledConsent2 {
Permission * OBExternalPermissions2Code string
Specifies the Open Banking service request types.
Enum:
[ Create ]
Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
}

OBWriteDomesticScheduledConsentResponse2 {
Data * #/definitions/OBWriteDataDomesticScheduledConsentResponse2 OBWriteDataDomesticScheduledConsentResponse2 {
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 * OBExternalConsentStatus1Code 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 consent 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 * OBExternalPermissions2Code string
Specifies the Open Banking service request types.
Enum:
[ Create ]
CutOffDateTime string ($ 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Authorisation #/definitions/OBAuthorisation1 OBAuthorisation1 {
description:
The authorisation type request from the TPP.
AuthorisationType * OBExternalAuthorisation1Code string
Type of authorisation flow requested.
Enum:
[ Any, Single ]
CompletionDateTime string ($ 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

}
}
Risk * #/definitions/OBRisk1 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.
PaymentContextCode OBExternalPaymentContext1Code string
Specifies the payment context
Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength : 3
maxLength : 4

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

MerchantCustomerIdentification string
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

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

string
minLength : 1
maxLength : 70 ]
StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName * string
minLength : 1
maxLength : 35

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

CountrySubDivision [
minItems : 0
maxItems : 2

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

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

Nation with its own government, occupying a particular territory.

}
}
Links * #/definitions/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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

}
}

OBWriteDomesticScheduledResponse2 {
Data * #/definitions/OBWriteDataDomesticScheduledResponse2 OBWriteDataDomesticScheduledResponse2 {
DomesticScheduledPaymentId * string
minLength : 1
maxLength : 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule 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 * OBExternalStatus1Code string
Specifies the status of the payment order resource.
Enum:
[ 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

ExpectedExecutionDateTime string ($ 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

ExpectedSettlementDateTime string ($ 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 [
Set of elements used to provide details of a charge for the payment initiation.
#/definitions/OBCharge2 OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
} ]
Initiation * #/definitions/OBDomesticScheduled2 OBDomesticScheduled2 {
description:
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
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.

LocalInstrument OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

RequestedExecutionDateTime * string ($ date-time )

Date at which the initiating party requests the clearing agent to process the payment.
Usage: This is the date on which the debtor's account is to be debited.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

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_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
DebtorAccount #/definitions/OBCashAccountDebtor4 OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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 * #/definitions/OBCashAccountCreditor3 OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
RemittanceInformation #/definitions/OBRemittanceInformation1 OBRemittanceInformation1 {
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.

Unstructured string
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.

Reference string
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/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
MultiAuthorisation #/definitions/OBMultiAuthorisation1 OBMultiAuthorisation1 {
description:
The multiple authorisation flow response from the ASPSP.
Status * OBExternalStatus2Code string
Specifies the status of the authorisation flow in code form.
Enum:
[ Authorised, AwaitingFurtherAuthorisation, Rejected ]
NumberRequired integer ($ int32 )

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

NumberReceived integer ($ int32 )

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

LastUpdateDateTime string ($ 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

ExpirationDateTime string ($ 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/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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

}
}

OBSupplementaryData1 {
description:

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

}

OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

OBCashAccountDebtor4 {
description:
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
minLength : 1
maxLength : 34

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

}

OBCashAccountCreditor3 {
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 * OBExternalAccountIdentification4Code string
example : List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength : 1
maxLength : 40

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

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

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

SecondaryIdentification string
minLength : 1
maxLength : 34

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

}

OBWriteFundsConfirmationResponse1 {
Data * #/definitions/OBWriteDataFundsConfirmationResponse1 OBWriteDataFundsConfirmationResponse1 {
FundsAvailableResult #/definitions/OBFundsAvailableResult1 OBFundsAvailableResult1 {
description:
Result of a funds availability check.
FundsAvailableDateTime * string ($ date-time )

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

FundsAvailable * boolean
Flag to indicate the availability of funds given the Amount in the consent request.
}
SupplementaryData #/definitions/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}
Links * #/definitions/Links Links {
description:
Links relevant to the payload
Self * string ($ uri )
First string ($ uri )
Prev string ($ uri )
Next string ($ uri )
Last string ($ uri )
}
Meta * #/definitions/Meta MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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

}
}

OBWriteDataFundsConfirmationResponse1 {
FundsAvailableResult #/definitions/OBFundsAvailableResult1 OBFundsAvailableResult1 {
description:
Result of a funds availability check.
FundsAvailableDateTime * string ($ date-time )

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

FundsAvailable * boolean
Flag to indicate the availability of funds given the Amount in the consent request.
}
SupplementaryData #/definitions/OBSupplementaryData1 OBSupplementaryData1 {
description:

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

}
}

OBExternalLocalInstrument1Code string
example : List [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ]
minLength : 1
maxLength : 50

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.

OBCharge2 {
description:
Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer * OBChargeBearerType1Code string

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type * OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

Amount * {
description:
Amount of money associated with the charge type.
Amount * OBActiveCurrencyAndAmount_SimpleType string
pattern : ^\d{1,13}\.\d{1,2}$
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places.
Currency * string
pattern : ^[A-Z]{3,3}$
}
}

OBExternalPaymentChargeType1Code string
example : List [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ]
minLength : 1
maxLength : 40

Charge type, in a coded form.

OBExternalFileType1Code string
example : List [ "UK.OBIE.PaymentInitiation.3.1", "UK.OBIE.pain.001.001.08" ]
minLength : 1
maxLength : 40
Specifies the payment file type.

OBExternalPurpose1Code1 string
minLength : 1
maxLength : 4
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.

OBBranchAndFinancialInstitutionIdentification6 {
description:
Financial institution servicing an account for the creditor.
SchemeName OBExternalFinancialInstitutionIdentification4Code string
example : List [ "UK.OBIE.BICFI" ]
minLength : 1
maxLength : 40

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

Identification string
minLength : 1
maxLength : 35
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Name string
minLength : 1
maxLength : 140
Name by which an agent is known and which is usually used to identify that agent.
PostalAddress #/definitions/OBPostalAddress6 OBPostalAddress6 {
description:

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

AddressType OBAddressTypeCode string
Identifies the nature of the postal address.
Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department string
minLength : 1
maxLength : 70
Identification of a division of a large organisation or building.
SubDepartment string
minLength : 1
maxLength : 70

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

StreetName string
minLength : 1
maxLength : 70
Name of a street or thoroughfare.
BuildingNumber string
minLength : 1
maxLength : 16
Number that identifies the position of a building on a street.
PostCode string
minLength : 1
maxLength : 16

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

TownName string
minLength : 1
maxLength : 35

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

CountrySubDivision string
minLength : 1
maxLength : 35

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

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

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

string
minLength : 1
maxLength : 70 ]
}
}

OBExternalFinancialInstitutionIdentification4Code string
example : List [ "UK.OBIE.BICFI" ]
minLength : 1
maxLength : 40

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

OBFundsAvailableResult1 {
description:
Result of a funds availability check.
FundsAvailableDateTime * string ($ date-time )

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

FundsAvailable * boolean
Flag to indicate the availability of funds given the Amount in the consent request.
}

OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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.

Id string
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/OBError1 OBError1 {
ErrorCode * string
minLength : 1
maxLength : 128

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

Path string
minLength : 1
maxLength : 500

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

Url string

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

} ]
}

File string ($ binary )

ISODateTime string ($ 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

MetaData {
description:
Meta Data relevant to the payload
TotalPages integer ($ int32 )
FirstAvailableDateTime ISODateTime string ($ 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

LastAvailableDateTime ISODateTime string ($ 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 support mailbox

OpenBankingResponse@virginmoney.com

Contact us