Account and transaction | Virgin Money Developer Portal

Page contents

Endpoint config
API calls
Models

What this API does:

These APIs provide the ability for account information service providers (AISPs) registered with Open Banking to access a customer's account and transaction information.

Register an intent to retrieve account information by creating an "account access consent". This registers the data "permissions", expiration and historical period allowed for transactions / statements - that the customer (PSU) has consented to provide to the AISP.
Subsequently, retrieve account and transaction data.

Please note the example responses accurately reflect the response data being returned by Virgin Money. The models are the industry standard definitions and do NOT accurately reflect the data that will be returned by Virgin Money.

Access

Restricted to authorised AISPs - see support pages for information on how to onboard.
For Transport & Signing certificates supported - see support pages
For production endpoint - see support pages.

Endpoint configuration

POST /account-access-consents

Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/aisp/accounts

GET /account-access-consents/{ConsentID}

Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/aisp/accounts

GET /account-access-consents/{ConsentID}

Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/aisp/accounts

GET /accounts/{AccountID}

Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/aisp/accounts

GET /accounts/{AccountID}/balances

Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/aisp/accounts

GET /accounts/{AccountID}/beneficiaries

Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/aisp/accounts

GET /accounts/{AccountID}/direct-debits

Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/aisp/accounts

GET /accounts/{AccountID}/scheduled-payments

Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/aisp/accounts

GET /accounts/{AccountID}/offers

Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/aisp/accounts

GET /accounts/{AccountID}/standing-orders

Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/aisp/accounts

GET /accounts/{AccountID}/transactions

Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/aisp/accounts

API calls

Account Access

POST /account-access-consents Create Account Access Consents

Name Description

OBReadConsent1Param *

(body)

Default

Example Value Model

{
  "Data": {
    "Permissions": [
      "ReadAccountsDetail",
      "ReadBalances",
      "ReadBeneficiariesDetail",
      "ReadDirectDebits",
      "ReadStandingOrdersDetail",
      "ReadTransactionsCredits",
      "ReadTransactionsDebits",
      "ReadTransactionsDetail",
      "ReadScheduledPaymentsDetail"
    ],
    "ExpirationDateTime": "2019-08-02T00:00:00+00:00",
    "TransactionFromDateTime": "2017-05-03T00:00:00+00:00",
    "TransactionToDateTime": "2019-12-03T00:00:00+00:00"
  },
  "Risk": {}
}

#/definitions/OBReadConsent1OBReadConsent1{

Data*

#/definitions/OBReadData1OBReadData1{

Permissions*	[ minItems: 1 Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. OBExternalPermissions1Code`string` Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. Enum: [ ReadAccountsBasic, ReadAccountsDetail, ReadBalances, ReadBeneficiariesBasic, ReadBeneficiariesDetail, ReadDirectDebits, ReadOffers, ReadPAN, ReadParty, ReadPartyPSU, ReadProducts, ReadScheduledPaymentsBasic, ReadScheduledPaymentsDetail, ReadStandingOrdersBasic, ReadStandingOrdersDetail, ReadStatementsBasic, ReadStatementsDetail, ReadTransactionsBasic, ReadTransactionsCredits, ReadTransactionsDebits, ReadTransactionsDetail ]]
ExpirationDateTime	`string`($date-time) Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. 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
TransactionFromDateTime	`string`($date-time) Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. 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
TransactionToDateTime	`string`($date-time) Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. 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/OBRisk2OBRisk2{

description:

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

}

Parameter content type

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 Link opens in a new window

x-customer-user-agent

string

(header)

Indicates the user-agent that the PSU is using.

Responses

Response content type

Code Description

201

Account Access Consents Created

Example Value Model

{
  "Data": {
    "ConsentId": "0b25ba46-4cf8-49b6-bef5-0b01a3c041f5",
    "Status": "AwaitingAuthorisation",
    "StatusUpdateDateTime": "2019-02-02T00:00:00+00:00",
    "CreationDateTime": "2019-02-02T00:00:00+00:00",
    "Permissions": [
      "ReadAccountsDetail",
      "ReadBalances",
      "ReadBeneficiariesDetail",
      "ReadDirectDebits",
      "ReadStandingOrdersDetail",
      "ReadTransactionsCredits",
      "ReadTransactionsDebits",
      "ReadTransactionsDetail",
      "ReadScheduledPaymentsDetail"
    ],
    "ExpirationDateTime": "2019-08-02T00:00:00+00:00",
    "TransactionFromDateTime": "2017-05-03T00:00:00+00:00",
    "TransactionToDateTime": "2019-12-03T00:00:00+00:00"
  },
  "Risk": [],
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/aisp/account-access-consents/70fdb049-8260-4d53-89c2-0a764e581ac3/"
  },
  "Meta": []
}

#/definitions/OBReadConsentResponse1OBReadConsentResponse1{

Data*

{

ConsentId*	`string` minLength: 1 maxLength: 128 Unique identification as assigned to identify the account access 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*	OBExternalRequestStatus1Code`string` Specifies the status of consent resource in code form. Enum: [ Authorised, AwaitingAuthorisation, Rejected, Revoked ]
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
Permissions*	[ minItems: 1 Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. OBExternalPermissions1Code`string` Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. Enum: [ ReadAccountsBasic, ReadAccountsDetail, ReadBalances, ReadBeneficiariesBasic, ReadBeneficiariesDetail, ReadDirectDebits, ReadOffers, ReadPAN, ReadParty, ReadPartyPSU, ReadProducts, ReadScheduledPaymentsBasic, ReadScheduledPaymentsDetail, ReadStandingOrdersBasic, ReadStandingOrdersDetail, ReadStatementsBasic, ReadStatementsDetail, ReadTransactionsBasic, ReadTransactionsCredits, ReadTransactionsDebits, ReadTransactionsDetail ]]
ExpirationDateTime	`string`($date-time) Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. 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
TransactionFromDateTime	`string`($date-time) Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. 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
TransactionToDateTime	`string`($date-time) Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. 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/OBRisk2OBRisk2{

description:

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

}

Links*

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`($uri)
First	`string`($uri)
Prev	`string`($uri)
Next	`string`($uri)
Last	`string`($uri)

}

Meta*

#/definitions/MetaMetaData{

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:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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:

Name	Description	Type
Retry-After	Number in seconds to wait	integer

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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

}]

}

GET /account-access-consents/{ConsentId} Get Account Access Consents

Name	Description
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 Link opens in a new window
x-customer-user-agent string (header)	Indicates the user-agent that the PSU is using.

Responses

Response content type

Code Description

200

Account Access Consents Read

Example Value Model

{
  "Data": {
    "ConsentId": "0b25ba46-4cf8-49b6-bef5-0b01a3c041f5",
    "Status": "AwaitingAuthorisation",
    "StatusUpdateDateTime": "2019-02-02T00:00:00+00:00",
    "CreationDateTime": "2019-02-02T00:00:00+00:00",
    "Permissions": [
      "ReadAccountsDetail",
      "ReadBalances",
      "ReadBeneficiariesDetail",
      "ReadDirectDebits",
      "ReadStandingOrdersDetail",
      "ReadTransactionsCredits",
      "ReadTransactionsDebits",
      "ReadTransactionsDetail",
      "ReadScheduledPaymentsDetail"
    ],
    "ExpirationDateTime": "2019-08-02T00:00:00+00:00",
    "TransactionFromDateTime": "2017-05-03T00:00:00+00:00",
    "TransactionToDateTime": "2019-12-03T00:00:00+00:00"
  },
  "Risk": [],
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/aisp/account-access-consents/70fdb049-8260-4d53-89c2-0a764e581ac3/"
  },
  "Meta": []
}

#/definitions/OBReadConsentResponse1OBReadConsentResponse1{

Data*

{

ConsentId*	`string` minLength: 1 maxLength: 128 Unique identification as assigned to identify the account access 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*	OBExternalRequestStatus1Code`string` Specifies the status of consent resource in code form. Enum: [ Authorised, AwaitingAuthorisation, Rejected, Revoked ]
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
Permissions*	[ minItems: 1 Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. OBExternalPermissions1Code`string` Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. Enum: [ ReadAccountsBasic, ReadAccountsDetail, ReadBalances, ReadBeneficiariesBasic, ReadBeneficiariesDetail, ReadDirectDebits, ReadOffers, ReadPAN, ReadParty, ReadPartyPSU, ReadProducts, ReadScheduledPaymentsBasic, ReadScheduledPaymentsDetail, ReadStandingOrdersBasic, ReadStandingOrdersDetail, ReadStatementsBasic, ReadStatementsDetail, ReadTransactionsBasic, ReadTransactionsCredits, ReadTransactionsDebits, ReadTransactionsDetail ]]
ExpirationDateTime	`string`($date-time) Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. 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
TransactionFromDateTime	`string`($date-time) Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. 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
TransactionToDateTime	`string`($date-time) Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. 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/OBRisk2OBRisk2{

description:

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

}

Links*

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`($uri)
First	`string`($uri)
Prev	`string`($uri)
Next	`string`($uri)
Last	`string`($uri)

}

Meta*

#/definitions/MetaMetaData{

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:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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:

Name	Description	Type
Retry-After	Number in seconds to wait	integer

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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

}]

}

DELETE /account-access-consents/{ConsentId} Delete Account Access Consents

Name	Description
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 Link opens in a new window
x-customer-user-agent string (header)	Indicates the user-agent that the PSU is using.

Responses

Response content type

Code Description

204

Account Access Consents Deleted

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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:

Name	Description	Type
Retry-After	Number in seconds to wait	integer

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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

}]

}

Accounts

GET /accounts Get Accounts

Name	Description
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 Link opens in a new window
x-customer-user-agent string (header)	Indicates the user-agent that the PSU is using.

Responses

Response content type

Code Description

200

Accounts Read

Example Value Model

{
  "Data": {
    "Account": [
      {
        "AccountId": "70fdb049-8260-4d53-89c2-0a764e581ac3",
        "Currency": "GBP",
        "AccountType": "Personal",
        "AccountSubType": "CurrentAccount",
        "Description": "Essential Current Account",
        "Account": [
          {
            "SchemeName": "UK.OBIE.SortCodeAccountNumber",
            "Identification": "08606467083291",
            "Name": "Mr Robin Hood"
          }
        ]
      }
    ]
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/aisp/accounts/"
  },
  "Meta": []
}

#/definitions/OBReadAccount3OBReadAccount3{

Data*

{

Account

[

Unambiguous identification of the account to which credit and debit entries are made.

#/definitions/OBAccount3OBAccount3{

description:

Unambiguous identification of the account to which credit and debit entries are made.

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

Currency*

string
pattern: ^[A-Z]{3,3}$

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

AccountType*

OBExternalAccountType1Codestring

Specifies the type of account (personal or business).

Enum:
[ Business, Personal ]

AccountSubType*

OBExternalAccountSubType1Codestring

Specifies the sub type of account (product family group).

Enum:
[ ChargeCard, CreditCard, CurrentAccount, EMoney, Loan, Mortgage, PrePaidCard, Savings ]

Description

string
minLength: 1
maxLength: 35

Specifies the description of the account type.

Nickname

string
minLength: 1
maxLength: 70

The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.

Account

[

Provides the details to identify an account.

#/definitions/OBCashAccount5OBCashAccount5{

description:	Provides the details to identify the beneficiary account.
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 Beneficiary account identification.
Name	`string` minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
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).

}]

Servicer

#/definitions/OBBranchAndFinancialInstitutionIdentification5OBBranchAndFinancialInstitutionIdentification5{

description:	Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
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 the servicing institution.

}

}]

}

