@datafire/nbg_gr

Client library for Account and Transaction API Specification - UK

Installation and Usage

npm install --save @datafire/nbg_gr

let nbg_gr = require('@datafire/nbg_gr').create({
  "Client-Id": ""
});

.then(data => {
  console.log(data);
});

Description

Functionality at a glance

The NBG "UK OPB - Account and Transaction v3.1.5" API follows the UK Open Banking Specification v3.1.5

This Account and Transaction API Specification describes the flows and payloads for retrieving a list of accounts and their transactions.

The API endpoints described here allow a AISP to:

• Create the Consent with the appropriate permissions in order to be able to access the API Endpoints

• Retrieve the list of accounts

• Retrieve an account's details

• Retrieve an account's balances

• Retrieve an account's transactions

• Retrieve an account's beneficiaries

• Retrieve an account's standing orders

• Retrieve an account's party

• Retrieve an account's scheduled payments

• Retrieve an account's statements

Quick Getting Started

1. Login/Register to the NBG Technology HUB

2. Go to "APPS"

3. Select your Organization and go to step 4. If you want to create a new Organization click "CREATE AN ORGANIZATION" and follow the steps below:

   1. Enter the title of your Organization
   2. Enter a short description of your Organization (optional)
   3. Click "SUBMIT"

4. Select the Organization of choice and click "ADD AN APPLICATION"

   1. Fill in the forms (title and short description)

   2. Check "Authorization Code" and "Client Credentials"

   3. Enter the OAuth Redirect and Post Logout URIs (these are the URIs that we will redirect the user upon logging in and logging out respectively)

      You can use the following redirect URL to easily test the API through the portal: https://developer.nbg.gr/oauth2/redoc-callback

   4. Click "SUBMIT"

   5. Store the APPs "Client ID" and "Client Secret"

5. Go to "API PRODUCTS" and select the ACCOUNT INFORMATION - UK OPEN BANKING API

6. Click "START USING THIS API", choose your app and click "SUBSCRIBE"

7. Get an Access Token using the Access Token Flow and the API scopes provided in the Authentication and Authorization (OAuth2) section below

8. Create a Sandbox

9. Play with the API

Sandbox Flow

The Sandbox Flow matches the Production Flow. The difference lies into the Data used. Instead of live data, the Sandbox flow uses mocked data.

Production Flow

The Production Flow is described in the UK Open Banking v3.1.5 Specification

More details about the implementation specifics followed, please visit section UK OPB Implementation Specifics

Authentication and Authorization (OAuth2)

This API version uses the OAuth2 protocol for authentication and authorization, which means that a Bearer (access token) should be acquired. An access token can be retrieved using the client_id and client_secret of the APP that you created and subscribed in this API, and your own credentials (username, password) that you use to sign in the NBG Technology HUB. The scopes are defined below:

Authorization Endpoint:

  https://my.nbg.gr/identity/connect/authorize

Token Endpoint:

  https://my.nbg.gr/identity/connect/token

Authorization Code

Sandbox Scopes:

  sandbox-uk-account-info-api-v1 offline_access

Production Scopes:

  accounts offline_access

Client Credentials

Sandbox Scopes:

  sandbox-uk-account-info-api-v1

Production Scopes:

  accounts

See more here

QWAC Certificates

TPPs are required to present a QWAC certificate during API consumption. The API checks that this certificate has been provided and is valid. In sandbox mode the certificate validations are optional. To validate your certificate in sandbox implementation, please send us your QWAC certificate at [email protected] and set the HTTP Header "x-sandbox-qwac-certificate-check" with the value "true" in your requests.

SMS Challenge (One Time Password)

In order to successfully authorize an Accounts Access you will need to provide the SMS OTP (One Time Password) in the corresponding Accounts Consent UI Screen.

By default the SMS OTP will be sent to the mobile number declared upon singing up in the NBG Technology HUB.

Create your Sandbox

Create a new Sandbox application by invoking the POST /sandbox. This call will generate a new Sandbox with a unique sandbox-id.

Important! Before proceeding save the sandbox id you just created.

When you create a sandbox, users and sandbox specific data are generated as sample data.

Start Testing

Once you have your sandbox-id, you can start invoking the rest of the operations by providing the mandatory http header sandbox-id and the http headers described below.

Important notes

Request headers

The following HTTP header parameters are required for every call:

1. Authorization. The Auth2 Token

2. sandbox-id. Your Sandbox ID

Consent

In order to be able to effectively start using the Endpoints the appropriate Consent needs to be created and set to the 'Authorised' status.

In order to create the Consent you need to at least set the required permissions and the Risk sections.

Optionally you may set the

1. ExpirationDateTime. When the Consent expires

2. TransactionFromDateTime. Start Date to retrieve the transactions

3. TransactionToDateTime. End Date to retrieve the transactions

Not Implemented Endpoints

The following endpoints are not implemented in the API

1. GET /balances
2. GET /transactions
3. GET /beneficiaries
4. GET /accounts/{AccountId}/direct-debits
5. GET /direct-debits
6. GET /standing-orders
7. GET /accounts/{AccountId}/product
8. GET /products
9. GET /accounts/{AccountId}/offers
10. GET /offers
11. GET /scheduled-payments
12. GET /statements

Error Codes

The error codes and their description can be found here

UK OPB Implementation Specifics

Below you may find more specific information & limitations regarding the implementation followed in the Production API.

Token Endpoint Client Authentication

At this point the supported Client Authentication method is "Client Secret Basic" - usage of "Client ID" & "Client Secret".

Consent Authorization

For a PSU to Authorize a Consent, they need to be redirected to the appropriate Consent UI.

For this redirection to take place the TPP needs to follow the Authorization Endpoint by amending the generated "Consent ID", like this: https://my.nbg.gr/identity/connect/authorize?consent_id={{consent_id}}&client_id={{client_id}}&scope={{scope}}&redirect_uri={{redirect_uri}}&response_type=code

Once the PSU is redirected to the Consent Authorization Screen, they need to enter their IBank (Production) or Developer Portal (Sandbox) Credentials and either Authorize or Reject the Consent.

At this point the Consent is binded with the PSU.

Debtor Account

Currently, only the "UK.OBIE.IBAN" scheme is supported.

Feedback and Questions

We would love to hear your feedback and answer your questions. Send us at [email protected]

Check out our Sandbox Postman Collection!

Created by NBG.

Entities

Below, the main entities are documented.

OBExternalPermissions1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| 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.| ReadAccountsBasicReadAccountsDetailReadBalancesReadBeneficiariesBasicReadBeneficiariesDetailReadDirectDebitsReadOffersReadPANReadPartyReadPartyPSUReadProductsReadScheduledPaymentsBasicReadScheduledPaymentsDetailReadStandingOrdersBasicReadStandingOrdersDetailReadStatementsBasicReadStatementsDetailReadTransactionsBasicReadTransactionsCreditsReadTransactionsDebitsReadTransactionsDetail|

OBReadData1

Attributes

| Name| Description| Values| | -----| -----| -----| | Permissions| 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.| array[OBExternalPermissions1Code]| | ExpirationDateTime| 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| string| | TransactionFromDateTime| 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| string| | TransactionToDateTime| 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| string|

OBRisk2

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.

Attributes

| Name| Description| Values| | -----| -----| -----|

OBReadConsent1

Attributes

| Name| Description| Values| | -----| -----| -----| | Data | Entity | OBReadData1Permissions [array[OBExternalPermissions1Code]] ExpirationDateTime [string] TransactionFromDateTime [string] TransactionToDateTime [string] | | Risk | Entity | OBRisk2 |

OBExternalRequestStatus1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| Specifies the status of consent resource in code form.| AuthorisedAwaitingAuthorisationRejectedRevoked|

OBReadDataConsentResponse1

Attributes

| Name| Description| Values| | -----| -----| -----| | ConsentId| Unique identification as assigned to identify the account access consent resource.| string| | CreationDateTime| 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| string| | Status | Entity | OBExternalRequestStatus1Code | | StatusUpdateDateTime| 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| string| | Permissions| 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.| array[OBExternalPermissions1Code]| | ExpirationDateTime| 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| string| | TransactionFromDateTime| 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| string| | TransactionToDateTime| 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| string|

Links

Links relevant to the payload

Attributes

| Name| Description| Values| | -----| -----| -----| | Self| -| string| | First| -| string| | Prev| -| string| | Next| -| string| | Last| -| string|

Meta

Meta Data relevant to the payload

Attributes

| Name| Description| Values| | -----| -----| -----| | TotalPages| -| integer| | FirstAvailableDateTime| All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.An example is below: 2017-04-05T10:43:07+00:00| string| | LastAvailableDateTime| All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.An example is below: 2017-04-05T10:43:07+00:00| string|