Links*

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`($uri)
First	`string`($uri)
Prev	`string`($uri)
Next	`string`($uri)
Last	`string`($uri)

}

Meta*

#/definitions/MetaMetaData{

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:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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:

Name	Description	Type
Retry-After	Number in seconds to wait	integer

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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

}]

}

GET /accounts/{AccountId} Get Accounts

Name	Description
AccountId * string (path)	AccountId
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 Link opens in a new window
x-customer-user-agent string (header)	Indicates the user-agent that the PSU is using.

Responses

Response content type

Code Description

200

Accounts Read

Example Value Model

{
  "Data": {
    "Account": [
      {
        "AccountId": "70fdb049-8260-4d53-89c2-0a764e581ac3",
        "Currency": "GBP",
        "AccountType": "Personal",
        "AccountSubType": "CurrentAccount",
        "Description": "Essential Current Account",
        "Account": [
          {
            "SchemeName": "UK.OBIE.SortCodeAccountNumber",
            "Identification": "08606467083291",
            "Name": "Mr Robin Hood"
          }
        ]
      }
    ]
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/aisp/accounts/"
  },
  "Meta": []
}

#/definitions/OBReadAccount3OBReadAccount3{

Data*

{

Account

[

Unambiguous identification of the account to which credit and debit entries are made.

#/definitions/OBAccount3OBAccount3{

description:

Unambiguous identification of the account to which credit and debit entries are made.

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

Currency*

string
pattern: ^[A-Z]{3,3}$

AccountType*

OBExternalAccountType1Codestring

Specifies the type of account (personal or business).

Enum:
[ Business, Personal ]

AccountSubType*

OBExternalAccountSubType1Codestring

Specifies the sub type of account (product family group).

Enum:
[ ChargeCard, CreditCard, CurrentAccount, EMoney, Loan, Mortgage, PrePaidCard, Savings ]

Description

string
minLength: 1
maxLength: 35

Specifies the description of the account type.

Nickname

string
minLength: 1
maxLength: 70

The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.

Account

[

Provides the details to identify an account.

#/definitions/OBCashAccount5OBCashAccount5{

description:	Provides the details to identify the beneficiary account.
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 Beneficiary account identification.
Name	`string` minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
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).

}]

Servicer

#/definitions/OBBranchAndFinancialInstitutionIdentification5OBBranchAndFinancialInstitutionIdentification5{

description:	Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
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 the servicing institution.

}

}]

}

Links*

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`($uri)
First	`string`($uri)
Prev	`string`($uri)
Next	`string`($uri)
Last	`string`($uri)

}

Meta*

#/definitions/MetaMetaData{

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:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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:

Name	Description	Type
Retry-After	Number in seconds to wait	integer

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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

}]

}

Balances

GET /accounts/{AccountId}/balances Get Balances

Name	Description
AccountId * string (path)	AccountId
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 Link opens in a new window
x-customer-user-agent string (header)	Indicates the user-agent that the PSU is using.

Responses

Response content type

Code Description

200

Balances Read

Example Value Model

{
  "Data": {
    "Balance": [
      {
        "AccountId": "70fdb049-8260-4d53-89c2-0a764e581ac3",
        "Amount": {
          "Amount": "1145.40",
          "Currency": "GBP"
        },
        "CreditDebitIndicator": "Credit",
        "Type": "InterimAvailable",
        "DateTime": "2019-01-09T00:00:00+00:00",
        "CreditLine": [
          {
            "Included": false,
            "Amount": {
              "Amount": "1000.00",
              "Currency": "GBP"
            },
            "Type": "Pre-Agreed"
          }
        ]
      },
      {
        "AccountId": "70fdb049-8260-4d53-89c2-0a764e581ac3",
        "Amount": {
          "Amount": "1145.40",
          "Currency": "GBP"
        },
        "CreditDebitIndicator": "Credit",
        "Type": "InterimBooked",
        "DateTime": "2019-01-08T00:00:00+00:00",
        "CreditLine": [
          {
            "Included": false,
            "Amount": {
              "Amount": "1000.00",
              "Currency": "GBP"
            },
            "Type": "Pre-Agreed"
          }
        ]
      }
    ]
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/aisp/accounts/70fdb049-8260-4d53-89c2-0a764e581ac3/balances/"
  },
  "Meta": []
}

#/definitions/OBReadBalance1OBReadBalance1{

Data*

{

Balance*

[
minItems: 1

Set of elements used to define the balance details.

#/definitions/OBCashBalance1OBCashBalance1{

description:

Set of elements used to define the balance details.

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

CreditDebitIndicator*

string

Indicates whether the balance is a credit or a debit balance.
Usage: A zero balance is considered to be a credit balance.

Enum:
[ Credit, Debit ]

Type*

OBBalanceType1Codestring

Balance type, in a coded form.

Enum:
[ ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked ]

DateTime*

string($date-time)

Indicates the date (and time) of the balance.
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

Amount*

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	`string` pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

CreditLine

[

Set of elements used to provide details on the credit line.

#/definitions/OBCreditLine1OBCreditLine1{

description:

Set of elements used to provide details on the credit line.

Included*

boolean

Indicates whether or not the credit line is included in the balance of the account.
Usage: If not present, credit line is not included in the balance amount of the account.

Type

OBExternalLimitType1Codestring

Limit type, in a coded form.

Enum:
[ Available, Credit, Emergency, Pre-Agreed, Temporary ]

Amount

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	`string` pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

}]

}

Links*

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`($uri)
First	`string`($uri)
Prev	`string`($uri)
Next	`string`($uri)
Last	`string`($uri)

}

Meta*

#/definitions/MetaMetaData{

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:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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:

Name	Description	Type
Retry-After	Number in seconds to wait	integer

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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

}]

}

Beneficiaries

GET /accounts/{AccountId}/beneficiaries Get Beneficiaries

Name	Description
AccountId * string (path)	AccountId
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 Link opens in a new window
x-customer-user-agent string (header)	Indicates the user-agent that the PSU is using.

Responses

Response content type

Code Description

200

Beneficiaries Read

Example Value Model

{
  "Data": {
    "Beneficiary": [
      {
        "AccountId": "d0e24e14-7e31-4976-b512-bb85bfe92acb",
        "Reference": "Robin Hood Current",
        "CreditorAccount": {
          "SchemeName": "UK.OBIE.SortCodeAccountNumber",
          "Identification": "08606467451219",
          "Name": "Robin Hood"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/aisp/accounts/d0e24e14-7e31-4976-b512-bb85bfe92acb/beneficiaries/"
  },
  "Meta": []
}

#/definitions/OBReadBeneficiary3OBReadBeneficiary3{

Data*

{

Beneficiary

[#/definitions/OBBeneficiary3OBBeneficiary3{

AccountId

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

BeneficiaryId

string
minLength: 1
maxLength: 40

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

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.

CreditorAgent

#/definitions/OBBranchAndFinancialInstitutionIdentification6OBBranchAndFinancialInstitutionIdentification6{

description:

Financial institution servicing an account for the debtor.

SchemeName

OBExternalFinancialInstitutionIdentification4Codestring
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/OBPostalAddress6OBPostalAddress6{

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]

}

CreditorAccount

#/definitions/OBCashAccount5OBCashAccount5{

description:	Provides the details to identify the beneficiary account.
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 Beneficiary account identification.
Name	`string` minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
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).

}

}]

}

Links*

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`($uri)
First	`string`($uri)
Prev	`string`($uri)
Next	`string`($uri)
Last	`string`($uri)

}

Meta*

#/definitions/MetaMetaData{

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:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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:

Name	Description	Type
Retry-After	Number in seconds to wait	integer

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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

}]

}

Direct Debits

GET /accounts/{AccountId}/direct-debits Get Direct Debits

Name	Description
AccountId * string (path)	AccountId
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 Link opens in a new window
x-customer-user-agent string (header)	Indicates the user-agent that the PSU is using.

Responses

Response content type

Code Description

200

Direct Debits Read

Example Value Model

{
  "Data": {
    "DirectDebit": [
      {
        "AccountId": "70fdb049-8260-4d53-89c2-0a764e581ac3",
        "MandateIdentification": "65234",
        "DirectDebitStatusCode": "Active",
        "Name": "Sherwood Bow Company",
        "PreviousPaymentDateTime": "2018-12-05T10:52:43+00:00",
        "PreviousPaymentAmount": {
          "Amount": "6.57",
          "Currency": "GBP"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/aisp/accounts/70fdb049-8260-4d53-89c2-0a764e581ac3/direct-debits/"
  },
  "Meta": []
}

#/definitions/OBReadDirectDebit1OBReadDirectDebit1{

Data*

{

DirectDebit

[

Account to or from which a cash entry is made.

#/definitions/OBDirectDebit1OBDirectDebit1{

description:

Account to or from which a cash entry is made.

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

DirectDebitId

string
minLength: 1
maxLength: 40

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

MandateIdentification*

string
minLength: 1
maxLength: 35

Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.

DirectDebitStatusCode

OBExternalDirectDebitStatus1Codestring

Specifies the status of the direct debit in code form.

Enum:
[ Active, Inactive ]

Name*

string
minLength: 1
maxLength: 70

Name of Service User.

PreviousPaymentDateTime

string($date-time)

Date of most recent direct debit collection.
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

PreviousPaymentAmount

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	`string` pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

}]

}

Links*

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`($uri)
First	`string`($uri)
Prev	`string`($uri)
Next	`string`($uri)
Last	`string`($uri)

}

Meta*

#/definitions/MetaMetaData{

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:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value
Model

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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:

Name	Description	Type
Retry-After	Number in seconds to wait	integer

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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

}]

}

Scheduled Payments

GET /accounts/{AccountId}/scheduled-payments Get Scheduled Payments

Name	Description
AccountId * string (path)	AccountId
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 Link opens in a new window
x-customer-user-agent string (header)	Indicates the user-agent that the PSU is using.

Responses

Response content type

Code Description

200

Scheduled Payments Read

Example Value Model

{
  "Data": {
    "ScheduledPayment": [
      {
        "AccountId": "70fdb049-8260-4d53-89c2-0a764e581ac3",
        "ScheduledPaymentDateTime": "2019-05-01T00:00:00+00:00",
        "ScheduledType": "Execution",
        "Reference": "Robin Hood",
        "InstructedAmount": {
          "Amount": "250.00",
          "Currency": "GBP"
        },
        "CreditorAccount": {
          "SchemeName": "UK.OBIE.SortCodeAccountNumber",
          "Identification": "23605490179017",
          "Name": "Will Scarlett"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/aisp/accounts/70fdb049-8260-4d53-89c2-0a764e581ac3/scheduled-payments/"
  },
  "Meta": []
}

#/definitions/OBReadScheduledPayment2OBReadScheduledPayment2{

Data*

{

ScheduledPayment

[#/definitions/OBScheduledPayment2OBScheduledPayment2{

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

ScheduledPaymentId

string
minLength: 1
maxLength: 40

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

ScheduledPaymentDateTime*

string($date-time)

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

ScheduledType*

OBExternalScheduleType1Codestring

Specifies the scheduled payment date type requested

Enum:
[ Arrival, Execution ]

Reference

string
minLength: 1
maxLength: 35

InstructedAmount*

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	`string` pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

CreditorAgent

#/definitions/OBBranchAndFinancialInstitutionIdentification5OBBranchAndFinancialInstitutionIdentification5{

description:	Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
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 the servicing institution.

}

CreditorAccount

#/definitions/OBCashAccount5OBCashAccount5{

description:	Provides the details to identify the beneficiary account.
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 Beneficiary account identification.
Name	`string` minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
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).

}

}]

}

Links*

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`($uri)
First	`string`($uri)
Prev	`string`($uri)
Next	`string`($uri)
Last	`string`($uri)

}

Meta*

#/definitions/MetaMetaData{

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:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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:

Name	Description	Type
Retry-After	Number in seconds to wait	integer

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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

}]

}

Offers

GET /accounts/{AccountId}/offers Get Offers

Name	Description
AccountId * string (path)	AccountId
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 Link opens in a new window
x-customer-user-agent string (header)	Indicates the user-agent that the PSU is using.

Responses

Response content type

Code Description

200

Offers Read

Example Value Model

{
  "Data": {
    "Offer": [
      {
        "AccountId": "52304852-7e5b-4b76-bc78-0f8d58f74336",
        "OfferId": "bd2b5573-6ac4-4a65-bb93-32aad1e03ec8",
        "OfferType": "MoneyTransfer",
        "Description": "Standard rate of 19.9% with 5% fee"
      },
      {
        "AccountId": "52304852-7e5b-4b76-bc78-0f8d58f74336",
        "OfferId": "34433799-9985-40b9-975f-dd2641e6d128",
        "OfferType": "BalanceTransfer",
        "Description": "4% until 31/03/2020 with a 4.00% fee"
      }
    ]
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/aisp/accounts/52304852-7e5b-4b76-bc78-0f8d58f74336/offers/"
  },
  "Meta": {
    "TotalPages": 1
  }
}