OBReadConsentResponse1

Attributes

| Name| Description| Values| | -----| -----| -----| | Data | Entity | OBReadDataConsentResponse1ConsentId [string] CreationDateTime [string] Status [OBExternalRequestStatus1Code]StatusUpdateDateTime [string] Permissions [array[OBExternalPermissions1Code]] ExpirationDateTime [string] TransactionFromDateTime [string] TransactionToDateTime [string] | | Risk | Entity | OBRisk2 | | Links | Entity | LinksSelf [string] First [string] Prev [string] Next [string] Last [string] | | Meta | Entity | MetaTotalPages [integer] FirstAvailableDateTime [string] LastAvailableDateTime [string] |

ErrorCode

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| This is Data Type gives a low level textual error code to help categorise an error response. The applicable HTTP response code is also given.| UK.OBIE.Field.ExpectedUK.OBIE.Field.InvalidUK.OBIE.Field.InvalidDateUK.OBIE.Field.MissingUK.OBIE.Field.UnexpectedUK.OBIE.Header.InvalidUK.OBIE.Header.MissingUK.OBIE.Resource.ConsentMismatchUK.OBIE.Resource.InvalidConsentStatusUK.OBIE.Resource.InvalidFormatUK.OBIE.Resource.NotFoundUK.OBIE.Rules.AfterCutOffDateTimeUK.OBIE.Rules.DuplicateReferenceUK.OBIE.Signature.InvalidUK.OBIE.Signature.InvalidClaimUK.OBIE.Signature.MissingClaimUK.OBIE.Signature.MalformedUK.OBIE.Signature.MissingUK.OBIE.Signature.UnexpectedUK.OBIE.Unsupported.AccountIdentifierUK.OBIE.Unsupported.AccountSecondaryIdentifierUK.OBIE.Unsupported.CurrencyUK.OBIE.Unsupported.EventTypeUK.OBIE.Unsupported.FrequencyUK.OBIE.Unsupported.LocalInstrumentUK.OBIE.Unsupported.SchemeUK.OBIE.ReauthenticateUK.OBIE.Rules.ResourceAlreadyExistsUK.OBIE.UnexpectedError|

OBError1

Attributes

| Name| Description| Values| | -----| -----| -----| | ErrorCode | Entity | ErrorCode | | Message| 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| string| | Path| Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency| string| | Url| URL to help remediate the problem, or provide more information, or to API Reference, or help etc| string|

OBErrorResponse1

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

Attributes

| Name| Description| Values| | -----| -----| -----| | Code| High level textual error code, to help categorize the errors.| string| | Id| A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.| string| | Message| Brief Error message, e.g., 'There is something wrong with the request parameters provided'| string| | Errors| Gets or Sets Errors| array[OBError1]|

OBAccountStatus1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| -| DeletedDisabledEnabledPendingProForma|

OBExternalAccountType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| -| BusinessPersonal|

OBExternalAccountSubType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| -| ChargeCardCreditCardCurrentAccountEMoneyLoanMortgagePrePaidCardSavings|

OBCashAccount5

Attributes

| Name| Description| Values| | -----| -----| -----| | SchemeName| Name of the identification scheme, in a coded form as published in an external list.| string| | Identification| Identification assigned by an institution to identify an account. This identification is known by the account owner.| string| | Name| 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.| string| | SecondaryIdentification| 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).| string|

OBBranchAndFinancialInstitutionIdentification5

Attributes

| Name| Description| Values| | -----| -----| -----| | SchemeName| Name of the identification scheme, in a coded form as published in an external list.| string| | Identification| Unique and unambiguous identification of the servicing institution.| string|

OBAccount6

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

Attributes

| Name| Description| Values| | -----| -----| -----| | AccountId| A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.| string| | Status | Entity | OBAccountStatus1Code | | StatusUpdateDateTime| 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| string| | Currency| 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.| string| | AccountType | Entity | OBExternalAccountType1Code | | AccountSubType | Entity | OBExternalAccountSubType1Code | | Description| Specifies the description of the account type.| string| | Nickname| The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.| string| | OpeningDate| Date on which the account and related basic services are effectively operational for the account owner.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00| string| | MaturityDate| Maturity date of the account.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00| string| | Account| Provides the details to identify an account.| array[OBCashAccount5]| | Servicer | Entity | OBBranchAndFinancialInstitutionIdentification5SchemeName [string] Identification [string] |