#/definitions/OBReadOffer1OBReadOffer1{

Data*

{

Offer

[#/definitions/OBOffer1OBOffer1{

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

OfferId

string
minLength: 1
maxLength: 40

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

OfferType

OBExternalOfferType1Codestring

Offer type, in a coded form.

Enum:
[ BalanceTransfer, LimitIncrease, MoneyTransfer, Other, PromotionalRate ]

Description

string
minLength: 1
maxLength: 500

Further details of the offer.

StartDateTime

string($date-time)

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

EndDateTime

string($date-time)

Date and time at which the offer ends.
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

Rate

string
minLength: 1
maxLength: 10
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Rate associated with the offer type.

Value

integer($int32)

Value associated with the offer type.

Term

string
minLength: 1
maxLength: 500

Further details of the term of the offer.

URL

string
minLength: 1
maxLength: 256

URL (Uniform Resource Locator) where documentation on the offer can be found

Amount

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	`string` pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

Fee

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	`string` pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

}]

}

Links*

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`($uri)
First	`string`($uri)
Prev	`string`($uri)
Next	`string`($uri)
Last	`string`($uri)

}

Meta*

#/definitions/MetaMetaData{

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:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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:

Name	Description	Type
Retry-After	Number in seconds to wait	integer

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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

}]

}

Standing Orders

GET /accounts/{AccountId}/standing-orders Get Standing Orders

Name	Description
AccountId * string (path)	AccountId
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 Link opens in a new window
x-customer-user-agent string (header)	Indicates the user-agent that the PSU is using.

Responses

Response content type

Code Description

200

Standing Orders Read

Example Value Model

{
  "Data": {
    "StandingOrder": [
      {
        "AccountId": "70fdb049-8260-4d53-89c2-0a764e581ac3",
        "StandingOrderId": "27812801",
        "Frequency": "IntrvlMnthDay:01:01",
        "Reference": "Robin Hood",
        "NextPaymentDateTime": "2019-02-01T00:00:00+00:00",
        "NextPaymentAmount": {
          "Amount": "150.00",
          "Currency": "GBP"
        },
        "StandingOrderStatusCode": "Active",
        "CreditorAccount": {
          "SchemeName": "UK.OBIE.SortCodeAccountNumber",
          "Identification": "50506492837451",
          "Name": "Maid Marian"
        }
      },
      {
        "AccountId": "70fdb049-8260-4d53-89c2-0a764e581ac3",
        "StandingOrderId": "290173219",
        "Frequency": "IntrvlMnthDay:01:01",
        "Reference": "Robins Current Account",
        "NextPaymentDateTime": "2019-02-01T00:00:00+00:00",
        "NextPaymentAmount": {
          "Amount": "100.00",
          "Currency": "GBP"
        },
        "StandingOrderStatusCode": "Active",
        "CreditorAccount": {
          "SchemeName": "UK.OBIE.SortCodeAccountNumber",
          "Identification": "08606467451219",
          "Name": "Robin Hood & Maid Marian"
        }
      },
      {
        "AccountId": "70fdb049-8260-4d53-89c2-0a764e581ac3",
        "StandingOrderId": "30001129",
        "Frequency": "IntrvlMnthDay:01:05",
        "Reference": "Robin Hood",
        "NextPaymentDateTime": "2019-02-01T00:00:00+00:00",
        "NextPaymentAmount": {
          "Amount": "100.00",
          "Currency": "GBP"
        },
        "StandingOrderStatusCode": "Active",
        "CreditorAccount": {
          "SchemeName": "UK.OBIE.SortCodeAccountNumber",
          "Identification": "70085681539826",
          "Name": "Little John"
        }
      },
      {
        "AccountId": "70fdb049-8260-4d53-89c2-0a764e581ac3",
        "StandingOrderId": "31083529",
        "Frequency": "IntrvlMnthDay:01:18",
        "Reference": "Robin Hood",
        "NextPaymentDateTime": "2019-01-18T00:00:00+00:00",
        "NextPaymentAmount": {
          "Amount": "50.00",
          "Currency": "GBP"
        },
        "StandingOrderStatusCode": "Inactive",
        "CreditorAccount": {
          "SchemeName": "UK.OBIE.SortCodeAccountNumber",
          "Identification": "60032384281265",
          "Name": "King John"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/aisp/accounts/70fdb049-8260-4d53-89c2-0a764e581ac3/standing-orders/"
  },
  "Meta": []
}

#/definitions/OBReadStandingOrder5OBReadStandingOrder5{

Data*

{

StandingOrder

[#/definitions/OBStandingOrder5OBStandingOrder5{

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

StandingOrderId

string
minLength: 1
maxLength: 40

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

Frequency*

string
minLength: 1
maxLength: 35
pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$

Individual Definitions:
EvryDay - Every day
EvryWorkgDay - Every working day
IntrvlDay - An interval specified in number of calendar days (02 to 31)
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-05 to -01, 01 to 31)
QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED)
ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December.
SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.
RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December.
Individual Patterns:
EvryDay (ScheduleCode)
EvryWorkgDay (ScheduleCode)
IntrvlDay:NoOfDay (ScheduleCode + NoOfDay)
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
EvryDay
EvryWorkgDay
IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1])
IntrvlWkDay:0[1-9]:0[1-7]
WkInMnthDay:0[1-5]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])
QtrDay:(ENGLISH|SCOTTISH|RECEIVED)
Full Regular Expression:
^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$

Reference

string
minLength: 1
maxLength: 35

FirstPaymentDateTime

string($date-time)

The date on which the first payment for a Standing Order schedule will be made.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

NextPaymentDateTime

string($date-time)

The date on which the next payment for a Standing Order schedule will be made.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

FinalPaymentDateTime

string($date-time)

The date on which the final payment for a Standing Order schedule will be made.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

StandingOrderStatusCode

OBExternalStandingOrderStatus1Codestring

Specifies the status of the standing order in code form.

Enum:
[ Active, Inactive ]

FirstPaymentAmount

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	`string` pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

NextPaymentAmount

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	`string` pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

FinalPaymentAmount

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	`string` pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

SupplementaryData

#/definitions/OBSupplementaryData1OBSupplementaryData1{

description:

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

}

CreditorAgent

#/definitions/OBBranchAndFinancialInstitutionIdentification5OBBranchAndFinancialInstitutionIdentification5{

description:	Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
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 the servicing institution.

}

CreditorAccount

#/definitions/OBCashAccount5OBCashAccount5{

description:	Provides the details to identify the beneficiary account.
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 Beneficiary account identification.
Name	`string` minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
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).

}

}]

}

Links*

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`($uri)
First	`string`($uri)
Prev	`string`($uri)
Next	`string`($uri)
Last	`string`($uri)

}

Meta*

#/definitions/MetaMetaData{

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:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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:

Name	Description	Type
Retry-After	Number in seconds to wait	integer

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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

}]

}

Transactions

GET /accounts/{AccountId}/transactions Get Transactions

Details of Virgin Moneys' Proprietary Bank Transaction Codes can be found on the Support page of the developer portal - developer.virginmoney.com

Name	Description
AccountId * string (path)	AccountId
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 Link opens in a new window
fromBookingDateTime string($date-time) (query)	The UTC ISO 8601 Date Time to filter transactions FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. Accepted formats - 2019-08-07T11:48:01+00:00 2019-08-07T11:48:01Z
toBookingDateTime string($date-time) (query)	The UTC ISO 8601 Date Time to filter transactions TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. Accepted formats - 2019-08-07T11:48:01+00:00 2019-08-07T11:48:01Z
x-customer-user-agent string (header)	Indicates the user-agent that the PSU is using.

Responses

Response content type

Code Description

200

Transactions Read

Example Value Model

{
  "Data": {
    "Transaction": [
      {
        "AccountId": "70fdb049-8260-4d53-89c2-0a764e581ac3",
        "TransactionId": "10934709871",
        "Amount": {
          "Amount": "12.50",
          "Currency": "GBP"
        },
        "CreditDebitIndicator": "Debit",
        "Status": "Booked",
        "BookingDateTime": "2019-01-08T00:00:00+00:00",
        "ValueDateTime": "2019-01-08T00:00:00+00:00",
        "TransactionInformation": "Sherwood Council 31987634",
        "ProprietaryBankTransactionCode": {
          "Code": "Payment",
          "Issuer": "VirginMoney"
        },
        "Balance": {
          "Amount": {
            "Amount": "1230.40",
            "Currency": "GBP"
          },
          "CreditDebitIndicator": "Credit",
          "Type": "InterimBooked"
        }
      },
      {
        "AccountId": "70fdb049-8260-4d53-89c2-0a764e581ac3",
        "TransactionId": "76429715251",
        "Amount": {
          "Amount": "85.00",
          "Currency": "GBP"
        },
        "CreditDebitIndicator": "Debit",
        "Status": "Booked",
        "BookingDateTime": "2019-01-09T00:00:00+00:00",
        "ValueDateTime": "2019-01-09T00:00:00+00:00",
        "TransactionInformation": "Friar Tuck Tuck Bill",
        "ProprietaryBankTransactionCode": {
          "Code": "Payment",
          "Issuer": "VirginMoney"
        },
        "Balance": {
          "Amount": {
            "Amount": "1145.40",
            "Currency": "GBP"
          },
          "CreditDebitIndicator": "Debit",
          "Type": "InterimBooked"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://sandbox.virginmoney.com/sandbox/openbanking/open-banking/v3.1/aisp/accounts/70fdb049-8260-4d53-89c2-0a764e581ac3/transactions"
  },
  "Meta": []
}

#/definitions/OBReadTransaction5OBReadTransaction5{

Data*

{

Transaction

[

Provides further details on an entry in the report.

#/definitions/OBTransaction5OBTransaction5{

description:

Provides further details on an entry in the report.

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

TransactionId

string
minLength: 1
maxLength: 210

Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.

TransactionReference

string
minLength: 1
maxLength: 35

Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.

StatementReference

[

Unique reference for the statement. This reference may be optionally populated if available.

string
minLength: 1
maxLength: 35]

CreditDebitIndicator*

string

Indicates whether the transaction is a credit or a debit entry.

Enum:
[ Credit, Debit ]

Status*

OBEntryStatus1Codestring

Status of a transaction entry on the books of the account servicer.

Enum:
[ Booked, Pending ]

BookingDateTime*

string($date-time)

Date and time when a transaction entry is posted to an account on the account servicer's books.
Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

ValueDateTime

string($date-time)

Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry.
Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date.
For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

AddressLine

string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.

Amount*

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	`string` pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

ChargeAmount

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	`string` pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

CurrencyExchange

#/definitions/OBCurrencyExchange5OBCurrencyExchange5{

description:

Set of elements used to provide details on the currency exchange.

SourceCurrency*

string
pattern: ^[A-Z]{3,3}$

Currency from which an amount is to be converted in a currency conversion.

TargetCurrency

string
pattern: ^[A-Z]{3,3}$

Currency from which an amount is to be converted in a currency conversion.

UnitCurrency

string
pattern: ^[A-Z]{3,3}$

Currency from which an amount is to be converted in a currency conversion.

ExchangeRate*

number

Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.
Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).

ContractIdentification

string
minLength: 1
maxLength: 35

Unique identification to unambiguously identify the foreign exchange contract.

QuotationDate

string($date-time)

Date and time at which an exchange rate is quoted.
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

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	`string` pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

BankTransactionCode

#/definitions/OBBankTransactionCodeStructure1OBBankTransactionCodeStructure1{

description:	Set of elements used to fully identify the type of underlying transaction resulting in an entry.
Code*	`string` minLength: 1 maxLength: 4 Specifies the family within a domain.
SubCode*	`string` minLength: 1 maxLength: 4 Specifies the sub-product family within a specific family.

}

ProprietaryBankTransactionCode

{

description:	Set of elements to fully identify a proprietary bank transaction code. See developer.virginmoney.com/support for further details.
Code*	`string` minLength: 1 maxLength: 35 Proprietary bank transaction code to identify the underlying transaction.
Issuer	`string` minLength: 1 maxLength: 35 Identification of the issuer of the proprietary bank transaction code.

}

CardInstrument

#/definitions/OBTransactionCardInstrument1OBTransactionCardInstrument1{

description:	Set of elements to describe the card instrument used in the transaction.
CardSchemeName*	OBExternalCardSchemeType1Code`string` Name of the card scheme. Enum: [ AmericanExpress, Diners, Discover, MasterCard, VISA ]
AuthorisationType	OBExternalCardAuthorisationType1Code`string` The card authorisation type. Enum: [ ConsumerDevice, Contactless, None, PIN ]
Name	`string` minLength: 1 maxLength: 70 Name of the cardholder using the card instrument.
Identification	`string` minLength: 1 maxLength: 34 Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.

}

SupplementaryData

#/definitions/OBSupplementaryData1OBSupplementaryData1{

description:

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

}

TransactionInformation

TransactionInformationstring
minLength: 1
maxLength: 500

Further details of the transaction.
This is the transaction narrative, which is unstructured text.

Balance

#/definitions/OBTransactionCashBalanceOBTransactionCashBalance{

description:	Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
CreditDebitIndicator*	`string` Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance. Enum: [ Credit, Debit ]
Type*	OBBalanceType1Code`string` Balance type, in a coded form. Enum: [ ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked ]
Amount*	#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{...}

}