OBReadDataAccount5

Attributes

| Name| Description| Values| | -----| -----| -----| | Account| Unambiguous identification of the account to which credit and debit entries are made.| array[OBAccount6]|

OBReadAccount5

Attributes

| Name| Description| Values| | -----| -----| -----| | Data | Entity | OBReadDataAccount5Account [array[OBAccount6]] | | Links | Entity | LinksSelf [string] First [string] Prev [string] Next [string] Last [string] | | Meta | Entity | MetaTotalPages [integer] FirstAvailableDateTime [string] LastAvailableDateTime [string] |

OBCreditDebitCode

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| -| CreditDebit|

OBBalanceType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| -| ClosingAvailableClosingBookedClosingClearedExpectedForwardAvailableInformationInterimAvailableInterimBookedInterimClearedOpeningAvailableOpeningBookedOpeningClearedPreviouslyClosedBooked|

OBActiveOrHistoricCurrencyAndAmount

Attributes

| Name| Description| Values| | -----| -----| -----| | Amount| A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.| string| | Currency| 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".| string|

OBExternalLimitType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| -| AvailableCreditEmergencyPre-AgreedTemporary|

OBCreditLine1

Attributes

| Name| Description| Values| | -----| -----| -----| | Included| 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.| boolean| | Type | Entity | OBExternalLimitType1Code | | Amount | Entity | OBActiveOrHistoricCurrencyAndAmountAmount [string] Currency [string] |

OBCashBalance1

Set of elements used to define the balance details.

Attributes

| Name| Description| Values| | -----| -----| -----| | AccountId| A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.| string| | CreditDebitIndicator | Entity | OBCreditDebitCode | | Type | Entity | OBBalanceType1Code | | DateTime| 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| string| | Amount | Entity | OBActiveOrHistoricCurrencyAndAmountAmount [string] Currency [string] | | CreditLine| Set of elements used to provide details on the credit line.| array[OBCreditLine1]|

OBReadDataBalance1

Attributes

| Name| Description| Values| | -----| -----| -----| | Balance| Set of elements used to define the balance details.| array[OBCashBalance1]|

OBReadBalance1

Attributes

| Name| Description| Values| | -----| -----| -----| | Data | Entity | OBReadDataBalance1Balance [array[OBCashBalance1]] | | Links | Entity | LinksSelf [string] First [string] Prev [string] Next [string] Last [string] | | Meta | Entity | MetaTotalPages [integer] FirstAvailableDateTime [string] LastAvailableDateTime [string] |

OBBeneficiaryType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| Specifies the Beneficiary Type.| TrustedOrdinary|

OBSupplementaryData1

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

Attributes

| Name| Description| Values| | -----| -----| -----|

OBAddressTypeCode

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| Identifies the nature of the postal address.| BusinessCorrespondenceDeliveryToMailToPOBoxPostalResidentialStatement|

OBPostalAddress6

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

Attributes

| Name| Description| Values| | -----| -----| -----| | AddressType | Entity | OBAddressTypeCode | | Department| Identification of a division of a large organisation or building.| string| | SubDepartment| Identification of a sub-division of a large organisation or building.| string| | StreetName| Name of a street or thoroughfare.| string| | BuildingNumber| Number that identifies the position of a building on a street.| string| | PostCode| Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.| string| | TownName| Name of a built-up area, with defined boundaries, and a local government.| string| | CountrySubDivision| Identifies a subdivision of a country such as state, region, county.| string| | Country| Nation with its own government.| string| | AddressLine| Information that locates and identifies a specific address, as defined by postal services, presented in free format text.| array|

OBBranchAndFinancialInstitutionIdentification6

Attributes

| Name| Description| Values| | -----| -----| -----| | SchemeName| Name of the identification scheme, in a coded form as published in an external list.| string| | Identification| Unique and unambiguous identification of the servicing institution.| string| | Name| Name by which an agent is known and which is usually used to identify that agent.| string| | PostalAddress | Entity | OBPostalAddress6AddressType [OBAddressTypeCode]Department [string] SubDepartment [string] StreetName [string] BuildingNumber [string] PostCode [string] TownName [string] CountrySubDivision [string] Country [string] AddressLine [array] |

OBBeneficiary5

Attributes