MerchantDetails

#/definitions/OBMerchantDetails1OBMerchantDetails1{

description:	Details of the merchant involved in the transaction.
MerchantName	`string` minLength: 1 maxLength: 350 Name by which the merchant is known.
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.

}

CreditorAgent

#/definitions/OBBranchAndFinancialInstitutionIdentification6OBBranchAndFinancialInstitutionIdentification6{

description:

Financial institution servicing an account for the debtor.

SchemeName

OBExternalFinancialInstitutionIdentification4Codestring
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/OBPostalAddress6OBPostalAddress6{

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]

}

CreditorAccount

#/definitions/OBCashAccount6OBCashAccount6{

description:	Unambiguous identification of the account of the debtor, in the case of a crebit 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 The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
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).

}

DebtorAgent

#/definitions/OBBranchAndFinancialInstitutionIdentification6OBBranchAndFinancialInstitutionIdentification6{

description:

Financial institution servicing an account for the debtor.

SchemeName

OBExternalFinancialInstitutionIdentification4Codestring
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/OBPostalAddress6OBPostalAddress6{

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]

}

DebtorAccount

#/definitions/OBCashAccount6OBCashAccount6{

description:	Unambiguous identification of the account of the debtor, in the case of a crebit 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 The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
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).

}

}]

}