| Name| Description| Values| | -----| -----| -----| | AccountId| A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.| string| | BeneficiaryId| A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.| string| | BeneficiaryType | Entity | OBBeneficiaryType1Code | | Reference| 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.| string| | SupplementaryData | Entity | OBSupplementaryData1 | | CreditorAgent | Entity | OBBranchAndFinancialInstitutionIdentification6SchemeName [string] Identification [string] Name [string] PostalAddress [OBPostalAddress6]AddressType [OBAddressTypeCode]Department [string] SubDepartment [string] StreetName [string] BuildingNumber [string] PostCode [string] TownName [string] CountrySubDivision [string] Country [string] AddressLine [array] | | CreditorAccount | Entity | OBCashAccount5SchemeName [string] Identification [string] Name [string] SecondaryIdentification [string] |

OBReadDataBeneficiary5

Attributes

| Name| Description| Values| | -----| -----| -----| | Beneficiary| -| array[OBBeneficiary5]|

OBReadBeneficiary5

Attributes

| Name| Description| Values| | -----| -----| -----| | Data | Entity | OBReadDataBeneficiary5Beneficiary [array[OBBeneficiary5]] | | Links | Entity | LinksSelf [string] First [string] Prev [string] Next [string] Last [string] | | Meta | Entity | MetaTotalPages [integer] FirstAvailableDateTime [string] LastAvailableDateTime [string] |

OBExternalDirectDebitStatus1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| -| ActiveInactive|

OBDirectDebit2

Account to or from which a cash entry is made.

Attributes

| Name| Description| Values| | -----| -----| -----| | AccountId| A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.| string| | DirectDebitId| A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.| string| | MandateIdentification| Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.| string| | DirectDebitStatusCode | Entity | OBExternalDirectDebitStatus1Code | | Name| Name of Service User.| string| | PreviousPaymentDateTime| 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| string| | Frequency| Regularity with which direct debit instructions are to be created and processed.| string| | PreviousPaymentAmount | Entity | OBActiveOrHistoricCurrencyAndAmountAmount [string] Currency [string] |

OBReadDataDirectDebit2

Attributes

| Name| Description| Values| | -----| -----| -----| | DirectDebit| Account to or from which a cash entry is made.| array[OBDirectDebit2]|

OBReadDirectDebit2

Attributes

| Name| Description| Values| | -----| -----| -----| | Data | Entity | OBReadDataDirectDebit2DirectDebit [array[OBDirectDebit2]] | | Links | Entity | LinksSelf [string] First [string] Prev [string] Next [string] Last [string] | | Meta | Entity | MetaTotalPages [integer] FirstAvailableDateTime [string] LastAvailableDateTime [string] |

OBExternalOfferType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| -| BalanceTransferLimitIncreaseMoneyTransferOtherPromotionalRate|

OBOffer1

Attributes

| Name| Description| Values| | -----| -----| -----| | AccountId| A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.| string| | OfferId| A unique and immutable identifier used to identify the offer resource. This identifier has no meaning to the account owner.| string| | OfferType | Entity | OBExternalOfferType1Code | | Description| Further details of the offer.| string| | StartDateTime| 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| string| | EndDateTime| 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| string| | Rate| Rate associated with the offer type.| string| | Value| Value associated with the offer type.| integer| | Term| Further details of the term of the offer.| string| | URL| URL (Uniform Resource Locator) where documentation on the offer can be found| string| | Amount | Entity | OBActiveOrHistoricCurrencyAndAmountAmount [string] Currency [string] | | Fee | Entity | OBActiveOrHistoricCurrencyAndAmountAmount [string] Currency [string] |

OBReadDataOffer1

Attributes

| Name| Description| Values| | -----| -----| -----| | Offer| -| array[OBOffer1]|

OBReadOffer1

Attributes

| Name| Description| Values| | -----| -----| -----| | Data | Entity | OBReadDataOffer1Offer [array[OBOffer1]] | | Links | Entity | LinksSelf [string] First [string] Prev [string] Next [string] Last [string] | | Meta | Entity | MetaTotalPages [integer] FirstAvailableDateTime [string] LastAvailableDateTime [string] |

OBExternalPartyType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| -| DelegateJointSole|

OBRelationship1

Attributes

| Name| Description| Values| | -----| -----| -----| | Related| Absolute URI to the related resource.| string| | Id| Unique identification as assigned by the ASPSP to uniquely identify the related resource.| string|

OBPartyRelationships1

Attributes

| Name| Description| Values| | -----| -----| -----| | Account | Entity | OBRelationship1Related [string] Id [string] |

OBPostalAddress8

Attributes

| Name| Description| Values| | -----| -----| -----| | AddressType | Entity | OBAddressTypeCode | | AddressLine| Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.| array| | StreetName| Name of a street or thoroughfare.| string| | BuildingNumber| Number that identifies the position of a building on a street.| string| | PostCode| Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.| string| | TownName| Name of a built-up area, with defined boundaries, and a local government.| string| | CountrySubDivision| Identifies a subdivision of a country eg, state, region, county.| string| | Country| Nation with its own government, occupying a particular territory.| string|

OBParty2

Attributes

| Name| Description| Values| | -----| -----| -----| | PartyId| A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.| string| | PartyNumber| Number assigned by an agent to identify its customer.| string| | PartyType | Entity | OBExternalPartyType1Code | | Name| Name by which a party is known and which is usually used to identify that party.| string| | FullLegalName| Specifies a character string with a maximum length of 350 characters.| string| | LegalStructure| Legal standing of the party.| string| | BeneficialOwnership| A flag to indicate a party's beneficial ownership of the related account.| boolean| | AccountRole| A party’s role with respect to the related account.| string| | EmailAddress| Address for electronic mail (e-mail).| string| | Phone| Collection of information that identifies a phone number, as defined by telecom services.| string| | Mobile| Collection of information that identifies a mobile phone number, as defined by telecom services.| string| | Relationships | Entity | OBPartyRelationships1Account [OBRelationship1]Related [string] Id [string] | | Address| Postal address of a party.| array[OBPostalAddress8]|

OBReadDataParty2

Attributes

| Name| Description| Values| | -----| -----| -----| | Party | Entity | OBParty2PartyId [string] PartyNumber [string] PartyType [OBExternalPartyType1Code]Name [string] FullLegalName [string] LegalStructure [string] BeneficialOwnership [boolean] AccountRole [string] EmailAddress [string] Phone [string] Mobile [string] Relationships [OBPartyRelationships1]Account [OBRelationship1]Related [string] Id [string] Address [array[OBPostalAddress8]] |

OBReadParty2

Attributes

| Name| Description| Values| | -----| -----| -----| | Data | Entity | OBReadDataParty2Party [OBParty2]PartyId [string] PartyNumber [string] PartyType [OBExternalPartyType1Code]Name [string] FullLegalName [string] LegalStructure [string] BeneficialOwnership [boolean] AccountRole [string] EmailAddress [string] Phone [string] Mobile [string] Relationships [OBPartyRelationships1]Account [OBRelationship1]Related [string] Id [string] Address [array[OBPostalAddress8]] | | Links | Entity | LinksSelf [string] First [string] Prev [string] Next [string] Last [string] | | Meta | Entity | MetaTotalPages [integer] FirstAvailableDateTime [string] LastAvailableDateTime [string] |

OBReadDataParty3

Attributes

| Name| Description| Values| | -----| -----| -----| | Party| -| array[OBParty2]|

OBReadParty3

Attributes

| Name| Description| Values| | -----| -----| -----| | Data | Entity | OBReadDataParty3Party [array[OBParty2]] | | Links | Entity | LinksSelf [string] First [string] Prev [string] Next [string] Last [string] | | Meta | Entity | MetaTotalPages [integer] FirstAvailableDateTime [string] LastAvailableDateTime [string] |

OBExternalProductType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| Product type : Personal Current Account, Business Current Account| BusinessCurrentAccountCommercialCreditCardOtherPersonalCurrentAccountSMELoan|

OBOtherProductSegment1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| -| GEASGEBAGEBRGEBUGECIGECSGEFBGEFGGEGGEGRGEGSGEOTGEOVGEPAGEPRGEREGESTGEYAGEYOPSCAPSESPSNCPSNPPSRGPSSSPSSTPSSW|

OBPeriod1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| The unit of period (days, weeks, months etc.) of the promotional length| PACTPDAYPHYRPMTHPQTRPWEKPYER|

OBOtherCodeType1

Attributes

| Name| Description| Values| | -----| -----| -----| | Code| The four letter Mnemonic used within an XML file to identify a code| string| | Name| Long name associated with the code| string| | Description| Description to describe the purpose of the code| string|

OBOtherProductDetails1

Attributes