Links*

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`($uri)
First	`string`($uri)
Prev	`string`($uri)
Next	`string`($uri)
Last	`string`($uri)

}

Meta*

#/definitions/MetaMetaData{

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:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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:

Name	Description	Type
Retry-After	Number in seconds to wait	integer

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

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

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/OBError1OBError1{

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

AccountId

string
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

OBAccount3

OBAccount3{

description:

Unambiguous identification of the account to which credit and debit entries are made.

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

Currency*

string
pattern: ^[A-Z]{3,3}$

AccountType*

OBExternalAccountType1Codestring

Specifies the type of account (personal or business).

Enum:
[ Business, Personal ]

AccountSubType*

OBExternalAccountSubType1Codestring

Specifies the sub type of account (product family group).

Enum:
[ ChargeCard, CreditCard, CurrentAccount, EMoney, Loan, Mortgage, PrePaidCard, Savings ]

Description

string
minLength: 1
maxLength: 35

Specifies the description of the account type.

Nickname

string
minLength: 1
maxLength: 70

The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.

Account

[

Provides the details to identify an account.

#/definitions/OBCashAccount5OBCashAccount5{

description:	Provides the details to identify the beneficiary account.
SchemeName*	OBExternalAccountIdentification4Codestring 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 Beneficiary account identification.
Name	string minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
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).

}]

Servicer

#/definitions/OBBranchAndFinancialInstitutionIdentification5OBBranchAndFinancialInstitutionIdentification5{

description:	Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
SchemeName*	OBExternalFinancialInstitutionIdentification4Codestring 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 the servicing institution.

}

OBAccount3Basic

OBAccount3Basic{

description:	Unambiguous identification of the account to which credit and debit entries are made.
AccountId*	AccountIdstring minLength: 1 maxLength: 40 Account Identification of the customer for Product Details
Currency*	string pattern: ^[A-Z]{3,3}$ Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
AccountType*	OBExternalAccountType1Codestring Specifies the type of account (personal or business). Enum: [ Business, Personal ]
AccountSubType*	OBExternalAccountSubType1Codestring Specifies the sub type of account (product family group). Enum: [ ChargeCard, CreditCard, CurrentAccount, EMoney, Loan, Mortgage, PrePaidCard, Savings ]
Description	string minLength: 1 maxLength: 35 Specifies the description of the account type.
Nickname	string minLength: 1 maxLength: 70 The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.

}

OBAccount3Detail

OBAccount3Detail{

description:

Unambiguous identification of the account to which credit and debit entries are made.

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

Currency*

string
pattern: ^[A-Z]{3,3}$

AccountType*

OBExternalAccountType1Codestring

Specifies the type of account (personal or business).

Enum:
[ Business, Personal ]

AccountSubType*

OBExternalAccountSubType1Codestring

Specifies the sub type of account (product family group).

Enum:
[ ChargeCard, CreditCard, CurrentAccount, EMoney, Loan, Mortgage, PrePaidCard, Savings ]

Description

string
minLength: 1
maxLength: 35

Specifies the description of the account type.

Nickname

string
minLength: 1
maxLength: 70

The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.

Account*

[

Provides the details to identify an account.

#/definitions/OBCashAccount5OBCashAccount5{

description:	Provides the details to identify the beneficiary account.
SchemeName*	OBExternalAccountIdentification4Codestring 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 Beneficiary account identification.
Name	string minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
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).

}]

Servicer

#/definitions/OBBranchAndFinancialInstitutionIdentification5OBBranchAndFinancialInstitutionIdentification5{

description:	Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
SchemeName*	OBExternalFinancialInstitutionIdentification4Codestring 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 the servicing institution.

}

OBActiveCurrencyAndAmount_SimpleType

OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}\.\d{1,5}$

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

OBActiveOrHistoricCurrencyAndAmount

OBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	string pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

OBAddressTypeCode

OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]

BCA

BCA{

ProductDetails

ProductDetails{

Segment	Segment[ title: Segment Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd Link opens in a new window With respect to BCA products, they are segmented in relation to different markets that they wish to focus on. string Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd Link opens in a new window With respect to BCA products, they are segmented in relation to different markets that they wish to focus on. Enum: [ ClientAccount, Standard, NonCommercialChaitiesClbSoc, NonCommercialPublicAuthGovt, Religious, SectorSpecific, Startup, Switcher ]]
FeeFreeLength	number($float) title: FeeFreeLength The length/duration of the fee free period
FeeFreeLengthPeriod	string title: FeeFreeLengthPeriod The unit of period (days, weeks, months etc.) of the promotional length Enum: [ Day, Half Year, Month, Quarter, Week, Year ]
Notes	Notes[ title: Notes Optional additional notes to supplement the Core product details string minLength: 1 maxLength: 2000 maxLength 2000 text ]

}

CreditInterest

CreditInterest{

description:

Details about the interest that may be payable to the BCA account holders

TierBandSet*

TierBandSet[
title: TierBandSet
additionalProperties: false
minItems: 1

The group of tiers or bands for which credit interest can be applied.

{

description:

The group of tiers or bands for which credit interest can be applied.

TierBandMethod*

string
title: TierBandMethod

The methodology of how credit interest is paid/applied. It can be:-

Banded
Interest rates are banded. i.e. Increasing rate on whole balance as balance increases.
Tiered
Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.
Whole
The same interest rate is applied irrespective of the BCA balance

Enum:
[ Banded, Tiered, Whole ]

CalculationMethod

string
title: CalculationMethod

Methods of calculating interest

Enum:
[ Compound, SimpleInterest ]

Destination*

string
title: Destination

Describes whether accrued interest is payable only to the BCA or to another bank account

Enum:
[ PayAway, SelfCredit ]

Notes

Notes[
title: Notes

Optional additional notes to supplement the Tier Band Set details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

TierBand*

TierBand[
title: TierBand
additionalProperties: false
minItems: 1

Tier Band Details

{

description:

Tier Band Details

Identification

string
title: Identification
minLength: 1
maxLength: 35

Unique and unambiguous identification of a Tier Band for a BCA.

TierValueMinimum*

string
title: TierValueMinimum
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Minimum deposit value for which the credit interest tier applies.

TierValueMaximum

string
title: TierValueMaximum
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Maximum deposit value for which the credit interest tier applies.

CalculationFrequency

string
title: CalculationFrequency

How often is credit interest calculated for the account.

Enum:
[ Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly ]

ApplicationFrequency*

string
title: ApplicationFrequency

How often is interest applied to the BCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's BCA.

Enum:
[ Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly ]

DepositInterestAppliedCoverage

string
title: DepositInterestAppliedCoverage

Amount on which Interest applied.

Enum:
[ Banded, Tiered, Whole ]

FixedVariableInterestRateType*

string
title: FixedVariableInterestRateType

Type of interest rate, Fixed or Variable

Enum:
[ Fixed, Variable ]

AER*

string
title: AER
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made.

Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A Link opens in a new window

BankInterestRateType

string
title: BankInterestRateType

Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the BCA.

Enum:
[ Gross, Other ]

BankInterestRate

string
title: BankInterestRate
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Bank Interest for the BCA product

Notes

Notes[
title: Notes

Optional additional notes to supplement the Tier Band details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherBankInterestType

OtherBankInterestType{

description:	Other interest rate types which are not available in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherApplicationFrequency

OtherApplicationFrequency{

description:	Other application frequencies that are not available in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherCalculationFrequency

OtherCalculationFrequency{

description:	Other calculation frequency which is not available in the standard code set.
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

}]

}

Overdraft

Overdraft{

description:

Borrowing details

Notes

Notes[
title: Notes

Associated Notes about the overdraft rates

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftTierBandSet*

OverdraftTierBandSet[
title: OverdraftTierBandSet
additionalProperties: false
minItems: 1

Tier band set details

{

description:

Tier band set details

TierBandMethod*

string
title: TierBandMethod

The methodology of how overdraft is charged. It can be:
'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable).
'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation
'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation.

Enum:
[ Banded, Tiered, Whole ]

OverdraftType

string
title: OverdraftType

An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time.

Enum:
[ Committed, OnDemand ]

Identification

string
title: Identification
minLength: 1
maxLength: 35

Unique and unambiguous identification of a Tier Band for a overdraft product.

AuthorisedIndicator

boolean
title: AuthorisedIndicator

Indicates if the Overdraft is authorised (Y) or unauthorised (N)

BufferAmount

string
title: BufferAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.

Notes

Notes[
title: Notes

Optional additional notes to supplement the overdraft Tier Band Set details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftTierBand*

OverdraftTierBand[
title: OverdraftTierBand
additionalProperties: false
minItems: 1

Provides overdraft details for a specific tier or band

{

description:

Provides overdraft details for a specific tier or band

Identification

string
title: Identification
minLength: 1
maxLength: 35

Unique and unambiguous identification of a Tier Band for a overdraft.

TierValueMin*

string
title: TierValueMin
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Minimum value of Overdraft Tier/Band

TierValueMax

string
title: TierValueMax
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Maximum value of Overdraft Tier/Band

EAR

string
title: EAR
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently
used interchangeably), being the actual annual interest rate of an Overdraft.

AgreementLengthMin

number($float)
title: AgreementLengthMin

Specifies the minimum length of a band for a fixed overdraft agreement

AgreementLengthMax

number($float)
title: AgreementLengthMax

Specifies the maximum length of a band for a fixed overdraft agreement

AgreementPeriod

string
title: AgreementPeriod

Specifies the period of a fixed length overdraft agreement

Enum:
[ Day, Half Year, Month, Quarter, Week, Year ]

OverdraftInterestChargingCoverage

string
title: OverdraftInterestChargingCoverage

Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is £2k and the interest tiers are:- 0-£500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1%500)+(0.2%500)+(0.5%1000). In the 1st situation, we say the interest is applied to the ‘Whole’ of the account balance, and in the 2nd that it is ‘Tiered’.

Enum:
[ Banded, Tiered, Whole ]

BankGuaranteedIndicator

boolean
title: BankGuaranteedIndicator

Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.

Notes

Notes[
title: Notes

Optional additional notes to supplement the Tier/band details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftFeesCharges

OverdraftFeesCharges[
title: OverdraftFeesCharges
additionalProperties: false

Overdraft fees and charges

{

description:

Overdraft fees and charges

OverdraftFeeChargeCap

OverdraftFeeChargeCap[
title: OverdraftFeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Overdraft fee type

Enum:
[ ArrangedOverdraft, AnnualReview, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans ]]

MinMaxType*

string
title: MinMaxType

Min Max type

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Notes related to Overdraft fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

OverdraftFeeChargeDetail*

OverdraftFeeChargeDetail[
title: OverdraftFeeChargeDetail
additionalProperties: false
minItems: 1

Details about the fees/charges

{

description:

Details about the fees/charges

FeeType*

string
title: FeeType

Overdraft fee type

NegotiableIndicator

boolean
title: NegotiableIndicator

Indicates whether fee and charges are negotiable

OverdraftControlIndicator

boolean
title: OverdraftControlIndicator

Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.

IncrementalBorrowingAmount

string
title: IncrementalBorrowingAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Every additional tranche of an overdraft balance to which an overdraft fee is applied

FeeAmount

string
title: FeeAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)

FeeRate

string
title: FeeRate
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)

FeeRateType

string
title: FeeRateType

Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)

Enum:
[ Gross, Other ]

ApplicationFrequency*

string
title: ApplicationFrequency

Frequency at which the overdraft charge is applied to the account

Enum:
[ OnClosing, OnOpening, ChargingPeriod, Daily, PerItem, Monthly, OnAnniversary, Other, PerHundredPounds, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly ]

CalculationFrequency

string
title: CalculationFrequency

How often is the overdraft fee/charge calculated for the account.

Notes

Notes[
title: Notes

Free text for capturing any other info related to Overdraft Fees Charge Details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftFeeChargeCap

OverdraftFeeChargeCap[
title: OverdraftFeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Overdraft fee type

MinMaxType*

string
title: MinMaxType

Min Max type

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Notes related to Overdraft fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

OtherFeeType

OtherFeeType{

description:	Other Fee type which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherFeeRateType

OtherFeeRateType{

description:	Other fee rate type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherApplicationFrequency

OtherApplicationFrequency{

description:	Other application frequencies that are not available in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherCalculationFrequency

OtherCalculationFrequency{

description:	Other calculation frequency which is not available in the standard code set.
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

}]

OverdraftFeesCharges

OverdraftFeesCharges[
title: OverdraftFeesCharges
additionalProperties: false

Overdraft fees and charges details

{

description:

Overdraft fees and charges details

OverdraftFeeChargeCap

OverdraftFeeChargeCap[
title: OverdraftFeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Overdraft fee type

MinMaxType*

string
title: MinMaxType

Min Max type

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Notes related to Overdraft fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

OverdraftFeeChargeDetail*

OverdraftFeeChargeDetail[
title: OverdraftFeeChargeDetail
additionalProperties: false
minItems: 1

Details about the fees/charges

{

description:

Details about the fees/charges

FeeType*

string
title: FeeType

Overdraft fee type

NegotiableIndicator

boolean
title: NegotiableIndicator

Indicates whether fee and charges are negotiable

OverdraftControlIndicator

boolean
title: OverdraftControlIndicator

Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.

IncrementalBorrowingAmount

string
title: IncrementalBorrowingAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Every additional tranche of an overdraft balance to which an overdraft fee is applied

FeeAmount

string
title: FeeAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)

FeeRate

string
title: FeeRate
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)

FeeRateType

string
title: FeeRateType

Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)

Enum:
[ Gross, Other ]

ApplicationFrequency*

string
title: ApplicationFrequency

Frequency at which the overdraft charge is applied to the account

Enum:
Array [ 20 ]

CalculationFrequency

string
title: CalculationFrequency

How often is the overdraft fee/charge calculated for the account.

Notes

Notes[
title: Notes

Free text for capturing any other info related to Overdraft Fees Charge Details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftFeeChargeCap

OverdraftFeeChargeCap[
title: OverdraftFeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Overdraft fee type

MinMaxType*

string
title: MinMaxType

Min Max type

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Notes related to Overdraft fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

OtherFeeType

OtherFeeType{

description:	Other Fee type which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherFeeRateType

OtherFeeRateType{

description:	Other fee rate type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherApplicationFrequency

OtherApplicationFrequency{

description:	Other application frequencies that are not available in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherCalculationFrequency

OtherCalculationFrequency{

description:	Other calculation frequency which is not available in the standard code set.
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

}]

}

OtherFeesCharges

OtherFeesCharges[
title: OtherFeesCharges
additionalProperties: false

Contains details of fees and charges which are not associated with either Overdraft or features/benefits

{

description:

Contains details of fees and charges which are not associated with either Overdraft or features/benefits

TariffType

string
title: TariffType

TariffType which defines the fee and charges.

Enum:
[ Electronic, Mixed, Other ]

TariffName

string
title: TariffName
minLength: 1
maxLength: 350

Name of the tariff

OtherTariffType

OtherTariffType{

description:	Other tariff type which is not in the standard list.
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

FeeChargeDetail*

FeeChargeDetail[
title: FeeChargeDetail
additionalProperties: false
minItems: 1

Other fees/charges details

{

description:

Other fees/charges details

FeeCategory*

string
title: FeeCategory

Categorisation of fees and charges into standard categories.

Enum:
[ Other, Servicing ]

FeeType*

string
title: FeeType

Fee/Charge Type

Enum:
[ Other, ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCAccountFeeQuarterly, ServiceCFixedTariff, ServiceCBusiDepAccBreakage, ServiceCMinimumMonthlyFee, ServiceCOther ]

NegotiableIndicator

boolean
title: NegotiableIndicator

Fee/charge which is usually negotiable rather than a fixed amount

FeeAmount

string
title: FeeAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)

FeeRate

string
title: FeeRate
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)

FeeRateType

string
title: FeeRateType

Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)

Enum:
[ Gross, Other ]

ApplicationFrequency*

string
title: ApplicationFrequency

How frequently the fee/charge is applied to the account

CalculationFrequency

string
title: CalculationFrequency

How frequently the fee/charge is calculated

Notes

Notes[
title: Notes

Optional additional notes to supplement the fee/charge details.

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

FeeChargeCap

FeeChargeCap[
title: FeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular or group of fee/charge

{

description:

Details about any caps (maximum charges) that apply to a particular or group of fee/charge

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Fee/charge type which is being capped

Enum:
[ Other, ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCAccountFeeQuarterly, ServiceCFixedTariff, ServiceCBusiDepAccBreakage, ServiceCMinimumMonthlyFee, ServiceCOther ]]

MinMaxType*

string
title: MinMaxType

Min Max type

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Free text for adding extra details for fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

OtherFeeCategoryType

OtherFeeCategoryType{

Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherFeeType

OtherFeeType{

description:	Other Fee/charge type which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
FeeCategory*	string title: FeeCategory Categorisation of fees and charges into standard categories. Enum: Array [ 2 ]
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherFeeRateType

OtherFeeRateType{

description:	Other fee rate type which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherApplicationFrequency

OtherApplicationFrequency{

description:	Other application frequencies not covered in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherCalculationFrequency

OtherCalculationFrequency{

description:	Other calculation frequency which is not available in standard code set.
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

FeeApplicableRange

FeeApplicableRange{

description:	Range or amounts or rates for which the fee/charge applies
MinimumAmount	string title: MinimumAmount pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Minimum Amount on which fee/charge is applicable (where it is expressed as an amount)
MaximumAmount	string title: MaximumAmount pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Maximum Amount on which fee is applicable (where it is expressed as an amount)
MinimumRate	string title: MinimumRate pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Minimum rate on which fee/charge is applicable(where it is expressed as an rate)
MaximumRate	string title: MaximumRate pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Maximum rate on which fee/charge is applicable(where it is expressed as an rate)

}

}]

FeeChargeCap

FeeChargeCap[
title: FeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular or group of fee/charge

{

description:

Details about any caps (maximum charges) that apply to a particular or group of fee/charge

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Fee/charge type which is being capped

Enum:
[ Other, ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCAccountFeeQuarterly, ServiceCFixedTariff, ServiceCBusiDepAccBreakage, ServiceCMinimumMonthlyFee, ServiceCOther ]]

MinMaxType*

string
title: MinMaxType

Min Max type

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Free text for adding extra details for fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

}

OBBalanceType1Code

BCA{...}

OBBankTransactionCodeStructure1

OBBankTransactionCodeStructure1{

description:	Set of elements used to fully identify the type of underlying transaction resulting in an entry.
Code*	string minLength: 1 maxLength: 4 Specifies the family within a domain.
SubCode*	string minLength: 1 maxLength: 4 Specifies the sub-product family within a specific family.

}

OBBeneficiary3

OBBeneficiary3{

AccountId

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

BeneficiaryId

string
minLength: 1
maxLength: 40

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

Reference

string
minLength: 1
maxLength: 35

CreditorAgent

#/definitions/OBBranchAndFinancialInstitutionIdentification6OBBranchAndFinancialInstitutionIdentification6{

description:

Financial institution servicing an account for the debtor.

SchemeName

OBExternalFinancialInstitutionIdentification4Codestring
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/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring 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]

}

CreditorAccount

#/definitions/OBCashAccount5OBCashAccount5{

description:	Provides the details to identify the beneficiary account.
SchemeName*	OBExternalAccountIdentification4Codestring 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 Beneficiary account identification.
Name	string minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
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).

}

OBBeneficiary3Basic

OBBeneficiary3Basic{

AccountId	AccountIdstring minLength: 1 maxLength: 40 Account Identification of the customer for Product Details
BeneficiaryId	string minLength: 1 maxLength: 40 A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
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.

}

OBBeneficiary3Detail

OBBeneficiary3Detail{

AccountId

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

BeneficiaryId

string
minLength: 1
maxLength: 40

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

Reference

string
minLength: 1
maxLength: 35

CreditorAgent

#/definitions/OBBranchAndFinancialInstitutionIdentification6OBBranchAndFinancialInstitutionIdentification6{

description:

Financial institution servicing an account for the debtor.

SchemeName

OBExternalFinancialInstitutionIdentification4Codestring
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/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring 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]

}

CreditorAccount*

#/definitions/OBCashAccount5OBCashAccount5{

description:	Provides the details to identify the beneficiary account.
SchemeName*	OBExternalAccountIdentification4Codestring 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 Beneficiary account identification.
Name	string minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
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).

}

OBCashBalance1

OBCashBalance1{

description:

Set of elements used to define the balance details.

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

CreditDebitIndicator*

string

Indicates whether the balance is a credit or a debit balance.
Usage: A zero balance is considered to be a credit balance.

Enum:
[ Credit, Debit ]

Type*

OBBalanceType1Codestring

Balance type, in a coded form.

DateTime*

string($date-time)

Amount*

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	string pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

CreditLine

[

Set of elements used to provide details on the credit line.

#/definitions/OBCreditLine1OBCreditLine1{

description:

Set of elements used to provide details on the credit line.

Included*

boolean

Indicates whether or not the credit line is included in the balance of the account.
Usage: If not present, credit line is not included in the balance amount of the account.

Type

OBExternalLimitType1Codestring

Limit type, in a coded form.

Enum:
[ Available, Credit, Emergency, Pre-Agreed, Temporary ]

Amount

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	string pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

}]

}

OBCreditDebitCode

OBCreditDebitCodestringEnum:
[ Credit, Debit ]

OBCreditLine1

OBCreditLine1{

description:

Set of elements used to provide details on the credit line.

Included*

boolean

Indicates whether or not the credit line is included in the balance of the account.
Usage: If not present, credit line is not included in the balance amount of the account.

Type

OBExternalLimitType1Codestring

Limit type, in a coded form.

Enum:
[ Available, Credit, Emergency, Pre-Agreed, Temporary ]

Amount

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	string pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

OBCurrencyExchange5

OBCurrencyExchange5{

description:

Set of elements used to provide details on the currency exchange.

SourceCurrency*

string
pattern: ^[A-Z]{3,3}$

Currency from which an amount is to be converted in a currency conversion.

TargetCurrency

string
pattern: ^[A-Z]{3,3}$

Currency from which an amount is to be converted in a currency conversion.

UnitCurrency

string
pattern: ^[A-Z]{3,3}$

Currency from which an amount is to be converted in a currency conversion.

ExchangeRate*

number

ContractIdentification

string
minLength: 1
maxLength: 35

Unique identification to unambiguously identify the foreign exchange contract.

QuotationDate

string($date-time)

InstructedAmount

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	string pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

OBDirectDebit1

OBDirectDebit1{

description:

Account to or from which a cash entry is made.

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

DirectDebitId

string
minLength: 1
maxLength: 40

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

MandateIdentification*

string
minLength: 1
maxLength: 35

Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.

DirectDebitStatusCode

OBExternalDirectDebitStatus1Codestring

Specifies the status of the direct debit in code form.

Enum:
[ Active, Inactive ]

Name*

string
minLength: 1
maxLength: 70

Name of Service User.

PreviousPaymentDateTime

string($date-time)

PreviousPaymentAmount

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	string pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

OBEntryStatus1Code

OBEntryStatus1Codestring

Status of a transaction entry on the books of the account servicer.

Enum:
[ Booked, Pending ]

OBExternalAccountRole1Code

OBExternalAccountRole1Codestring
example: List [ "UK.OBIE.Administrator", "UK.OBIE.Beneficiary", "UK.OBIE.CustodianForMinor", "UK.OBIE.Granter", "UK.OBIE.LegalGuardian", "UK.OBIE.OtherParty", "UK.OBIE.PowerOfAttorney", "UK.OBIE.Principal", "UK.OBIE.Protector", "UK.OBIE.RegisteredShareholderName", "UK.OBIE.SecondaryOwner", "UK.OBIE.SeniorManagingOfficial", "UK.OBIE.Settlor", "UK.OBIE.SuccessorOnDeath" ]
minLength: 1
maxLength: 70

A party’s role with respect to the related account.

OBExternalAccountSubType1Code

OBExternalAccountSubType1Codestring

Specifies the sub type of account (product family group).

Enum:
[ ChargeCard, CreditCard, CurrentAccount, EMoney, Loan, Mortgage, PrePaidCard, Savings ]

OBExternalAccountType1Code

OBExternalAccountType1Codestring

Specifies the type of account (personal or business).

Enum:
[ Business, Personal ]

OBExternalCardAuthorisationType1Code

OBExternalCardAuthorisationType1Codestring

The card authorisation type.

Enum:
[ ConsumerDevice, Contactless, None, PIN ]

OBExternalCardSchemeType1Code

OBExternalCardSchemeType1Codestring

Name of the card scheme.

Enum:
[ AmericanExpress, Diners, Discover, MasterCard, VISA ]

OBExternalDirectDebitStatus1Code

OBExternalDirectDebitStatus1Codestring

Specifies the status of the direct debit in code form.

Enum:
[ Active, Inactive ]

OBExternalLimitType1Code

OBExternalLimitType1Codestring

Limit type, in a coded form.

Enum:
[ Available, Credit, Emergency, Pre-Agreed, Temporary ]

OBExternalLegalStructureType1Code

OBExternalLegalStructureType1Codestring
example: List [ "UK.OBIE.CIC", "UK.OBIE.CIO", "UK.OBIE.Charity", "UK.OBIE.CoOp", "UK.OBIE.GeneralPartnership", "UK.OBIE.Individual", "UK.OBIE.LimitedLiabilityPartnership", "UK.OBIE.LimitedPartnership", "UK.OBIE.PrivateLimitedCompany", "UK.OBIE.PublicLimitedCompany", "UK.OBIE.ScottishLimitedPartnership", "UK.OBIE.Sole" ]
minLength: 1
maxLength: 70

Legal standing of the party.

OBExternalOfferType1Code

OBExternalOfferType1Codestring

Offer type, in a coded form.

Enum:
[ BalanceTransfer, LimitIncrease, MoneyTransfer, Other, PromotionalRate ]

OBExternalPartyType1Code

OBExternalPartyType1Codestring

Party type, in a coded form.

Enum:
[ Delegate, Joint, Sole ]

OBExternalPermissions1Code

OBExternalPermissions1Codestring

Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.

Enum:
[ ReadAccountsBasic, ReadAccountsDetail, ReadBalances, ReadBeneficiariesBasic, ReadBeneficiariesDetail, ReadDirectDebits, ReadOffers, ReadPAN, ReadParty, ReadPartyPSU, ReadProducts, ReadScheduledPaymentsBasic, ReadScheduledPaymentsDetail, ReadStandingOrdersBasic, ReadStandingOrdersDetail, ReadStatementsBasic, ReadStatementsDetail, ReadTransactionsBasic, ReadTransactionsCredits, ReadTransactionsDebits, ReadTransactionsDetail ]

OBExternalProductType1Code

OBExternalProductType1Codestring

Product type : Personal Current Account, Business Current Account

Enum:
[ BusinessCurrentAccount, CommercialCreditCard, Other, PersonalCurrentAccount, SMELoan ]

OBExternalRequestStatus1Code

OBExternalRequestStatus1Codestring

Specifies the status of consent resource in code form.

Enum:
[ Authorised, AwaitingAuthorisation, Rejected, Revoked ]

OBExternalScheduleType1Code

OBExternalScheduleType1Codestring

Specifies the scheduled payment date type requested

Enum:
[ Arrival, Execution ]

OBExternalStandingOrderStatus1Code

OBExternalStandingOrderStatus1Codestring

Specifies the status of the standing order in code form.

Enum:
[ Active, Inactive ]

OBExternalStatementType1Code

OBExternalStatementType1Codestring

Statement type, in a coded form.

Enum:
[ AccountClosure, AccountOpening, Annual, Interim, RegularPeriodic ]

OBMerchantDetails1

OBMerchantDetails1{

description:	Details of the merchant involved in the transaction.
MerchantName	string minLength: 1 maxLength: 350 Name by which the merchant is known.
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.

}

OBOffer1

OBOffer1{

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

OfferId

string
minLength: 1
maxLength: 40

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

OfferType

OBExternalOfferType1Codestring

Offer type, in a coded form.

Enum:
[ BalanceTransfer, LimitIncrease, MoneyTransfer, Other, PromotionalRate ]

Description

string
minLength: 1
maxLength: 500

Further details of the offer.

StartDateTime

string($date-time)

EndDateTime

string($date-time)

Rate

string
minLength: 1
maxLength: 10
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Rate associated with the offer type.

Value

integer($int32)

Value associated with the offer type.

Term

string
minLength: 1
maxLength: 500

Further details of the term of the offer.

URL

string
minLength: 1
maxLength: 256

URL (Uniform Resource Locator) where documentation on the offer can be found

Amount

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	string pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

Fee

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money of the cash balance after a transaction entry is applied to the account..
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring pattern: ^\d{1,13}\.\d{1,5}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	string pattern: ^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

PCA

PCA{

ProductDetails

ProductDetails{

Segment	Segment[ title: Segment Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd Link opens in a new window With respect to PCA products, they are segmented in relation to different markets that they wish to focus on. string Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd Link opens in a new window With respect to PCA products, they are segmented in relation to different markets that they wish to focus on. Enum: [ Basic, BenefitAndReward, CreditInterest, Cashback, General, Graduate, Other, Overdraft, Packaged, Premium, Reward, Student, YoungAdult, Youth ]]
MonthlyMaximumCharge	string title: MonthlyMaximumCharge pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order
Notes	Notes[ title: Notes Optional additional notes to supplement the Core product details string minLength: 1 maxLength: 2000 maxLength 2000 text ]

}

CreditInterest

CreditInterest{

description:

Details about the interest that may be payable to the PCA account holders

TierBandSet*

TierBandSet[
title: TierBandSet
additionalProperties: false
minItems: 1

The group of tiers or bands for which credit interest can be applied.

{

description:

The group of tiers or bands for which credit interest can be applied.

TierBandMethod*

string
title: TierBandMethod

The methodology of how credit interest is charged. It can be:-

Banded
Interest rates are banded. i.e. Increasing rate on whole balance as balance increases.
Tiered
Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.
Whole
The same interest rate is applied irrespective of the PCA balance

Enum:
[ Tiered, Whole ]

CalculationMethod

string
title: CalculationMethod

Methods of calculating interest

Enum:
[ Compound, SimpleInterest ]

Destination

string
title: Destination

Describes whether accrued interest is payable only to the PCA or to another bank account

Enum:
[ PayAway, SelfCredit ]

Notes

Notes[
title: Notes

Optional additional notes to supplement the Tier Band Set details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

TierBand*

TierBand[
title: TierBand
additionalProperties: false
minItems: 1

Tier Band Details

{

description:

Tier Band Details

Identification

string
title: Identification
minLength: 1
maxLength: 35

Unique and unambiguous identification of a Tier Band for a PCA.

TierValueMinimum*

string
title: TierValueMinimum
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Minimum deposit value for which the credit interest tier applies.

TierValueMaximum

string
title: TierValueMaximum
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Maximum deposit value for which the credit interest tier applies.

CalculationFrequency

string
title: CalculationFrequency

How often is credit interest calculated for the account.

Enum:
[ PerAcademicTerm, Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly ]

ApplicationFrequency*

string
title: ApplicationFrequency

How often is interest applied to the PCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's PCA.

Enum:
[ PerAcademicTerm, Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly ]

DepositInterestAppliedCoverage

string
title: DepositInterestAppliedCoverage

Amount on which Interest applied.

Enum:
[ Tiered, Whole ]

FixedVariableInterestRateType*

string
title: FixedVariableInterestRateType

Type of interest rate, Fixed or Variable

Enum:
[ Fixed, Variable ]

AER*

string
title: AER
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A Link opens in a new window

BankInterestRateType

string
title: BankInterestRateType

Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the PCA.

Enum:
[ LinkedBaseRate, Gross, Net, Other ]

BankInterestRate

string
title: BankInterestRate
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Bank Interest for the PCA product

Notes

Notes[
title: Notes

Optional additional notes to supplement the Tier Band details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherBankInterestType

OtherBankInterestType{

description:	Other interest rate types which are not available in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherApplicationFrequency

OtherApplicationFrequency{

description:	Other application frequencies that are not available in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherCalculationFrequency

OtherCalculationFrequency{

description:	Other calculation frequency which is not available in the standard code set.
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

}]

}

Overdraft

Overdraft{

description:

Details about Overdraft rates, fees & charges

Notes

Notes[
title: Notes

Associated Notes about the overdraft rates

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftTierBandSet*

OverdraftTierBandSet[
title: OverdraftTierBandSet
additionalProperties: false
minItems: 1

Tier band set details

{

description:

Tier band set details

TierBandMethod*

string
title: TierBandMethod

Enum:
[ Tiered, Whole, Banded ]

OverdraftType

string
title: OverdraftType

Enum:
[ Committed, OnDemand, Other ]

Identification

string
title: Identification
minLength: 1
maxLength: 35

Unique and unambiguous identification of a Tier Band for a overdraft product.

AuthorisedIndicator

boolean
title: AuthorisedIndicator

Indicates if the Overdraft is authorised (Y) or unauthorised (N)

BufferAmount

string
title: BufferAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Notes

Notes[
title: Notes

Optional additional notes to supplement the overdraft Tier Band Set details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftTierBand*

OverdraftTierBand[
title: OverdraftTierBand
additionalProperties: false
minItems: 1

Provides overdraft details for a specific tier or band

{

description:

Provides overdraft details for a specific tier or band

Identification

string
title: Identification
minLength: 1
maxLength: 35

Unique and unambiguous identification of a Tier Band for a overdraft.

TierValueMin*

string
title: TierValueMin
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Minimum value of Overdraft Tier/Band

TierValueMax

string
title: TierValueMax
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Maximum value of Overdraft Tier/Band

OverdraftInterestChargingCoverage

string
title: OverdraftInterestChargingCoverage

Interest charged on whole amount or tiered/banded

Enum:
[ Tiered, Whole ]

BankGuaranteedIndicator

boolean
title: BankGuaranteedIndicator

Indicates that a bank provides the overdraft limit up to TierValueMIn to all customers automatically

EAR

string
title: EAR
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently
used interchangeably), being the actual annual interest rate of an Overdraft.

Notes

Notes[
title: Notes

Optional additional notes to supplement the Tier/band details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftFeesCharges

OverdraftFeesCharges[
title: OverdraftFeesCharges
additionalProperties: false

Overdraft fees and charges

{

description:

Overdraft fees and charges

OverdraftFeeChargeCap

OverdraftFeeChargeCap[
title: OverdraftFeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular fee/charge

{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Overdraft fee type

Enum:
[ ArrangedOverdraft, EmergencyBorrowing, BorrowingItem, OverdraftRenewal, AnnualReview, OverdraftSetup, Surcharge, TempOverdraft, UnauthorisedBorrowing, UnauthorisedPaidTrans, Other, UnauthorisedUnpaidTrans ]]

OverdraftControlIndicator

boolean
title: OverdraftControlIndicator

Specifies for the overdraft control feature/benefit

MinMaxType*

string
title: MinMaxType

Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ AcademicTerm, Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Notes related to Overdraft fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

OverdraftFeeChargeDetail*

OverdraftFeeChargeDetail[
title: OverdraftFeeChargeDetail
additionalProperties: false
minItems: 1

Details about the fees/charges

{

description:

Details about the fees/charges

FeeType*

string
title: FeeType

Overdraft fee type

OverdraftControlIndicator

boolean
title: OverdraftControlIndicator

Specifies for the overdraft control feature/benefit

IncrementalBorrowingAmount

string
title: IncrementalBorrowingAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Every additional tranche of an overdraft balance to which an overdraft fee is applied

FeeAmount

string
title: FeeAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)

FeeRate

string
title: FeeRate
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)

FeeRateType

string
title: FeeRateType

Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)

Enum:
[ LinkedBaseRate, Gross, Net, Other ]

ApplicationFrequency*

string
title: ApplicationFrequency

Frequency at which the overdraft charge is applied to the account

Enum:
[ AccountClosing, AccountOpening, AcademicTerm, ChargingPeriod, Daily, PerItem, Monthly, OnAccountAnniversary, Other, PerHour, PerOccurrence, PerSheet, PerTransaction, PerTransactionAmount, PerTransactionPercentage, Quarterly, SixMonthly, StatementMonthly, Weekly, Yearly ]

CalculationFrequency

string
title: CalculationFrequency

How often is the overdraft fee/charge calculated for the account.

Notes

Notes[
title: Notes

Free text for capturing any other info related to Overdraft Fees Charge Details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType{

description:	Other Fee type which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherFeeRateType

OtherFeeRateType{

description:	Other fee rate type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherApplicationFrequency

OtherApplicationFrequency{

description:	Other application frequencies that are not available in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherCalculationFrequency

OtherCalculationFrequency{

description:	Other calculation frequency which is not available in the standard code set.
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OverdraftFeeChargeCap

OverdraftFeeChargeCap{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Overdraft fee type

OverdraftControlIndicator

boolean
title: OverdraftControlIndicator

Specifies for the overdraft control feature/benefit

MinMaxType*

string
title: MinMaxType

Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ AcademicTerm, Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Notes related to Overdraft fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

}

}]

OverdraftFeesCharges

OverdraftFeesCharges[
title: OverdraftFeesCharges
additionalProperties: false

Overdraft fees and charges details

{

description:

Overdraft fees and charges details

OverdraftFeeChargeCap

OverdraftFeeChargeCap[
title: OverdraftFeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular fee/charge

{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Overdraft fee type

OverdraftControlIndicator

boolean
title: OverdraftControlIndicator

Specifies for the overdraft control feature/benefit

MinMaxType*

string
title: MinMaxType

Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ AcademicTerm, Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Notes related to Overdraft fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

OverdraftFeeChargeDetail*

OverdraftFeeChargeDetail[
title: OverdraftFeeChargeDetail
additionalProperties: false
minItems: 1

Details about the fees/charges

{

description:

Details about the fees/charges

FeeType*

string
title: FeeType

Overdraft fee type

OverdraftControlIndicator

boolean
title: OverdraftControlIndicator

Specifies for the overdraft control feature/benefit

IncrementalBorrowingAmount

string
title: IncrementalBorrowingAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Every additional tranche of an overdraft balance to which an overdraft fee is applied

FeeAmount

string
title: FeeAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)

FeeRate

string
title: FeeRate
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)

FeeRateType

string
title: FeeRateType

Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)

Enum:
[ LinkedBaseRate, Gross, Net, Other ]

ApplicationFrequency*

string
title: ApplicationFrequency

Frequency at which the overdraft charge is applied to the account

CalculationFrequency

string
title: CalculationFrequency

How often is the overdraft fee/charge calculated for the account.

Notes

Notes[
title: Notes

Free text for capturing any other info related to Overdraft Fees Charge Details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType{

description:	Other Fee type which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherFeeRateType

OtherFeeRateType{

description:	Other fee rate type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherApplicationFrequency

OtherApplicationFrequency{

description:	Other application frequencies that are not available in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherCalculationFrequency

OtherCalculationFrequency{

description:	Other calculation frequency which is not available in the standard code set.
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OverdraftFeeChargeCap

OverdraftFeeChargeCap{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Overdraft fee type

OverdraftControlIndicator

boolean
title: OverdraftControlIndicator

Specifies for the overdraft control feature/benefit

MinMaxType*

string
title: MinMaxType

Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ AcademicTerm, Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Notes related to Overdraft fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

}

}]

}

OtherFeesCharges

OtherFeesCharges{

description:

Contains details of fees and charges which are not associated with either borrowing or features/benefits

FeeChargeDetail*

FeeChargeDetail[
title: FeeChargeDetail
additionalProperties: false
minItems: 1

Other fees/charges details

{

description:

Other fees/charges details

FeeCategory*

string
title: FeeCategory

Categorisation of fees and charges into standard categories.

Enum:
[ Other, Servicing ]

FeeType*

string
title: FeeType

Fee/Charge Type

Enum:
[ ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCOther, Other ]

FeeAmount

string
title: FeeAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)

FeeRate

string
title: FeeRate
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)

FeeRateType

string
title: FeeRateType

Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)

Enum:
[ LinkedBaseRate, Gross, Net, Other ]

ApplicationFrequency*

string
title: ApplicationFrequency

How frequently the fee/charge is applied to the account

CalculationFrequency

string
title: CalculationFrequency

How frequently the fee/charge is calculated

Notes

Notes[
title: Notes

Optional additional notes to supplement the fee/charge details.

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeCategoryType

OtherFeeCategoryType{

Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherFeeType

OtherFeeType{

description:	Other Fee/charge type which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
FeeCategory*	string title: FeeCategory Categorisation of fees and charges into standard categories. Enum: [ Other, Servicing ]
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherFeeRateType

OtherFeeRateType{

description:	Other fee rate type which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherApplicationFrequency

OtherApplicationFrequency{

description:	Other application frequencies not covered in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherCalculationFrequency

OtherCalculationFrequency{

description:	Other calculation frequency which is not available in standard code set.
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

FeeChargeCap

FeeChargeCap[
title: FeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular fee/charge

{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Fee/charge type which is being capped

Enum:
[ ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCOther, Other ]]

MinMaxType*

string
title: MinMaxType

Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ AcademicTerm, Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Free text for adding extra details for fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

FeeApplicableRange

FeeApplicableRange{

description:	Range or amounts or rates for which the fee/charge applies
MinimumAmount	string title: MinimumAmount pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Minimum Amount on which fee/charge is applicable (where it is expressed as an amount)
MaximumAmount	string title: MaximumAmount pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Maximum Amount on which fee is applicable (where it is expressed as an amount)
MinimumRate	string title: MinimumRate pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Minimum rate on which fee/charge is applicable(where it is expressed as an rate)
MaximumRate	string title: MaximumRate pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Maximum rate on which fee/charge is applicable(where it is expressed as an rate)

}

}]

FeeChargeCap

FeeChargeCap[
title: FeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular fee/charge

{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Fee/charge type which is being capped

Enum:
[ ServiceCAccountFee, ServiceCAccountFeeMonthly, ServiceCOther, Other ]]

MinMaxType*

string
title: MinMaxType

Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ AcademicTerm, Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Free text for adding extra details for fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

}

OBParty2

OBParty2{

PartyId*

string
minLength: 1
maxLength: 40

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

PartyNumber

string
minLength: 1
maxLength: 35

Number assigned by an agent to identify its customer.

PartyType

OBExternalPartyType1Codestring

Party type, in a coded form.

Enum:
[ Delegate, Joint, Sole ]

Name

string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

FullLegalName

string
minLength: 1
maxLength: 350

The full legal name of the party.

LegalStructure

Legal standing of the party.

BeneficialOwnership

boolean

A flag to indicate a party’s beneficial ownership of the related account.

AccountRole

A party’s role with respect to the related account.

EmailAddress

string
minLength: 1
maxLength: 256

Address for electronic mail (e-mail).

Phone

string
pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}

Collection of information that identifies a phone number, as defined by telecom services.

Mobile

string
pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}

Collection of information that identifies a mobile phone number, as defined by telecom services.

Relationships

#/definitions/OBPartyRelationships1OBPartyRelationships1{

description:

The Party's relationships with other resources.

Account

#/definitions/OBRelationship1OBRelationship1{

description:	Relationship to the Account resource.
Related*	string Absolute URI to the related resource.
Id*	string minLength: 1 maxLength: 40 Unique identification as assigned by the ASPSP to uniquely identify the related resource.

}

Address

[

Postal address of a party.

#/definitions/OBPostalAddress8OBPostalAddress8{

description:	Postal address of a party.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
AddressLine	[ minItems: 0 maxItems: 5 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	string minLength: 1 maxLength: 35 Identifies a subdivision of a country eg, state, region, county.
Country*	string pattern: ^[A-Z]{2,2}$ Nation with its own government, occupying a particular territory.

}]

}

OBPartyRelationships1

OBPartyRelationships1{

description:

The Party's relationships with other resources.

Account

#/definitions/OBRelationship1OBRelationship1{

description:	Relationship to the Account resource.
Related*	string Absolute URI to the related resource.
Id*	string minLength: 1 maxLength: 40 Unique identification as assigned by the ASPSP to uniquely identify the related resource.

}

OBPostalAddress6

OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring 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]

}

OBPostalAddress8

OBPostalAddress8{

description:	Postal address of a party.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
AddressLine	[ minItems: 0 maxItems: 5 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	string minLength: 1 maxLength: 35 Identifies a subdivision of a country eg, state, region, county.
Country*	string pattern: ^[A-Z]{2,2}$ Nation with its own government, occupying a particular territory.

}

OBProduct2

OBProduct2{

ProductName

string
minLength: 1
maxLength: 350

The name of the product used for marketing purposes from a customer perspective. I.e. what the customer would recognise.

ProductId

string
minLength: 1
maxLength: 40

Identifier within the parent organisation for the product. Must be unique in the organisation.

AccountId*

AccountIdstring
minLength: 1
maxLength: 40

Account Identification of the customer for Product Details

SecondaryProductId

string
minLength: 1
maxLength: 70

Identifier within the parent organisation for the product. Must be unique in the organisation.

ProductType

OBExternalProductType1Codestring

Product type : Personal Current Account, Business Current Account

Enum:
[ BusinessCurrentAccount, CommercialCreditCard, Other, PersonalCurrentAccount, SMELoan ]

MarketingStateId

string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a Product Marketing State.

OtherProductType

#/definitions/OBOtherProductType1OBOtherProductType1{

description:	This field provides extension to the ProductType enumeration. If ProductType - "Other" is chosen, this field must be populated with name, and description for ASPSP specific product type.
Name*	string minLength: 1 maxLength: 350 Name of "Other" product type.
Description*	string minLength: 1 maxLength: 350 Description of "Other" product type.

}

BCA

#/definitions/OBBCAData1BCA{

ProductDetails

ProductDetails{

Segment	Segment[ title: Segment Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd Link opens in a new window With respect to BCA products, they are segmented in relation to different markets that they wish to focus on. string Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd Link opens in a new window With respect to BCA products, they are segmented in relation to different markets that they wish to focus on. Enum: [ ClientAccount, Standard, NonCommercialChaitiesClbSoc, NonCommercialPublicAuthGovt, Religious, SectorSpecific, Startup, Switcher ]]
FeeFreeLength	number($float) title: FeeFreeLength The length/duration of the fee free period
FeeFreeLengthPeriod	string title: FeeFreeLengthPeriod The unit of period (days, weeks, months etc.) of the promotional length Enum: [ Day, Half Year, Month, Quarter, Week, Year ]
Notes	Notes[ title: Notes Optional additional notes to supplement the Core product details string minLength: 1 maxLength: 2000 maxLength 2000 text ]

}

CreditInterest

CreditInterest{

description:

Details about the interest that may be payable to the BCA account holders

TierBandSet*

TierBandSet[
title: TierBandSet
additionalProperties: false
minItems: 1

The group of tiers or bands for which credit interest can be applied.

{

description:

The group of tiers or bands for which credit interest can be applied.

TierBandMethod*

string
title: TierBandMethod

The methodology of how credit interest is paid/applied. It can be:-

Banded
Interest rates are banded. i.e. Increasing rate on whole balance as balance increases.
Tiered
Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.
Whole
The same interest rate is applied irrespective of the BCA balance

Enum:
[ Banded, Tiered, Whole ]

CalculationMethod

string
title: CalculationMethod

Methods of calculating interest

Enum:
[ Compound, SimpleInterest ]

Destination*

string
title: Destination

Describes whether accrued interest is payable only to the BCA or to another bank account

Enum:
[ PayAway, SelfCredit ]

Notes

Notes[
title: Notes

Optional additional notes to supplement the Tier Band Set details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

TierBand*

TierBand[
title: TierBand
additionalProperties: false
minItems: 1

Tier Band Details

{

description:

Tier Band Details

Identification

string
title: Identification
minLength: 1
maxLength: 35

Unique and unambiguous identification of a Tier Band for a BCA.

TierValueMinimum*

string
title: TierValueMinimum
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Minimum deposit value for which the credit interest tier applies.

TierValueMaximum

string
title: TierValueMaximum
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Maximum deposit value for which the credit interest tier applies.

CalculationFrequency

string
title: CalculationFrequency

How often is credit interest calculated for the account.

Enum:
[ Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly ]

ApplicationFrequency*

string
title: ApplicationFrequency

How often is interest applied to the BCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's BCA.

Enum:
[ Daily, HalfYearly, Monthly, Other, Quarterly, PerStatementDate, Weekly, Yearly ]

DepositInterestAppliedCoverage

string
title: DepositInterestAppliedCoverage

Amount on which Interest applied.

Enum:
[ Banded, Tiered, Whole ]

FixedVariableInterestRateType*

string
title: FixedVariableInterestRateType

Type of interest rate, Fixed or Variable

Enum:
[ Fixed, Variable ]

AER*

string
title: AER
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A Link opens in a new window

BankInterestRateType

string
title: BankInterestRateType

Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the BCA.

Enum:
[ Gross, Other ]

BankInterestRate

string
title: BankInterestRate
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Bank Interest for the BCA product

Notes

Notes[
title: Notes

Optional additional notes to supplement the Tier Band details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherBankInterestType

OtherBankInterestType{

description:	Other interest rate types which are not available in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherApplicationFrequency

OtherApplicationFrequency{

description:	Other application frequencies that are not available in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherCalculationFrequency

OtherCalculationFrequency{

description:	Other calculation frequency which is not available in the standard code set.
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

}]

}

Overdraft

Overdraft{

description:

Borrowing details

Notes

Notes[
title: Notes

Associated Notes about the overdraft rates

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftTierBandSet*

OverdraftTierBandSet[
title: OverdraftTierBandSet
additionalProperties: false
minItems: 1

Tier band set details

{

description:

Tier band set details

TierBandMethod*

string
title: TierBandMethod

Enum:
[ Banded, Tiered, Whole ]

OverdraftType

string
title: OverdraftType

Enum:
[ Committed, OnDemand ]

Identification

string
title: Identification
minLength: 1
maxLength: 35

Unique and unambiguous identification of a Tier Band for a overdraft product.

AuthorisedIndicator

boolean
title: AuthorisedIndicator

Indicates if the Overdraft is authorised (Y) or unauthorised (N)

BufferAmount

string
title: BufferAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Notes

Notes[
title: Notes

Optional additional notes to supplement the overdraft Tier Band Set details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftTierBand*

OverdraftTierBand[
title: OverdraftTierBand
additionalProperties: false
minItems: 1

Provides overdraft details for a specific tier or band

{

description:

Provides overdraft details for a specific tier or band

Identification

string
title: Identification
minLength: 1
maxLength: 35

Unique and unambiguous identification of a Tier Band for a overdraft.

TierValueMin*

string
title: TierValueMin
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Minimum value of Overdraft Tier/Band

TierValueMax

string
title: TierValueMax
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Maximum value of Overdraft Tier/Band

EAR

string
title: EAR
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently
used interchangeably), being the actual annual interest rate of an Overdraft.

AgreementLengthMin

number($float)
title: AgreementLengthMin

Specifies the minimum length of a band for a fixed overdraft agreement

AgreementLengthMax

number($float)
title: AgreementLengthMax

Specifies the maximum length of a band for a fixed overdraft agreement

AgreementPeriod

string
title: AgreementPeriod

Specifies the period of a fixed length overdraft agreement

Enum:
[ Day, Half Year, Month, Quarter, Week, Year ]

OverdraftInterestChargingCoverage

string
title: OverdraftInterestChargingCoverage

Enum:
[ Banded, Tiered, Whole ]

BankGuaranteedIndicator

boolean
title: BankGuaranteedIndicator

Notes

Notes[
title: Notes

Optional additional notes to supplement the Tier/band details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftFeesCharges

OverdraftFeesCharges[
title: OverdraftFeesCharges
additionalProperties: false

Overdraft fees and charges

{

description:

Overdraft fees and charges

OverdraftFeeChargeCap

OverdraftFeeChargeCap[
title: OverdraftFeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Overdraft fee type

MinMaxType*

string
title: MinMaxType

Min Max type

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Notes related to Overdraft fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

OverdraftFeeChargeDetail*

OverdraftFeeChargeDetail[
title: OverdraftFeeChargeDetail
additionalProperties: false
minItems: 1

Details about the fees/charges

{

description:

Details about the fees/charges

FeeType*

string
title: FeeType

Overdraft fee type

NegotiableIndicator

boolean
title: NegotiableIndicator

Indicates whether fee and charges are negotiable

OverdraftControlIndicator

boolean
title: OverdraftControlIndicator

Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.

IncrementalBorrowingAmount

string
title: IncrementalBorrowingAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Every additional tranche of an overdraft balance to which an overdraft fee is applied

FeeAmount

string
title: FeeAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)

FeeRate

string
title: FeeRate
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)

FeeRateType

string
title: FeeRateType

Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)

Enum:
[ Gross, Other ]

ApplicationFrequency*

string
title: ApplicationFrequency

Frequency at which the overdraft charge is applied to the account

CalculationFrequency

string
title: CalculationFrequency

How often is the overdraft fee/charge calculated for the account.

Notes

Notes[
title: Notes

Free text for capturing any other info related to Overdraft Fees Charge Details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftFeeChargeCap

OverdraftFeeChargeCap[
title: OverdraftFeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Overdraft fee type

MinMaxType*

string
title: MinMaxType

Min Max type

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Notes related to Overdraft fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

OtherFeeType

OtherFeeType{

description:	Other Fee type which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherFeeRateType

OtherFeeRateType{

description:	Other fee rate type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherApplicationFrequency

OtherApplicationFrequency{

description:	Other application frequencies that are not available in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherCalculationFrequency

OtherCalculationFrequency{

description:	Other calculation frequency which is not available in the standard code set.
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

}]

OverdraftFeesCharges

OverdraftFeesCharges[
title: OverdraftFeesCharges
additionalProperties: false

Overdraft fees and charges details

{

description:

Overdraft fees and charges details

OverdraftFeeChargeCap

OverdraftFeeChargeCap[
title: OverdraftFeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Overdraft fee type

MinMaxType*

string
title: MinMaxType

Min Max type

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Notes related to Overdraft fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

OverdraftFeeChargeDetail*

OverdraftFeeChargeDetail[
title: OverdraftFeeChargeDetail
additionalProperties: false
minItems: 1

Details about the fees/charges

{

description:

Details about the fees/charges

FeeType*

string
title: FeeType

Overdraft fee type

NegotiableIndicator

boolean
title: NegotiableIndicator

Indicates whether fee and charges are negotiable

OverdraftControlIndicator

boolean
title: OverdraftControlIndicator

Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.

IncrementalBorrowingAmount

string
title: IncrementalBorrowingAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Every additional tranche of an overdraft balance to which an overdraft fee is applied

FeeAmount

string
title: FeeAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)

FeeRate

string
title: FeeRate
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$

Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)

FeeRateType

string
title: FeeRateType

Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)

Enum:
[ Gross, Other ]

ApplicationFrequency*

string
title: ApplicationFrequency

Frequency at which the overdraft charge is applied to the account

CalculationFrequency

string
title: CalculationFrequency

How often is the overdraft fee/charge calculated for the account.

Notes

Notes[
title: Notes

Free text for capturing any other info related to Overdraft Fees Charge Details

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OverdraftFeeChargeCap

OverdraftFeeChargeCap[
title: OverdraftFeeChargeCap
additionalProperties: false

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

{

description:

Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.

FeeType*

FeeType[
title: FeeType
minItems: 1

Fee/charge type which is being capped

string

Overdraft fee type

MinMaxType*

string
title: MinMaxType

Min Max type

Enum:
[ Minimum, Maximum ]

FeeCapOccurrence

number($float)
title: FeeCapOccurrence

FeeCapAmount

string
title: FeeCapAmount
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$

Cap amount charged for a fee/charge

CappingPeriod

string
title: CappingPeriod

Period e.g. day, week, month etc. for which the fee/charge is capped

Enum:
[ Day, Half Year, Month, Quarter, Week, Year ]

Notes

Notes[
title: Notes

Notes related to Overdraft fee charge cap

string
minLength: 1
maxLength: 2000

maxLength 2000 text

]

OtherFeeType

OtherFeeType[
title: OtherFeeType
additionalProperties: false

Other fee type code which is not available in the standard code set

{

description:	Other fee type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}]

OtherFeeType

OtherFeeType{

description:	Other Fee type which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherFeeRateType

OtherFeeRateType{

description:	Other fee rate type code which is not available in the standard code set
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherApplicationFrequency

OtherApplicationFrequency{

description:	Other application frequencies that are not available in the standard code list
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

OtherCalculationFrequency

OtherCalculationFrequency{

description:	Other calculation frequency which is not available in the standard code set.
Code	string title: Code pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 The four letter Mnemonic used within an XML file to identify a code
Name*	string title: Name minLength: 1 maxLength: 70 Long name associated with the code
Description*	string title: Description minLength: 1 maxLength: 350 Description to describe the purpose of the code

}

}]

}

OtherFeesCharges

OtherFeesCharges[
title: OtherFeesCharges
additionalProperties: false

Contains details of fees and charges which are not associated with either Overdraft or features/benefits

{

description:	Contains details of fees and charges which are not associated with either Overdraft or features/benefits
TariffType	string