| Name| Description| Values| | -----| -----| -----| | 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| array[OBOtherProductSegment1Code]| | FeeFreeLength| The length/duration of the fee free period| integer| | FeeFreeLengthPeriod | Entity | OBPeriod1Code | | MonthlyMaximumCharge| The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order| string| | Notes| Optional additional notes to supplement the Core product details| array| | OtherSegment | Entity | OBOtherCodeType1Code [string] Name [string] Description [string] |

OBTierBandType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| The methodology of how credit interest is paid/applied. It can be:- 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. 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. 3. Whole The same interest rate is applied irrespective of the product holder's account balance| INBAINTIINWH|

OBInterestCalculationMethod1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| -| ITCOITOTITSI|

OBInterestDestination1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| Describes whether accrued interest is payable only to the BCA or to another bank account| INOTINPAINSC|

OBFrequency1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| How often is credit interest calculated for the account.| FQATFQDYFQHYFQMYFQOTFQQYFQSDFQWYFQYY|

OBInterestFixedVariableType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| Type of interest rate, Fixed or Variable| INFIINVA|

OBInterestRateType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the account holder's account.| INBBINFRINGRINLRINNEINOT|

OBTierBand1

Tier Band Details

Attributes

| Name| Description| Values| | -----| -----| -----| | Identification| Unique and unambiguous identification of a Tier Band for the Product.| string| | TierValueMinimum| Minimum deposit value for which the credit interest tier applies.| string| | TierValueMaximum| Maximum deposit value for which the credit interest tier applies.| string| | CalculationFrequency | Entity | OBFrequency1Code | | ApplicationFrequency | Entity | OBFrequency1Code | | DepositInterestAppliedCoverage | Entity | OBTierBandType1Code | | FixedVariableInterestRateType | Entity | OBInterestFixedVariableType1Code | | AER| 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| string| | BankInterestRateType | Entity | OBInterestRateType1Code | | BankInterestRate| Bank Interest for the product| string| | Notes| Optional additional notes to supplement the Tier Band details| array| | OtherBankInterestType | Entity | OBOtherCodeType1Code [string] Name [string] Description [string] | | OtherApplicationFrequency | Entity | OBOtherCodeType1Code [string] Name [string] Description [string] | | OtherCalculationFrequency | Entity | OBOtherCodeType1Code [string] Name [string] Description [string] |

OBTierBandSet1

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

Attributes

| Name| Description| Values| | -----| -----| -----| | TierBandMethod | Entity | OBTierBandType1Code | | CalculationMethod | Entity | OBInterestCalculationMethod1Code | | Destination | Entity | OBInterestDestination1Code | | Notes| Optional additional notes to supplement the Tier Band Set details| array| | OtherCalculationMethod | Entity | OBOtherCodeType1Code [string] Name [string] Description [string] | | OtherDestination | Entity | OBOtherCodeType1Code [string] Name [string] Description [string] | | TierBand| Tier Band Details| array[OBTierBand1]|

OBCreditInterest1

Details about the interest that may be payable to the Account holders

Attributes

| Name| Description| Values| | -----| -----| -----| | TierBandSet| -| array[OBTierBandSet1]|

OBOverdraftType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| 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.| OVCOOVODOVOT|

OBOverdraftFeeType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| Fee/charge type which is being capped| FBAOFBARFBEBFBITFBORFBOSFBSCFBTOFBUBFBUTFTOTFTUT|

OBMinMaxType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| Min Max type| FMMNFMMX|

OBOverdraftFeeChargeCap1

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.

Attributes

| Name| Description| Values| | -----| -----| -----| | FeeType| -| array[OBOverdraftFeeType1Code]| | MinMaxType | Entity | OBMinMaxType1Code | | FeeCapOccurrence| 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.| integer| | FeeCapAmount| Cap amount charged for a fee/charge| string| | CappingPeriod | Entity | OBPeriod1Code | | Notes| Notes related to Overdraft fee charge cap| array| | OtherFeeType| -| array[OBOtherCodeType1]|

OBFeeFrequency1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| Frequency at which the overdraft charge is applied to the account| FEACFEAOFECPFEDAFEHOFEIFEMOFEOAFEOTFEPCFEPHFEPOFEPSFEPTFEPTAFEPTPFEQUFESMFESTFEWEFEYE|

OBOverdraftFeesChargeDetails1

Details about the fees/charges

Attributes

| Name| Description| Values| | -----| -----| -----| | FeeType | Entity | OBOverdraftFeeType1Code | | NegotiableIndicator| Indicates whether fee and charges are negotiable| boolean| | OverdraftControlIndicator| Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.| boolean| | IncrementalBorrowingAmount| Every additional tranche of an overdraft balance to which an overdraft fee is applied| string| | FeeAmount| Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)| string| | FeeRate| Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)| string| | FeeRateType | Entity | OBInterestRateType1Code | | ApplicationFrequency | Entity | OBFeeFrequency1Code | | CalculationFrequency | Entity | OBFeeFrequency1Code | | Notes| Free text for capturing any other info related to Overdraft Fees Charge Details| array| | OverdraftFeeChargeCap| -| array[OBOverdraftFeeChargeCap1]| | OtherFeeType | Entity | OBOtherCodeType1Code [string] Name [string] Description [string] | | OtherFeeRateType | Entity | OBOtherCodeType1Code [string] Name [string] Description [string] | | OtherApplicationFrequency | Entity | OBOtherCodeType1Code [string] Name [string] Description [string] | | OtherCalculationFrequency | Entity | OBOtherCodeType1Code [string] Name [string] Description [string] |

OBOverdraftFeesCharges1

Overdraft fees and charges

Attributes

| Name| Description| Values| | -----| -----| -----| | OverdraftFeeChargeCap| -| array[OBOverdraftFeeChargeCap1]| | OverdraftFeeChargeDetail| -| array[OBOverdraftFeesChargeDetails1]|

OBOverdraftTierBand1

Provides overdraft details for a specific tier or band

Attributes

| Name| Description| Values| | -----| -----| -----| | Identification| Unique and unambiguous identification of a Tier Band for a overdraft.| string| | TierValueMin| Minimum value of Overdraft Tier/Band| string| | TierValueMax| Maximum value of Overdraft Tier/Band| string| | EAR| EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.| string| | AgreementLengthMin| Specifies the minimum length of a band for a fixed overdraft agreement| integer| | AgreementLengthMax| Specifies the maximum length of a band for a fixed overdraft agreement| integer| | AgreementPeriod | Entity | OBPeriod1Code | | OverdraftInterestChargingCoverage | Entity | OBTierBandType1Code | | 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.| boolean| | Notes| Optional additional notes to supplement the Tier/band details| array| | OverdraftFeesCharges| -| array[OBOverdraftFeesCharges1]|

OBOverdraftTierbandSet1

Tier band set details

Attributes

| Name| Description| Values| | -----| -----| -----| | TierBandMethod | Entity | OBTierBandType1Code | | OverdraftType | Entity | OBOverdraftType1Code | | Identification| Unique and unambiguous identification of a Tier Band for a overdraft product.| string| | AuthorisedIndicator| Indicates if the Overdraft is authorised (Y) or unauthorised (N)| boolean| | BufferAmount| 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.| string| | Notes| Optional additional notes to supplement the overdraft Tier Band Set details| array| | OverdraftTierBand| -| array[OBOverdraftTierBand1]| | OverdraftFeesCharges| -| array[OBOverdraftFeesCharges1]|

OBOverdraft1

Borrowing details

Attributes

| Name| Description| Values| | -----| -----| -----| | Notes| Associated Notes about the overdraft rates| array| | OverdraftTierBandSet| Tier band set details| array[OBOverdraftTierbandSet1]|

OBFeeType1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| Fee/Charge Type| FEPFFTOTFYAFFYAMFYAQFYCPFYDBFYMIFYXX|

OBFeeCategory1Code

Attributes

| Type| Description| Example| Values| | -----| -----| -----| -----| | enum| Categorisation of fees and charges into standard categories.| FCOTFCREFCSV|

OBOtherFeeChargeDetailType

Other Fee/charge type which is not available in the standard code set

Attributes

| Name| Description| Values| | -----| -----| -----| | Code| The four letter Mnemonic used within an XML file to identify a code| string| | FeeCategory | Entity | OBFeeCategory1Code | | Name| Long name associated with the code| string| | Description| Description to describe the purpose of the code| string|

OBLoanInterestFeesChargeDetail1

Other fees/charges details

Attributes

| Name| Description| Values| | -----| -----| -----| | FeeType | Entity | OBFeeType1Code | | NegotiableIndicator| Fee/charge which is usually negotiable rather than a fixed amount| boolean| | FeeAmount| Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)| string| | FeeRate| Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)| string| |