Implementation Guide: Santander
This page has been created and maintained by the relevant ASPSP, and OBIE takes no liability for the completeness nor accuracy of this data.
Note to ASPSP: Please indicate which brands this applies to and/or duplicate this page per brand if relevant.
On-boarding
Supports dynamic client registration (Y/N) | N |
---|---|
Instructions for manual on-boarding | 1) Open access or regulated access? 2) Are you registered with the Open Banking directory? 3) Sandbox or Production? 4) Register an app 5) Subscribe to APIs 6) One final check before you can start developing! |
OIDC .well-known endpoint (Production) | |
OIDC .well-known endpoint (Sandbox) | |
Notes on testing (Sandbox) | Account Information Service Your first step will be to choose the API(s) you want to test. A. Get Token using Client Credential Grant B. Retrieve Account Request C. Create Request Object D. Invoke Authorise Request E. Get Token Using Access Code Grant F. Get Endpoint Response Payment Initiation Service Your first step will be to choose the API(s) you want to test. A. Get Token using Client Credential Grant B. Create Request Object C. Invoke Authorise Request D. Get Token Using Access Code Grant E. POST/GET Endpoint Response |
Other on-boarding notes | |
Documentation URL |
Account Information API
Note to ASPSP: Please add a column per brand if relevant
Swagger version | 3.1.2 |
---|---|
Base URI | https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp |
General variances to specification | No variances to specification |
Non-functional limitations |
API Endpoints
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Endpoint 1 | POST /account-access-consents | - | Y | Mandatory API Endpoint available |
Endpoint 2 | GET /account-access-consents/{ConsentId} | - | Y | Optional API Endpoint available |
Endpoint 3 | DELETE /account-access-consents/{ConsentId} | - | Y | Mandatory API Endpoint available |
Endpoint 4 | GET /accounts | - | Y | Mandatory API Endpoint available |
Endpoint 5 | GET /accounts/{AccountId} | - | Y | Mandatory API Endpoint available |
Endpoint 6 | GET /accounts/{AccountId}/balances | - | Y | Mandatory API Endpoint available |
Endpoint 7 | GET /accounts/{AccountId}/beneficiaries | - | Y | Mandatory API Endpoint available |
Endpoint 8 | GET /accounts/{AccountId}/direct-debits | - | Y | Mandatory API Endpoint available |
Endpoint 9 | GET /accounts/{AccountId}/product | - | Y | Mandatory API Endpoint available |
Endpoint 10 | GET /accounts/{AccountId}/standing-orders | - | Y | Mandatory API Endpoint available |
Endpoint 11 | GET /accounts/{AccountId}/transactions | - | Y | Mandatory API Endpoint available |
Endpoint 12 | GET /balances | - | N | Optional API Endpoint not available |
Endpoint 13 | GET /beneficiaries | - | Y | Optional API Endpoint available |
Endpoint 14 | GET /direct-debits | - | Y | Optional API Endpoint available |
Endpoint 15 | GET /products | - | N | Optional API Endpoint available |
Endpoint 16 | GET /standing-orders | - | Y | Optional API Endpoint available |
Endpoint 17 | GET /transactions | - | N | Optional API Endpoint not available |
Endpoint 18 | GET /accounts/{AccountId}/offers | - | Y | Conditional |
Endpoint 19 | GET /offers | - | N | Optional |
Endpoint 20 | GET /accounts/{AccountId}/party | - | Y | Conditional |
Endpoint 21 | GET /party | - | Y | Conditional |
Endpoint 22 | GET /accounts/{AccountId}/scheduled-payments | - | N | Conditional |
Endpoint 23 | GET/scheduled-payments | - | N | Optional |
Endpoint 24 | GET /accounts/{AccountId}/statements | - | Y | Conditional |
Endpoint 25 | GET /accounts/{AccountId}/statements/{StatementId} | - | N | Conditional |
Endpoint 26 | GET /accounts/{AccountId}/statements/{StatementId}/file | - | N | Optional |
Endpoint 27 | GET /accounts/{AccountId}/statements/{StatementId}/transactions | - | N | Conditional |
Endpoint 28 | GET /statements | - | N | Optional |
Field Information
Account Fields
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Acc-1 | Account - Mandatory | OBReadAccount4 | Y | OBReadAccount4 |
Acc-2 | Account - Mandatory | Data | Y | OBReadAccount4/Data |
Acc-3 | Account - Optional | Account | Y | OBReadAccount4/Data/Account |
Acc-4 | Account - Mandatory | AccountId | Y | OBReadAccount4/Data/Account/AccountId |
Acc-5 | Account - Optional | Status | N | OBReadAccount4/Data/Account/Status |
Acc-6 | Account - Optional | StatusUpdateDateTime | N | OBReadAccount4/Data/Account/StatusUpdateDateTime |
Acc-7 | Account - Mandatory | Currency | Y | OBReadAccount4/Data/Account/Currency |
Acc-8 | Account - Mandatory | AccountType | Y | OBReadAccount4/Data/Account/AccountType |
Acc-9 | Account - Mandatory | AccountSubType | Y | OBReadAccount4/Data/Account/AccountSubType |
Acc-10 | Account - Optional | Description | N | OBReadAccount4/Data/Account/Description |
Acc-11 | Account - Optional | Nickname | Y | OBReadAccount4/Data/Account/Nickname |
Acc-12 | Account - Optional | Account | Y | OBReadAccount4/Data/Account/Account |
Acc-13 | Account - Mandatory | SchemeName | Y | OBReadAccount4/Data/Account/Account/SchemeName |
Acc-14 | Account - Mandatory | Identification | Y | OBReadAccount4/Data/Account/Account/Identification |
Acc-15 | Account - Optional | Name | Y | OBReadAccount4/Data/Account/Account/Name |
Acc-16 | Account - Optional | SecondaryIdentification | N | OBReadAccount4/Data/Account/Account/SecondaryIdentification |
Acc-17 | Account - Optional | Servicer | Y | OBReadAccount4/Data/Account/Servicer |
Acc-18 | Account - Mandatory | SchemeName | Y | OBReadAccount4/Data/Account/Servicer/SchemeName |
Acc-19 | Account - Mandatory | Identification | Y | OBReadAccount4/Data/Account/Servicer/Identification |
Balances Fields
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Bal-1 | Balances - Mandatory | OBReadBalance1 | Y | OBReadBalance1 |
Bal-2 | Balances - Mandatory | Data | Y | OBReadBalance1/Data |
Bal-3 | Balances - Mandatory | Balance | Y | OBReadBalance1/Data/Balance |
Bal-4 | Balances - Mandatory | AccountId | Y | OBReadBalance1/Data/Balance/AccountId |
Bal-5 | Balances - Mandatory | CreditDebitIndicator | Y | OBReadBalance1/Data/Balance/CreditDebitIndicator |
Bal-6 | Balances - Mandatory | Type | Y | OBReadBalance1/Data/Balance/Type |
Bal-7 | Balances - Mandatory | DateTime | Y | OBReadBalance1/Data/Balance/DateTime |
Bal-8 | Balances - Mandatory | Amount | Y | OBReadBalance1/Data/Balance/Amount |
Bal-9 | Balances - Mandatory | Amount | Y | OBReadBalance1/Data/Balance/Amount/Amount |
Bal-10 | Balances - Mandatory | Currency | Y | OBReadBalance1/Data/Balance/Amount/Currency |
Bal-11 | Balances - Optional | CreditLine | N | OBReadBalance1/Data/Balance/CreditLine |
Bal-12 | Balances - Mandatory | Included | N | OBReadBalance1/Data/Balance/CreditLine/Included |
Bal-13 | Balances - Optional | Type | N | OBReadBalance1/Data/Balance/CreditLine/Type |
Bal-14 | Balances - Optional | Amount | N | OBReadBalance1/Data/Balance/CreditLine/AmountAmount of money of the credit line. |
Bal-15 | Balances - Mandatory | Amount | N | OBReadBalance1/Data/Balance/CreditLine/Amount/Amount |
Bal-16 | Balances - Mandatory | Currency | N | OBReadBalance1/Data/Balance/CreditLine/Amount/Currency |
Beneficiaries Fields
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Ben-1 | Beneficiaries - Mandatory | OBReadBeneficiary3 | Y | OBReadBeneficiary3 |
Ben-2 | Beneficiaries - Mandatory | Data | Y | OBReadBeneficiary3/Data |
Ben-3 | Beneficiaries - Optional | Beneficiary | Y | OBReadBeneficiary3/Data/Beneficiary |
Ben-4 | Beneficiaries - Optional | AccountId | Y | OBReadBeneficiary3/Data/Beneficiary/AccountId A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. |
Ben-5 | Beneficiaries - Optional | BeneficiaryId | N | OBReadBeneficiary3/Data/Beneficiary/BeneficiaryId A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner. |
Ben-6 | Beneficiaries - Optional | Reference | Y | OBReadBeneficiary3/Data/Beneficiary/Reference Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. |
Ben-7 | Beneficiaries - Optional | CreditorAgent | Y | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent 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. |
Ben-8 | Beneficiaries - Optional | SchemeName | N | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/SchemeName Name of the identification scheme, in a coded form as published in an external list. |
Ben-9 | Beneficiaries - Optional | Identification | Y | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/Identification Unique and unambiguous identification of the servicing institution. |
Ben-10 | Beneficiaries - Optional | Name | Y | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/Name Name by which an agent is known and which is usually used to identify that agent. |
Ben-11 | Beneficiaries - Optional | PostalAddress | N | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/PostalAddress Information that locates and identifies a specific address, as defined by postal services. |
Ben-12 | Beneficiaries - Optional | AddressType | N | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/PostalAddress/AddressType Identifies the nature of the postal address. |
Ben-13 | Beneficiaries - Optional | Department | N | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/PostalAddress/Department Identification of a division of a large organisation or building. |
Ben-14 | Beneficiaries - Optional | SubDepartment | N | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/PostalAddress/SubDepartment Identification of a sub-division of a large organisation or building. |
Ben-15 | Beneficiaries - Optional | StreetName | N | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/PostalAddress/StreetName Name of a street or thoroughfare. |
Ben-16 | Beneficiaries - Optional | BuildingNumber | N | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/PostalAddress/BuildingNumber Number that identifies the position of a building on a street. |
Ben-17 | Beneficiaries - Optional | PostCode | N | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/PostalAddress/PostCode Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. |
Ben-18 | Beneficiaries - Optional | TownName | N | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/PostalAddress/TownName Name of a built-up area, with defined boundaries, and a local government. |
Ben-19 | Beneficiaries - Optional | CountrySubDivision | N | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/PostalAddress/CountrySubDivision Identifies a subdivision of a country such as state, region, county. |
Ben-20 | Beneficiaries - Optional | Country | Y | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/PostalAddress/Country Nation with its own government. |
Ben-21 | Beneficiaries - Optional | AddressLine | N | OBReadBeneficiary3/Data/Beneficiary/CreditorAgent/PostalAddress/AddressLine Information that locates and identifies a specific address, as defined by postal services, presented in free format text. |
Ben-22 | Beneficiaries - Optional | CreditorAccount | Y | OBReadBeneficiary3/Data/Beneficiary/CreditorAccount Provides the details to identify the beneficiary account. |
Ben-23 | Beneficiaries - Mandatory | SchemeName | Y | OBReadBeneficiary3/Data/Beneficiary/CreditorAccount/SchemeName Name of the identification scheme, in a coded form as published in an external list. |
Ben-24 | Beneficiaries - Mandatory | Identification | Y | OBReadBeneficiary3/Data/Beneficiary/CreditorAccount/Identification Identification assigned by an institution to identify an account. This identification is known by the account owner. |
Ben-25 | Beneficiaries - Optional | Name | Y | OBReadBeneficiary3/Data/Beneficiary/CreditorAccount/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. |
Ben-26 | Beneficiaries - Optional | SecondaryIdentification | N | OBReadBeneficiary3/Data/Beneficiary/CreditorAccount/SecondaryIdentification This is secondary identification of the account, as assigned by the account servicing institution. |
Direct Debits Fields
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
DD-1 | Direct Debit - Mandatory | OBReadDirectDebit1 | Y | OBReadDirectDebit1 |
DD-2 | Direct Debit - Mandatory | Data | Y | OBReadDirectDebit1/Data |
DD-3 | Direct Debit - Optional | DirectDebit | Y | OBReadDirectDebit1/Data/DirectDebit Account to or from which a cash entry is made. |
DD-4 | Direct Debit - Mandatory | AccountId | Y | OBReadDirectDebit1/Data/DirectDebit/AccountId A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. |
DD-5 | Direct Debit - Optional | DirectDebitId | N | OBReadDirectDebit1/Data/DirectDebit/DirectDebitId A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner. |
DD-6 | Direct Debit - Mandatory | MandateIdentification | Y | OBReadDirectDebit1/Data/DirectDebit/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. |
DD-7 | Direct Debit - Optional | DirectDebitStatusCode | Y | OBReadDirectDebit1/Data/DirectDebit/DirectDebitStatusCode Specifies the status of the direct debit in code form. |
DD-8 | Direct Debit - Mandatory | Name | Y | OBReadDirectDebit1/Data/DirectDebit/Name Name of Service User. |
DD-9 | Direct Debit - Optional | PreviousPaymentDateTime | Y | OBReadDirectDebit1/Data/DirectDebit/PreviousPaymentDateTime |
DD-10 | Direct Debit - Optional | PreviousPaymentAmount | Y | OBReadDirectDebit1/Data/DirectDebit/PreviousPaymentAmount |
DD-11 | Direct Debit - Mandatory | Amount | Y | OBReadDirectDebit1/Data/DirectDebit/PreviousPaymentAmount/Amount |
DD-12 | Direct Debit - Mandatory | Currency | Y | OBReadDirectDebit1/Data/DirectDebit/PreviousPaymentAmount/Currency |
Products Fields
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Prod 1 | Products - Mandatory | OBReadProduct2 | Y | OBReadProduct2 |
Prod 2 | Products - Mandatory | Data | Y | OBReadProduct2/Data |
Prod 3 | Products - Optional | Product | Y | OBReadProduct2/Data/Product |
Prod 4 | Products - Mandatory | AccountId | Y | OBReadProduct2/Data/Product/AccountId A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. |
Prod 5 | Products - Mandatory | ProductId | Y - only if product in Open Data API | OBReadProduct2/Data/Product/ProductIdr Identifier within the parent organisation for the product. Must be unique in the organisation. |
Prod 6 | Products - Mandatory | ProductType | Y | OBReadProduct2/Data/Product/ProductType Descriptive code for the product category. |
Prod 7 | Products - Optional | ProductName | Y | OBReadProduct2/Data/Product/ProductName The name of the product used for marketing purposes from a customer perspective. I.e. what the customer would recognise. |
Prod 8 | Products - Optional | SecondaryProductId | N | OBReadProduct2/Data/Product/SecondaryProductId Identifier within the parent organisation for the product. Must be unique in the organisation. |
Prod 9 | Products - Optional | MarketingStateId | Y | OBReadProduct2/Data/Product/MarketingStateId Unique and unambiguous identification of a BCA Product Marketing State. |
Prod 10 | Product - Mandatory | OtherProductType | Y | OBReadProduct2/Data/Product/OtherProductType 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 |
Prod 11 | Product - Mandatory | Name | Y | OBReadProduct2/Data/Product/OtherProductType/Name
|
Prod 12 | Product - Mandatory | Description | Y | OBReadProduct2/Data/Product/OtherProductType/Description |
Prod 13 | Product - Mandatory | BCA | Y | OBReadProduct2/Data/Product/BCA |
Prod 14 | Product - Mandatory | PCA | Y | OBReadProduct2/Data/Product/PCA |
Prod 15 | Product - Optional | ProductDetails | N | OBReadProduct2/Data/Product/BCA/ProductDetails |
Prod 16 | Product – Optional | Segment | N | OBReadProduct2/Data/Product/BCA/ProductDetails/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. |
Prod 17 | Product – Optional | FeeFreeLength | N | OBReadProduct2/Data/Product/BCA/ProductDetails/FeeFreeLength The length/duration of the fee free perdiod |
Prod 18 | Product – Optional | FeeFreeLengthPeriod | N | OBReadProduct2/Data/Product/BCA/ProductDetails/FeeFreeLengthPeriod The unit of period (days, weeks, months etc.) of the promotional length |
Prod 19 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/ProductDetails/Notes |
Prod 20 | Product – Optional | CreditInterest | N | OBReadProduct2/Data/Product/BCA/CreditInterest |
Prod 21 | Product – Optional | TierBandSet | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet |
Prod 22 | Product – Mandatory | TierBandMethod | Y | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBandMethod 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 BCA balance |
Prod 23 | Product – Optional | CalculationMethod | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/CalculationMethod Methods of calculating interest |
Prod 24 | Product – Mandatory | Destination | Y | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/Destination Describes whether accrued interest is payable only to the BCA or to another bank account |
Prod 25 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/Notes |
Prod 26 | Product – Optional | TierBand | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand |
Prod 27 | Product – Optional | Identification | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/Identification Unique and unambiguous identification of a Tier Band for a BCA. |
Prod 28 | Product – Mandatory | TierValueMinimum | Y | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/TierValueMinimum Minimum deposit value for which the credit interest tier applies. |
Prod 29 | Product – Optional | TierValueMaximum | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/TierValueMaximum Maximum deposit value for which the credit interest tier applies. |
Prod 30 | Product – Optional | CalculationFrequency | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/CalculationFrequency How often is credit interest calculated for the account. |
Prod 31 | Product – Mandatory | ApplicationFrequency | Y | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/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. |
Prod 32 | Product – Optional | DepositInterestAppliedCoverage | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/DepositInterestAppliedCoverage Amount on which Interest applied. |
Prod 33 | Product – Mandatory | FixedVariableInterestRateType | Y | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/FixedVariableInterestRateType Type of interest rate, Fixed or Variable |
Prod 34 | Product – Mandatory | AER | Y | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/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. |
Prod 35 | Product – Optional | BankInterestRateType | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/BankInterestRateType Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payble to the BCA. |
Prod 36 | Product – Optional | BankInterestRate | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/BankInterestRate Bank Interest for the BCA product |
Prod 37 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/Notes Optional additional notes to supplement the Tier Band details |
Prod 38 | Product – Optional | OtherBankInterestType | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/OtherBankInterestType |
Prod 39 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/OtherBankInterestType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 40 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/OtherBankInterestType/Description Description to describe the purpose of the code |
Prod 41 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/OtherBankInterestType/Name Long name associated with the code |
Prod 42 | Product – Optional | OtherApplicationFrequency | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/OtherApplicationFrequency |
Prod 43 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/OtherApplicationFrequency/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 44 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/OtherApplicationFrequency/Description Description to describe the purpose of the code |
Prod 45 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/OtherApplicationFrequency/Name Long name associated with the code |
Prod 46 | Product – Optional | OtherCalculationFrequency | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/OtherCalculationFrequency |
Prod 47 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/OtherCalculationFrequency/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 48 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/OtherCalculationFrequency/Description Description to describe the purpose of the code |
Prod 49 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/CreditInterest/TierBandSet/TierBand/OtherCalculationFrequency/Name Long name associated with the code |
Prod 50 | Product – Optional | Overdraft | N | OBReadProduct2/Data/Product/BCA/Overdraft |
Prod 51 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/Overdraft/Notes Associated Notes about the overdraft rates |
Prod 52 | Product – Optional | OverdraftTierBandSet | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet |
Prod 53 | Product – Mandatory | TierBandMethod | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/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." |
Prod 54 | Product – Optional | OverdraftType | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/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. |
Prod 55 | Product – Optional | Identification | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/Identification Unique and unambiguous identification of a Tier Band for a overdraft product. |
Prod 56 | Product – Optional | AuthorisedIndicator | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/AuthorisedIndicator Indicates if the Overdraft is authorised (Y) or unauthorised (N) |
Prod 57 | Product – Optional | BufferAmount | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/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. |
Prod 58 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/Notes Optional additional notes to supplement the overdraft Tier Band Set details |
Prod 59 | Product – Optional | OverdraftTierBand | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand |
Prod 60 | Product – Optional | Identification | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/Identification Unique and unambiguous identification of a Tier Band for a overdraft. |
Prod 61 | Product – Optional | TierValueMax | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/TierValueMax Maximum value of Overdraft Tier/Band |
Prod 62 | Product – Mandatory | TierValueMin | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/TierValueMin Minimum value of Overdraft Tier/Band |
Prod 63 | Product – Optional | EAR | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/EAR "EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft." |
Prod 64 | Product – Optional | AgreementLengthMax | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/AgreementLengthMax Specifies the maximum length of a band for a fixed overdraft agreement |
Prod 65 | Product – Optional | AgreementLengthMin | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/AgreementLengthMin Specifies the minimum length of a band for a fixed overdraft agreement |
Prod 66 | Product – Optional | AgreementPeriod | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/AgreementPeriod Specifies the period of a fixed length overdraft agreement |
Prod 67 | Product – Optional | OverdraftInterestChargingCoverage | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/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’. |
Prod 68 | Product – Optional | BankGuaranteedIndicator | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/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. |
Prod 69 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/Notes Optional additional notes to supplement the Tier/band details |
Prod 70 | Product – Optional | OverdraftFeesCharges | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges |
Prod 71 | Product – Optional | OverdraftFeeChargeCap | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeCap |
Prod 72 | Product - Mandatory | FeeType | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeCap/FeeType Fee/charge type which is being capped |
Prod 73 | Product – Mandatory | MinMaxType | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeCap/MinMaxType Min Max type |
Prod 74 | Product – Optional | FeeCapOccurrence | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeCap/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. |
Prod 75 | Product – Optional | FeeCapAmount | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeCap/FeeCapAmount Cap amount charged for a fee/charge |
Prod 76 | Product – Optional | CappingPeriod | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeCap/CappingPeriod Period e.g. day, week, month etc. for which the fee/charge is capped |
Prod 77 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeCap/Notes Notes related to Overdraft fee charge cap |
Prod 78 | Product – Optional | OtherFeeType | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeCap/OtherFeeType |
Prod 79 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeCap/OtherFeeType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 80 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeCap/OtherFeeType/Name Long name associated with the code |
Prod 81 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeCap/OtherFeeType/Description Description to describe the purpose of the code |
Prod 82 | Product – Optional | OverdraftFeeChargeDetail | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail |
Prod 83 | Product – Mandatory | FeeType | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/FeeType Overdraft fee type |
Prod 84 | Product – Optional | NegotiableIndicator | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/NegotiableIndicator Indicates whether fee and charges are negotiable |
Prod 85 | Product – Optional | OverdraftControlIndicator | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftControlIndicator Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. |
Prod 86 | Product – Optional | IncrementalBorrowingAmount | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/IncrementalBorrowingAmount Every additional tranche of an overdraft balance to which an overdraft fee is applied |
Prod 87 | Product – Optional | FeeAmount | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/FeeAmount Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) |
Prod 88 | Product – Optional | FeeRate | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/FeeRate Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) |
Prod 89 | Product – Optional | FeeRateType | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/FeeRateType Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) |
Prod 90 | Product – Mandatory | ApplicationFrequency | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/ApplicationFrequency Frequency at which the overdraft charge is applied to the account |
Prod 91 | Product – Optional | CalculationFrequency | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/CalculationFrequency How often is the overdraft fee/charge calculated for the account. |
Prod 92 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/Notes Free text for capturing any other info related to Overdraft Fees Charge Details |
Prod 93 | Product – Optional | OverdraftFeeChargeCap | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap |
Prod 94 | Product – Mandatory | FeeType | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/FeeType Fee/charge type which is being capped |
Prod 95 | Product – Mandatory | MinMaxType | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/MinMaxType Min Max type |
Prod 96 | Product – Optional | FeeCapOccurrence | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/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. |
Prod 97 | Product – Optional | FeeCapAmount | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/FeeCapAmount Cap amount charged for a fee/charge |
Prod 98 | Product – Optional | CappingPeriod | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/CappingPeriod Period e.g. day, week, month etc. for which the fee/charge is capped |
Prod 99 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/Notes Notes related to Overdraft fee charge cap |
Prod 100 | Product – Optional | OtherFeeType | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/OtherFeeType |
Prod 101 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/OtherFeeType/Code |
Prod 102 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/OtherFeeType/Name Long name associated with the code |
Prod 103 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/OtherFeeType/Description Description to describe the purpose of the code |
Prod 104 | Product – Optional | OtherFeeType | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeType |
Prod 105 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 106 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeType/Name Long name associated with the code |
Prod 107 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeType/Description Description to describe the purpose of the code |
Prod 108 | Product – Optional | OtherFeeRateType | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeRateType |
Prod 109 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeRateType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 110 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeRateType/Name Long name associated with the code |
Prod 111 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeRateType/Description Description to describe the purpose of the code |
Prod 112 | Product – Optional | OtherApplicationFrequency | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherApplicationFrequency |
Prod 113 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherApplicationFrequency/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 114 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherApplicationFrequency/Name Long name associated with the code |
Prod 115 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherApplicationFrequency/Description Description to describe the purpose of the code |
Prod 116 | Product – Optional | OtherCalculationFrequency | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherCalculationFrequency |
Prod 117 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherCalculationFrequency/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 118 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherCalculationFrequency/Name Long name associated with the code |
Prod 119 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftTierBand/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherCalculationFrequency/Description Description to describe the purpose of the code |
Prod 120 | Product – Optional | OverdraftFeesCharges | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges |
Prod 121 | Product – Optional | OverdraftFeeChargeCap | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeCap |
Prod 122 | Product – Mandatory | FeeType | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeCap/FeeType Fee/charge type which is being capped |
Prod 123 | Product – Mandatory | MinMaxType | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeCap/MinMaxType Min Max type |
Prod 124 | Product – Optional | FeeCapOccurrence | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeCap/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. |
Prod 125 | Product – Optional | FeeCapAmount | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeCap/FeeCapAmount Cap amount charged for a fee/charge |
Prod 126 | Product – Optional | CappingPeriod | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeCap/CappingPeriod Period e.g. day, week, month etc. for which the fee/charge is capped |
Prod 127 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeCap/Notes Notes related to Overdraft fee charge cap |
Prod 128 | Product – Optional | OtherFeeType | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeCap/OtherFeeType |
Prod 129 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeCap/OtherFeeType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 130 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeCap/OtherFeeType/Name Long name associated with the code |
Prod 131 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeCap/OtherFeeType/Description Description to describe the purpose of the code |
Prod 132 | Product – Optional | OverdraftFeeChargeDetail | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail |
Prod 133 | Product – Mandatory | FeeType | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/FeeType Overdraft fee type |
Prod 134 | Product – Optional | NegotiableIndicator | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/NegotiableIndicator Indicates whether fee and charges are negotiable |
Prod 135 | Product – Optional | OverdraftControlIndicator | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftControlIndicator Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. |
Prod 136 | Product – Optional | IncrementalBorrowingAmount | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/IncrementalBorrowingAmount Every additional tranche of an overdraft balance to which an overdraft fee is applied |
Prod 137 | Product – Optional | FeeAmount | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/FeeAmount Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) |
Prod 138 | Product – Optional | FeeRate | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/FeeRate Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) |
Prod 139 | Product – Optional | FeeRateType | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/FeeRateType Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) |
Prod 140 | Product – Mandatory | ApplicationFrequency | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/ApplicationFrequency Frequency at which the overdraft charge is applied to the account |
Prod 141 | Product – Optional | CalculationFrequency | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/CalculationFrequency How often is the overdraft fee/charge calculated for the account. |
Prod 142 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/Notes Free text for capturing any other info related to Overdraft Fees Charge Details |
Prod 143 | Product – Optional | OverdraftFeeChargeCap | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap |
Prod 144 | Product – Mandatory | FeeType | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/FeeType Fee/charge type which is being capped |
Prod 145 | Product – Mandatory | MinMaxType | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/MinMaxType Min Max type |
Prod 146 | Product – Optional | FeeCapOccurrence | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/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. |
Prod 147 | Product – Optional | FeeCapAmount | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/FeeCapAmount Cap amount charged for a fee/charge |
Prod 148 | Product – Optional | CappingPeriod | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/CappingPeriod Period e.g. day, week, month etc. for which the fee/charge is capped |
Prod 149 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/Notes Notes related to Overdraft fee charge cap |
Prod 150 | Product – Optional | OtherFeeType | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/OtherFeeType |
Prod 151 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/OtherFeeType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 152 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/OtherFeeType/Name Long name associated with the code |
Prod 153 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OverdraftFeeChargeCap/OtherFeeType/Description Description to describe the purpose of the code |
Prod 154 | Product – Optional | OtherFeeType | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeType |
Prod 155 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 156 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeType/Name Long name associated with the code |
Prod 157 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeType/Description Description to describe the purpose of the code |
Prod 158 | Product – Optional | OtherFeeRateType | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeRateType |
Prod 159 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeRateType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 160 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeRateType/Name Long name associated with the code |
Prod 161 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherFeeRateType/Description Description to describe the purpose of the code |
Prod 162 | Product – Optional | OtherApplicationFrequency | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherApplicationFrequency |
Prod 163 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherApplicationFrequency/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 164 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherApplicationFrequency/Name Long name associated with the code |
Prod 165 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherApplicationFrequency/Description |
Prod 166 | Product – Optional | OtherCalculationFrequency | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherCalculationFrequency |
Prod 167 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherCalculationFrequency/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 168 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherCalculationFrequency/Name Long name associated with the code |
Prod 169 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/Overdraft/OverdraftTierBandSet/OverdraftFeesCharges/OverdraftFeeChargeDetail/OtherCalculationFrequency/Description Description to describe the purpose of the code |
Prod 170 | Product – Optional | OtherFeesCharges | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges |
Prod 171 | Product – Optional | TariffType | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/TariffType TariffType which defines the fee and charges. |
Prod 172 | Product – Optional | TariffName | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/TariffName Name of the tariff |
Prod 173 | Product – Optional | OtherTariffType | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/OtherTariffType |
Prod 174 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/OtherTariffType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 175 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/OtherTariffType/Name Long name associated with the code |
Prod 176 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/OtherTariffType/Description Description to describe the purpose of the code |
Prod 177 | Product – Optional | FeeChargeDetail | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail |
Prod 178 | Product – Mandatory | FeeCategory | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeCategory Categorisation of fees and charges into standard categories. |
Prod 179 | Product – Mandatory | FeeType | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeType Fee/Charge Type |
Prod 180 | Product – Optional | NegotiableIndicator | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/NegotiableIndicator Fee/charge which is usually negotiable rather than a fixed amount |
Prod 181 | Product – Optional | FeeAmount | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeAmount Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) |
Prod 182 | Product – Optional | FeeRate | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeRate Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) |
Prod 183 | Product – Optional | FeeRateType | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeRateType Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) |
Prod 184 | Product – Mandatory | ApplicationFrequency | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/ApplicationFrequency How frequently the fee/charge is applied to the account |
Prod 185 | Product – Optional | CalculationFrequency | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/CalculationFrequency How frequently the fee/charge is calculated |
Prod 186 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/Notes Optional additional notes to supplement the fee/charge details. |
Prod 187 | Product – Optional | FeeChargeCap | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeChargeCap |
Prod 188 | Product – Mandatory | FeeType | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeChargeCap/FeeType Fee/charge type which is being capped |
Prod 189 | Product – Mandatory | MinMaxType | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeChargeCap/MinMaxType Min Max type |
Prod 190 | Product – Optional | FeeCapOccurrence | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeChargeCap/FeeCapOccurrence fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount |
Prod 191 | Product – Optional | FeeCapAmount | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeChargeCap/FeeCapAmount Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) |
Prod 192 | Product – Optional | CappingPeriod | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeChargeCap/CappingPeriod Period e.g. day, week, month etc. for which the fee/charge is capped |
Prod 193 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeChargeCap/Notes Free text for adding extra details for fee charge cap |
Prod 194 | Product – Optional | OtherFeeType | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeChargeCap/OtherFeeType |
Prod 195 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeChargeCap/OtherFeeType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 196 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeChargeCap/OtherFeeType/Name Long name associated with the code |
Prod 197 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeChargeCap/OtherFeeType/Description Description to describe the purpose of the code |
Prod 198 | Product – Optional | OtherFeeCategoryType | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeCategoryType |
Prod 199 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeCategoryType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 200 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeCategoryType/Name Long name associated with the code |
Prod 201 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeCategoryType/Description Description to describe the purpose of the code |
Prod 202 | Product – Optional | OtherFeeType | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeType |
Prod 203 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 204 | Product – Mandatory | FeeCategory | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeType/FeeCategory Categorisation of fees and charges into standard categories. |
Prod 205 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeType/Name Long name associated with the code |
Prod 206 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeType/Description Description to describe the purpose of the code |
Prod 207 | Product – Optional | OtherFeeRateType | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeRateType |
Prod 208 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeRateType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 209 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeRateType/Name Long name associated with the code |
Prod 210 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherFeeRateType/Description Description to describe the purpose of the code |
Prod 211 | Product – Optional | OtherApplicationFrequency | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherApplicationFrequency |
Prod 212 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherApplicationFrequency/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 213 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherApplicationFrequency/Name Long name associated with the code |
Prod 214 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherApplicationFrequency/Description Description to describe the purpose of the code |
Prod 215 | Product – Optional | OtherCalculationFrequency | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherCalculationFrequency |
Prod 216 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherCalculationFrequency/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 217 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherCalculationFrequency/Name Long name associated with the code |
Prod 218 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/OtherCalculationFrequency/Description Description to describe the purpose of the code |
Prod 219 | Product – Optional | FeeApplicableRange | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeApplicableRange |
Prod 220 | Product – Optional | MinimumAmount | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeApplicableRange/MinimumAmount Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) |
Prod 221 | Product – Optional | MaximumAmount | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeApplicableRange/MaximumAmount Maximum Amount on which fee is applicable (where it is expressed as an amount) |
Prod 222 | Product – Optional | MinimumRate | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeApplicableRange/MinimumRate Minimum rate on which fee/charge is applicable(where it is expressed as an rate) |
Prod 223 | Product – Optional | MaximumRate | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeDetail/FeeApplicableRange/MaximumRate Maximum rate on which fee/charge is applicable(where it is expressed as an rate) |
Prod 224 | Product – Optional | FeeChargeCap | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeCap |
Prod 225 | Product – Mandatory | FeeType | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeCap/FeeType Fee/charge type which is being capped |
Prod 226 | Product – Mandatory | MinMaxType | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeCap/MinMaxType Min Max type |
Prod 227 | Product – Optional | FeeCapOccurrence | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeCap/FeeCapOccurrence fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount |
Prod 228 | Product – Optional | FeeCapAmount | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeCap/FeeCapAmount Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) |
Prod 229 | Product – Optional | CappingPeriod | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeCap/CappingPeriod Period e.g. day, week, month etc. for which the fee/charge is capped |
Prod 230 | Product – Optional | Notes | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeCap/Notes Free text for adding extra details for fee charge cap |
Prod 231 | Product – Optional | OtherFeeType | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeCap/OtherFeeType |
Prod 232 | Product – Optional | Code | N | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeCap/OtherFeeType/Code The four letter Mnemonic used within an XML file to identify a code |
Prod 233 | Product – Mandatory | Name | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeCap/OtherFeeType/Name Long name associated with the code |
Prod 234 | Product – Mandatory | Description | Y | OBReadProduct2/Data/Product/BCA/OtherFeesCharges/FeeChargeCap/OtherFeeType/Description Description to describe the purpose of the code |
N.B. Same logic applies to PCA from Prod 11 to Prod 234
Standing Orders Fields
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
SO-1 | Standing Order - Mandatory | OBReadStandingOrder5 | Y | OBReadStandingOrder5 |
SO-2 | Standing Order - Mandatory | Data | Y | OBReadStandingOrder5/Data |
SO-3 | Standing Order - Optional | StandingOrder | Y | OBReadStandingOrder5/Data/StandingOrder |
SO-4 | Standing Order - Mandatory | AccountId | Y | OBReadStandingOrder5/Data/StandingOrder/AccountId A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. |
SO-5 | Standing Order - Optional | StandingOrderId | N | OBReadStandingOrder5/Data/StandingOrder/StandingOrderId A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner. |
SO-6 | Standing Order - Mandatory | Frequency | Y | OBReadStandingOrder5/Data/StandingOrder/Frequency |
SO-7 | Standing Order - Optional | Reference | Y | OBReadStandingOrder5/Data/StandingOrder/Reference Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. |
SO-8 | Standing Order - Optional | FirstPaymentDateTime | Y | OBReadStandingOrder5/Data/StandingOrder/FirstPaymentDateTime The date on which the first payment for a Standing Order schedule will be made. |
SO-9 | Standing Order - Optional | NextPaymentDateTime | Y | OBReadStandingOrder5/Data/StandingOrder/NextPaymentDateTime The date on which the next payment for a Standing Order schedule will be made. |
SO-10 | Standing Order - Optional | FinalPaymentDateTime | Y | OBReadStandingOrder5/Data/StandingOrder/FinalPaymentDateTime The date on which the final payment for a Standing Order schedule will be made. |
SO-11 | Standing Order - Optional | StandingOrderStatusCode | Y | OBReadStandingOrder5/Data/StandingOrder/StandingOrderStatusCode Specifies the status of the standing order in code form. |
SO-12 | Standing Order - Optional | FirstPaymentAmount | Y | OBReadStandingOrder5/Data/StandingOrder/FirstPaymentAmount The amount of the first Standing Order |
SO-13 | Standing Order - Mandatory | Amount | Y | OBReadStandingOrder5/Data/StandingOrder/FirstPaymentAmount/Amount A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. |
SO-14 | Standing Order - Mandatory | Currency | Y | OBReadStandingOrder5/Data/StandingOrder/FirstPaymentAmount/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". |
SO-15 | Standing Order - Optional | NextPaymentAmount | Y | OBReadStandingOrder5/Data/StandingOrder/NextPaymentAmount The amount of the next Standing Order. |
SO-16 | Standing Order - Mandatory | Amount | Y | OBReadStandingOrder5/Data/StandingOrder/NextPaymentAmount/Amount A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. |
SO-17 | Standing Order - Mandatory | Currency | Y | OBReadStandingOrder5/Data/StandingOrder/NextPaymentAmount/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". |
SO-18 | Standing Order - Optional | FinalPaymentAmount | Y | OBReadStandingOrder5/Data/StandingOrder/FinalPaymentAmount The amount of the final Standing Order |
SO-19 | Standing Order - Mandatory | Amount | Y | OBReadStandingOrder5/Data/StandingOrder/FinalPaymentAmount/Amount A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. |
SO-20 | Standing Order - Mandatory | Currency | Y | OBReadStandingOrder5/Data/StandingOrder/FinalPaymentAmount/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". |
SO-21 | Standing Order - Optional | CreditorAgent | N | OBReadStandingOrder5/Data/StandingOrder/CreditorAgent 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. |
SO-22 | Standing Order - Mandatory | SchemeName | N | OBReadStandingOrder5/Data/StandingOrder/CreditorAgent/SchemeName Name of the identification scheme, in a coded form as published in an external list. |
SO-23 | Standing Order - Mandatory | Identification | N | OBReadStandingOrder5/Data/StandingOrder/CreditorAgent/Identification Unique and unambiguous identification of the servicing institution. |
SO-24 | Standing Order - Optional | CreditorAccount | Y | OBReadStandingOrder5/Data/StandingOrder/CreditorAccount Provides the details to identify the beneficiary account. |
SO-25 | Standing Order - Mandatory | SchemeName | Y | OBReadStandingOrder5/Data/StandingOrder/CreditorAccount/SchemeName Name of the identification scheme, in a coded form as published in an external list. |
SO-26 | Standing Order - Mandatory | Identification | Y | OBReadStandingOrder5/Data/StandingOrder/CreditorAccount/Identification Beneficiary account identification. |
SO-27 | Standing Order - Optional | Name | Y | OBReadStandingOrder5/Data/StandingOrder/CreditorAccount/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. |
SO-28 | Standing Order - Optional | SecondaryIdentification | N | OBReadStandingOrder5/Data/StandingOrder/CreditorAccount/SecondaryIdentification This is secondary identification of the account, as assigned by the account servicing institution. |
SO-29 | Standing Order - Optional | SupplementaryData | N | OBReadStandingOrder5/Data/StandingOrder/SupplementaryData Additional information that can not be captured in the structured fields and/or any other specific block. |
Statements Fields
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Stat 1 | Statements -Conditional | OBReadStatement1 | Y | OBReadStatement1 |
Stat 2 | Statements -Conditional | Data | Y | OBReadStatement1/Data |
Stat 3 | Statements - Optional | Statement | Y | OBReadStatement1/Data/Statement |
Stat 4 | Statements - Mandatory | AccountId | Y | OBReadStatement1/Data/Statement/AccountId A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. |
Stat 5 | Statements - optional | StatementId | N | OBReadStatement1/Data/Statement/StatementId Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable. |
Stat 6 | Statements - Optional | StatementReference | N | OBReadStatement1/Data/Statement/StatementReference Unique reference for the statement. This reference may be optionally populated if available. |
Stat 7 | Statements - Mandatory | Type | Y | OBReadStatement1/Data/Statement/Type Statement type, in a coded form.. |
Stat 8 | Statements - mandatory | StartDateTime | Y | OBReadStatement1/Data/Statement/StartDateTime Date and time at which the statement period starts.. |
Stat 9 | Statements - mandatory | EndDateTime | Y | OBReadStatement1/Data/Statement/EndDateTime Date and time at which the statement period ends. |
Stat 10 | Statements - mandatory | CreationDateTime | Y | OBReadStatement1/Data/Statement/CreationDateTime Date and time at which the resource was created. |
Stat 11 | Statements - optional | StatementDescription | N | OBReadStatement1/Data/Statement/StatementDescription |
Stat 12 | Statements - optional | StatementBenefit | Y | OBReadStatement1/Data/Statement/StatementBenefit |
Stat 13 | Statements - mandatory | Type | Y | OBReadStatement1/Data/Statement/StatementBenefit/Type |
Stat 14 | Statements - mandatoryl | Amount | Y | OBReadStatement1/Data/Statement/StatementBenefit/Amount |
Stat 15 | Statements - mandatory | Amount | Y | OBReadStatement1/Data/Statement/StatementBenefit/Amount/Amount |
Stat 16 | Statements - mandatory | Currency | Y | OBReadStatement1/Data/Statement/StatementBenefit/Amount/Currency |
Stat 17 | Statements - optional | StatementFee | N | OBReadStatement1/Data/Statement/StatementFee |
Stat 18 | Statements - optional | StatementInterest | N | OBReadStatement1/Data/Statement/StatementInterest |
Stat 19 | Statements - optional | StatementAmount | Y | OBReadStatement1/Data/Statement/StatementAmount |
Stat 20 | Statements - mandatory | CreditDebitIndicator | Y | OBReadStatement1/Data/Statement/StatementAmount/CreditDebitIndicator |
Stat 21 | Statements - mandatory | Type | Y | OBReadStatement1/Data/Statement/StatementAmount/Type |
Stat 22 | Statements - mandatory | Amount | Y | OBReadStatement1/Data/Statement/StatementAmount/Amount |
Stat 23 | Statements - mandatory | Amount | Y | OBReadStatement1/Data/Statement/StatementAmount/Amount/Amount |
Stat 24 | Statements - mandatory | Currency | Y | OBReadStatement1/Data/Statement/StatementAmount/Amount/Currency |
Stat 25 | Statements - optional | StatementDateTime | N | OBReadStatement1/Data/Statement/StatementDateTime |
Stat 26 | Statements - optional | StatementRate | N | OBReadStatement1/Data/Statement/StatementRate |
Stat 27 | Statements - optional | StatementValue | N | OBReadStatement1/Data/Statement/StatementValue |
Transactions Fields
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Tran-1 | Transactions - Mandatory | OBReadTransaction5 | Y | OBReadTransaction5 |
Tran-2 | Transactions - Mandatory | Data | Y | OBReadTransaction5/Data |
Tran-3 | Transactions - Optional | Transaction | Y | OBReadTransaction5/Data/Transaction |
Tran-4 | Transactions - Mandatory | AccountId | Y | OBReadTransaction5/Data/Transaction/AccountId |
Tran-5 | Transactions - Optional | TransactionId | Y | OBReadTransaction5/Data/Transaction/TransactionId |
Tran-6 | Transactions - Optional | TransactionReference | Y | OBReadTransaction5/Data/Transaction/TransactionReference |
Tran-7 | Transactions - Optional | StatementReference | N | OBReadTransaction5/Data/Transaction/StatementReference |
Tran-8 | Transactions - Mandatory | CreditDebitIndicator | Y | OBReadTransaction5/Data/Transaction/CreditDebitIndicator |
Tran-9 | Transactions - Mandatory | Status | Y | OBReadTransaction5/Data/Transaction/Status |
Tran-10 | Transactions - Mandatory | BookingDateTime | Y | OBReadTransaction5/Data/Transaction/BookingDateTimeDate and time when a transaction entry is posted to an account on the account servicer's books. |
Tran-11 | Transactions - Optional | TransactionInformation | Y | OBReadTransaction5/Data/Transaction/TransactionInformation |
Tran-12 | Transactions - Optional | AddressLine | N | OBReadTransaction5/Data/Transaction/AddressLine |
Tran-13 | Transactions - Mandatory | Amount | Y | OBReadTransaction5/Data/Transaction/Amount |
Tran-14 | Transactions - Mandatory | Amount | Y | OBReadTransaction5/Data/Transaction/Amount/Amount |
Tran-15 | Transactions - Mandatory | Currency | Y | OBReadTransaction5/Data/Transaction/Amount/Currency |
Tran-16 | Transactions - Optional | ChargeAmount | Y | OBReadTransaction5/Data/Transaction/ChargeAmount |
Tran-17 | Transactions - Mandatory | Amount | Y | OBReadTransaction5/Data/Transaction/ChargeAmount/Amount |
Tran-18 | Transactions - Mandatory | Currency | Y | OBReadTransaction5/Data/Transaction/ChargeAmount/Currency |
Tran-19 | Transactions - Optional | CurrencyExchange | Y | OBReadTransaction5/Data/Transaction/CurrencyExchange |
Tran-20 | Transactions - Mandatory | SourceCurrency | Y | OBReadTransaction5/Data/Transaction/CurrencyExchange/SourceCurrency |
Tran-21 | Transactions - Optional | TargetCurrency | Y | OBReadTransaction5/Data/Transaction/CurrencyExchange/TargetCurrency |
Tran-22 | Transactions - Optional | UnitCurrency | Y | OBReadTransaction5/Data/Transaction/CurrencyExchange/UnitCurrency |
Tran-23 | Transactions - Mandatory | ExchangeRate | Y | OBReadTransaction5/Data/Transaction/CurrencyExchange/ExchangeRate |
Tran-24 | Transactions - Optional | ContractIdentification | Y | OBReadTransaction5/Data/Transaction/CurrencyExchange/ContractIdentification |
Tran-25 | Transactions - Optional | QuotationDate | N | OBReadTransaction5/Data/Transaction/CurrencyExchange/QuotationDate |
Tran-26 | Transactions - Optional | InstructedAmount | Y | OBReadTransaction5/Data/Transaction/CurrencyExchange/InstructedAmount |
Tran-27 | Transactions - Mandatory | Amount | Y | OBReadTransaction5/Data/Transaction/CurrencyExchange/InstructedAmount/Amount |
Tran-28 | Transactions - Mandatory | Currency | Y | OBReadTransaction5/Data/Transaction/CurrencyExchange/InstructedAmount/Currency |
Tran-29 | Transactions - Optional | BankTransactionCode | N | OBReadTransaction5/Data/Transaction/BankTransactionCode |
Tran-30 | Transactions - Mandatory | Code | N | OBReadTransaction5/Data/Transaction/BankTransactionCode/Code |
Tran-31 | Transactions - Mandatory | SubCode | N | OBReadTransaction5/Data/Transaction/BankTransactionCode/SubCode |
Tran-32 | Transactions - Optional | ProprietaryBankTransactionCode | Y | OBReadTransaction5/Data/Transaction/ProprietaryBankTransactionCode |
Tran-33 | Transactions - Mandatory | Code | Y | OBReadTransaction5/Data/Transaction/ProprietaryBankTransactionCode/Code |
Tran-34 | Transactions - Optional | Issuer | N | OBReadTransaction5/Data/Transaction/ProprietaryBankTransactionCode/Issuer |
Tran-35 | Transactions - Optional | Balance | Y | OBReadTransaction5/Data/Transaction/Balance |
Tran-36 | Transactions - Mandatory | CreditDebitIndicator | Y | OBReadTransaction5/Data/Transaction/Balance/CreditDebitIndicator |
Tran-37 | Transactions - Mandatory | Type | N | OBReadTransaction5/Data/Transaction/Balance/Type |
Tran-38 | Transactions - Mandatory | Amount | N | OBReadTransaction5/Data/Transaction/Balance/Amount |
Tran-39 | Transactions - Mandatory | Amount | N | OBReadTransaction5/Data/Transaction/Balance/Amount/Amount |
Tran-40 | Transactions - Mandatory | Currency | N | OBReadTransaction5/Data/Transaction/Balance/Amount/Currency |
Tran-41 | Transactions - Optional | MerchantDetails | Y | OBReadTransaction5/Data/Transaction/MerchantDetails |
Tran-42 | Transactions - Optional | MerchantName | Y | OBReadTransaction5/Data/Transaction/MerchantDetails/MerchantName |
Tran-43 | Transactions - Optional | MerchantCategoryCode | Y | OBReadTransaction5/Data/Transaction/MerchantDetails/MerchantCategoryCode |
Tran-44 | Transactions - Optional | CreditorAgent | Y | OBReadTransaction5/Data/Transaction/CreditorAgent |
Tran-45 | Transactions - Optional | SchemeName | Y | OBReadTransaction5/Data/Transaction/CreditorAgent/SchemeName |
Tran-46 | Transactions - Optional | Identification | Y | OBReadTransaction5/Data/Transaction/CreditorAgent/Identification |
Tran-47 | Transactions - Optional | Name | Y | OBReadTransaction5/Data/Transaction/CreditorAgent/Name |
Tran-48 | Transactions - Optional | PostalAddress | N | OBReadTransaction5/Data/Transaction/CreditorAgent/PostalAddress |
Tran-49 | Transactions - Optional | AddressType | N | OBReadTransaction5/Data/Transaction/CreditorAgent/PostalAddress/AddressType |
Tran-50 | Transactions - Optional | Department | N | OBReadTransaction5/Data/Transaction/CreditorAgent/PostalAddress/Department |
Tran-51 | Transactions - Optional | SubDepartment | N | OBReadTransaction5/Data/Transaction/CreditorAgent/PostalAddress/SubDepartment |
Tran-52 | Transactions - Optional | StreetName | N | OBReadTransaction5/Data/Transaction/CreditorAgent/PostalAddress/StreetName |
Tran-53 | Transactions - Optional | BuildingNumber | N | OBReadTransaction5/Data/Transaction/CreditorAgent/PostalAddress/BuildingNumber |
Tran-54 | Transactions - Optional | PostCode | N | OBReadTransaction5/Data/Transaction/CreditorAgent/PostalAddress/PostCode |
Tran-55 | Transactions - Optional | TownName | N | OBReadTransaction5/Data/Transaction/CreditorAgent/PostalAddress/TownName |
Tran-56 | Transactions - Optional | CountrySubDivision | N | OBReadTransaction5/Data/Transaction/CreditorAgent/PostalAddress/CountrySubDivision |
Tran-57 | Transactions - Optional | Country | Y | OBReadTransaction5/Data/Transaction/CreditorAgent/PostalAddress/Country |
Tran-58 | Transactions - Optional | AddressLine | N | OBReadTransaction5/Data/Transaction/CreditorAgent/PostalAddress/AddressLine |
Tran-59 | Transactions - Optional | CreditorAccount | Y | OBReadTransaction5/Data/Transaction/CreditorAccount |
Tran-60 | Transactions - Optional | SchemeName | Y | OBReadTransaction5/Data/Transaction/CreditorAccount/SchemeName |
Tran-61 | Transactions - Optional | Identification | Y | OBReadTransaction5/Data/Transaction/CreditorAccount/Identification |
Tran-62 | Transactions - Optional | Name | N | OBReadTransaction5/Data/Transaction/CreditorAccount/Name |
Tran-63 | Transactions - Optional | SecondaryIdentification | N | OBReadTransaction5/Data/Transaction/CreditorAccount/SecondaryIdentification |
Tran-64 | Transactions - Optional | DebtorAgent | Y | OBReadTransaction5/Data/Transaction/DebtorAgent |
Tran-65 | Transactions - Optional | SchemeName | Y | OBReadTransaction5/Data/Transaction/DebtorAgent/SchemeName |
Tran-66 | Transactions - Optional | Identification | Y | OBReadTransaction5/Data/Transaction/DebtorAgent/Identification |
Tran-67 | Transactions - Optional | Name | N | OBReadTransaction5/Data/Transaction/DebtorAgent/Name |
Tran-68 | Transactions - Optional | PostalAddress | N | OBReadTransaction5/Data/Transaction/DebtorAgent/PostalAddress |
Tran-69 | Transactions - Optional | AddressType | N | OBReadTransaction5/Data/Transaction/DebtorAgent/PostalAddress/AddressType |
Tran-70 | Transactions - Optional | Department | N | OBReadTransaction5/Data/Transaction/DebtorAgent/PostalAddress/Department |
Tran-71 | Transactions - Optional | SubDepartment | N | OBReadTransaction5/Data/Transaction/DebtorAgent/PostalAddress/SubDepartment |
Tran-72 | Transactions - Optional | StreetName | N | OBReadTransaction5/Data/Transaction/DebtorAgent/PostalAddress/StreetName |
Tran-73 | Transactions - Optional | BuildingNumber | N | OBReadTransaction5/Data/Transaction/DebtorAgent/PostalAddress/BuildingNumber |
Tran-74 | Transactions - Optional | PostCode | N | OBReadTransaction5/Data/Transaction/DebtorAgent/PostalAddress/PostCode |
Tran-75 | Transactions - Optional | TownName | N | OBReadTransaction5/Data/Transaction/DebtorAgent/PostalAddress/TownName |
Tran-76 | Transactions - Optional | CountrySubDivision | N | OBReadTransaction5/Data/Transaction/DebtorAgent/PostalAddress/CountrySubDivision |
Tran-77 | Transactions - Optional | Country | N | OBReadTransaction5/Data/Transaction/DebtorAgent/PostalAddress/Country |
Tran-78 | Transactions - Optional | AddressLine | N | OBReadTransaction5/Data/Transaction/DebtorAgent/PostalAddress/AddressLine |
Tran-79 | Transactions - Optional | DebtorAccount | Y | OBReadTransaction5/Data/Transaction/DebtorAccount |
Tran-80 | Transactions - Optional | SchemeName | Y | OBReadTransaction5/Data/Transaction/DebtorAccount/SchemeName |
Tran-81 | Transactions - Optional | Identification | Y | OBReadTransaction5/Data/Transaction/DebtorAccount/Identification |
Tran-82 | Transactions - Optional | Name | N | OBReadTransaction5/Data/Transaction/DebtorAccount/Name |
Tran-83 | Transactions - Optional | SecondaryIdentification | N | OBReadTransaction5/Data/Transaction/DebtorAccount/SecondaryIdentification |
Tran-84 | Transactions - Optional | CardInstrument | Y | OBReadTransaction5/Data/Transaction/CardInstrument |
Tran-85 | Transactions - Mandatory | CardSchemeName | Y | OBReadTransaction5/Data/Transaction/CardInstrument/CardSchemeName |
Tran-86 | Transactions - Optional | AuthorisationType | N | OBReadTransaction5/Data/Transaction/CardInstrument/AuthorisationType |
Tran-87 | Transactions - Optional | Name | Y | OBReadTransaction5/Data/Transaction/CardInstrument/Name |
Tran-88 | Transactions - Optional | Identification | Y | OBReadTransaction5/Data/Transaction/CardInstrument/Identification |
Tran-89 | Transactions - Optional | SupplementaryData | N |
Party Fields
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Party-1 | Party - Mandatory | OBParty2 | Y | OBParty2 |
Party-2 | Party - Mandatory | PartyId | Y | OBParty2/PartyId |
Party-3 | Party - Optional | PartyNumber | N | OBParty2/PartyNumber |
Party-4 | Party - Optional | PartyType | N | OBParty2/PartyType |
Party-5 | Party - Optional | Name | Y | OBParty2/Name |
Party-6 | Party - Optional | FullLegalName | N | OBParty2/FullLegalName |
Party-7 | Party - Optional | LegalStructure | N | OBParty2/LegalStructure |
Party-8 | Party - Optional | BeneficialOwnership | N | OBParty2/BeneficialOwnership |
Party-9 | Party - Optional | AccountRole | N | OBParty2/AccountRole |
Party-10 | Party - Optional | EmailAddress | N | OBParty2/EmailAddress |
Party-11 | Party - Optional | Phone | N | OBParty2/Phone |
Party-12 | Party - Optional | Mobile | N | OBParty2/Mobile |
Party-13 | Party - Optional | Relationships | N | OBParty2/Relationships |
Party-14 | Party - Optional | Account | N | OBParty2/Relationships/Account |
Party-15 | Party - Mandatory | Related | N | OBParty2/Relationships/Account/Related |
Party-16 | Party - Mandatory | Id | N | OBParty2/Relationships/Account/Id |
Party-17 | Party - Optional | Address | N | OBParty2/Address |
Party-18 | Party - Optional | AddressType | N | OBParty2/Address/AddressType |
Party-19 | Party - Optional | AddressLine | N | OBParty2/Address/AddressLine |
Party-20 | Party - Optional | StreetName | N | OBParty2/Address/StreetName |
Party-21 | Party - Optional | BuildingNumber | N | OBParty2/Address/BuildingNumber |
Party-22 | Party - Optional | PostCode | N | OBParty2/Address/PostCode |
Party-23 | Party - Optional | TownName | N | OBParty2/Address/TownName |
Party-24 | Party - Optional | CountrySubDivision | N | OBParty2/Address/CountrySubDivision |
Party-25 | Party - Mandatory | Country | N | OBParty2/Address/Country |
Payment Initiation API
Swagger version | 3.1.0 |
---|---|
Base URI | https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/pisp |
General variances to specification | No variances to specification |
Non-functional limitations | 15 seconds delay between POST /payment-submissions and GET Payment Submission |
API Endpoints
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Endpoint 1 | POST /domestic-payment-consents | - | Y | API Endpoint available |
Endpoint 2 | GET /domestic-payment-consents/{ConsentId} | - | Y | API Endpoint available |
Endpoint 3 | GET /domestic-payment-consents/{ConsentId}/funds-confirmation | - | Y | API Endpoint available |
Endpoint 4 | POST /domestic-payments | - | Y | API Endpoint available |
Endpoint 5 | GET /domestic-payments/{DomesticPaymentId} | - | Y | API Endpoint Available |
Endpoint 6 | POST /domestic-scheduled-payment-consents | - | Y | API Endpoint Available |
Endpoint 7 | GET /domestic-scheduled-payment-consents/{ConsentId}: | - | Y | API Endpoint Available |
Endpoint 8 | POST /domestic-scheduled-payments: | - | Y | API Endpoint Available |
Endpoint 9 | GET /domestic-scheduled-payments/{DomesticScheduledPaymentId} | - | Y | API Endpoint Available |
Endpoint 10 | POST /domestic-standing-order-consents | - | Y | API Endpoint Available |
Endpoint 11 | GET /domestic-standing-order-consents/{ConsentId} | - | Y | API Endpoint Available |
Endpoint 12 | POST /domestic-standing-orders | - | Y | API Endpoint Available |
Endpoint 13 | GET /domestic-standing-orders/{DomesticStandingOrderId}: | - | Y | API Endpoint Available |
Endpoint 14 | POST /file-payment-consents | - | Y | API Endpoint Available |
Endpoint 15 | GET /file-payment-consents/{ConsentId} | - | Y | API Endpoint Available |
Endpoint 16 | POST /file-payment-consents/{ConsentId}/file | - | Y | API Endpoint Available |
Endpoint 17 | GET /file-payment-consents/{ConsentId}/file |
| Y | API Endpoint Available |
Endpoint 18 | POST /file-payments | - | Y | API Endpoint Available |
Endpoint 19 | GET /file-payments/{FilePaymentId} | - | Y | API Endpoint Available |
Endpoint 20 | GET /file-payments/{FilePaymentId}/report-file | - | Y | API Endpoint Available |
Endpoint 21 | POST /international-payment-consents | - | Y | API Endpoint Available |
Endpoint 22 | GET /international-payment-consents/{ConsentId} | - | Y | API Endpoint Available |
Endpoint 23 | GET /international-payment-consents/{ConsentId}/funds-confirmation | - | Y | API Endpoint Available |
Endpoint 24 | POST /international-payments | - | Y | API Endpoint Available |
Endpoint 25 | GET /international-payments/{InternationalPaymentId} | - | Y | API Endpoint Available |
Endpoint 26 | POST /international-scheduled-payment-consents | - | N | API Endpoint Not Available |
Endpoint 27 | GET /international-scheduled-payment-consents/{ConsentId} | - | N | API Endpoint Not Available |
Endpoint 28 | GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation | - | N | API Endpoint Not Available |
Endpoint 29 | POST /international-scheduled-payments | - | N | API Endpoint Not Available |
Endpoint 30 | GET /international-scheduled-payments/{InternationalScheduledPaymentId} | - | N | API Endpoint Not Available |
Endpoint 31 | POST /international-standing-order-consents | - | N | API Endpoint Not Available |
Endpoint 32 | GET /international-standing-order-consents/{ConsentId} | - | N | API Endpoint Not Available |
Endpoint 33 | POST /international-standing-orders | - | N | API Endpoint Not Available |
Endpoint 34 | GET /international-standing-orders/{InternationalStandingOrderPaymentId} | - | N | API Endpoint Not Available |
Field Information
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Ref 1 | Payment Initiation API | Data | Y | "ConsentId" Unique identification as assigned by the ASPSP to uniquely identify the consent resource. Max128Text |
Ref 2 | Payment Initiation API | InstructionIdentification | Y | Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.", "type": "string", “minLength": 1, "maxLength": 35 |
Ref 3 | Payment Initiation API | EndToEndIdentification | Y | Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. If populated with data longer than 31, the extra characters will be truncated. "type": "string", "minLength": 1, "maxLength": 35 |
Ref 4 | Payment Initiation API | LocalInstrument | Y | User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. "type": "string", "minLength": 1, "maxLength": 35 |
Ref 5 | Payment Initiation API | Initiation | Y | "InstructionPriority" (not supported for immediate international payments. A request containing InstructionPriority will be rejected) The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment. "Purpose" "Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org." "ChargeBearer" Specifies which party/parties will bear the charges associated with the processing of the payment transaction. "BorneByCreditor", "BorneByDebtor", "Shared" can all be used for international immediate payments "FollowingServiceLevel" is not used for international immediate payments "CurrencyOfTransfer" Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. "pattern": "^[A-Z]{3,3}$" |
Ref 6 | Payment Initiation API | InstructedAmount | Y | Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.", "type": "object", "properties": "Amount": "type": "string", "pattern": "^\\d{1,13}\\.\\d{1,5}$" "Currency": "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 - Codes for the representation of currencies and funds.", "type": "string", "pattern": "^[A-Z]{3,3}$" |
Ref 7 | Payment Initiation API | ExchangeRateInformation | Y | Provides details on the currency exchange rate and contract. "UnitCurrency" Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. "pattern": "^[A-Z]{3,3}$" "ExchangeRate" (Not available) The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. "RateType" Specifies the type used to complete the currency exchange. "Actual", "Agreed", "Indicative" (Agreed rates not supported for immediate international payments - requests will be rejected Actual rates not supported for immediate international payments - requests will be rejected We are not rejecting a valid indicative rate request but we are not responding with a rate until day2 when we will display an indicative rate ragrdless of whether one has been requested. This will be displayed prior to authorisation, not on the consent response) "ContractIdentification" (Not available) Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. |
Ref 8 | Payment Initiation API | DebtorAccount | Y | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.", "title": "DebtorAccount", "type": "object", "properties": "SchemeName": "description": "Name of the identification scheme, in a coded form as published in an external list.", "title": "SchemeName", "type": "string", "enum": "IBAN", "SortCodeAccountNumber" (For immediate international payments, DebtorAccount/SchemeName must be equal to "UK.OBIE.SortCodeAccountNumber" or non-enum "SortCodeAccountNumber" else the request will be rejected.) "Identification": "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", "type": "string", "minLength": 1, "maxLength": 34 "Name": "description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number. The Faster Payments Scheme can only access 40 characters for the DebtorAccount Name field. If populated with data longer than 40, the extra characters will be truncated", "type": "string", "minLength": 1, "maxLength": 70 "SecondaryIdentification": "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", (Used by immediate international payments as the debit reference (prefixed with /RFO/)) "type": "string", "minLength": 1, "maxLength": 34 |
Ref 9 | Payment Initiation API | Creditor | Y | Party to which an amount of money is due. "Name" (This is a mandatory field for immediate international payments) Name by which a party is known and which is usually used to identify that party. |
Ref 10 | Payment Initiation API | CreditorAccount | Y | Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.", "title": "CreditorAccount", "type": "object", "properties": "SchemeName": "description": "Name of the identification scheme, in a coded form as published in an external list.", "title": "SchemeName", "type": "string", "enum": "IBAN", "SortCodeAccountNumber" (For immediate international payments, CreditorAccount/SchemeName must be equal to "UK.OBIE.IBAN" or "UK.Santander.OtherAccount" (or non-enum "IBAN" or "OtherAccount") else the request will be rejected.) "Identification": "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", "type": "string", "minLength": 1, "maxLength": 34 "Name": "description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number. ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. The Faster Payments Scheme can only access 40 characters for the CreditorAccount Name field. If populated with data longer than 40, the extra characters will be truncated”, "type": "string", "minLength": 1, "maxLength": 70 "SecondaryIdentification": "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner. The Faster Payments Scheme can only access 18 characters for the SecondaryIdentification Name field. If populated with data longer than 18, the extra characters will be truncated", "type": "string", "minLength": 1, "maxLength": 34 |
Ref 11 | Payment Initiation API | CreditorPostalAddress | Y | Information that locates and identifies a specific address, as defined by postal services. "title": "CreditorPostalAddress", "type": "object", "properties": "CreditorPostalAddress": "description": Information that locates and identifies a specific address, as defined by postal services "type": "OBAddressType",
"Department": "description": "Identification of a division of a large organisation or building”. "type": "string", "minLength": 1, "maxLength": 70
"Sub Department": "description": "Identification of a division of a large organisation or building”. "type": "string", "minLength": 1, "maxLength": 70
"StreetName": "description": "Name of a street or thoroughfare”. "type": "string", "minLength": 1, "maxLength": 70
"BuildingNumber": "description": "Number that identifies the position of a building on a street.”. "type": "string", "minLength": 1, "maxLength": 16
"PostCode": "description": "Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail..”. "type": "string", "minLength": 1, "maxLength": 16
"TownName": (For immediate international payments, if Creditor/PostalAddress/AddressLine is absent, then Creditor/PostalAddress/Country and Creditor/PostalAddress/TownName must be present.) "description": "Name of a built-up area, with defined boundaries, and a local government.”. "type": "string", "minLength": 1, "maxLength": 35
"CountrySubDivision": "description": "Identifies a subdivision of a country such as state, region, county."type": "string", "minLength": 1, "maxLength": 35
"CountryCode": (For immediate international payments, if Creditor/PostalAddress/AddressLine is absent, then Creditor/PostalAddress/Country and Creditor/PostalAddress/TownName must be present.) "description": "Nation with its own government.", "^[A-Z]{2,2}$” "AddressLine": (For immediate international payments, if Creditor/PostalAddress/AddressLine is absent, then Creditor/PostalAddress/Country and Creditor/PostalAddress/TownName must be present.) "description": "Information that locates and identifies a specific address, as defined by postal services, presented in free format text.", "minLength": 1, "maxLength": 70
|
Ref 12 | Payment Initiation API | CreditorAgent | Y | Financial institution servicing an account for the creditor. "SchemeName" (For immediate international payments, CreditorAgent/SchemeName must be equal to "UK.OBIE.BICFI" or "BICFI" else the request will be rejected. UNLESS, SupplementaryData DestinationCountry is 'US', Initiation CurrencyOfTransfer is 'USD' and SupplementaryData NCCCode is 'USABA', or when SupplementaryData DestinationCountry is a SEPA jurisdiction - in these 2 scenarios a request can be accepted without CreditorAgent/SchemeName equal to "UK.OBIE.BICFI" or "BICFI") Name of the identification scheme, in a coded form as published in an external list. "Identification" Unique and unambiguous identification of a financial institution or a branch of a financial institution. "Name" Name by which an agent is known and which is usually used to identify that agent. |
Ref 13 | Payment Initiation API | CreditorAgentPostalAddress | Y | Information that locates and identifies a specific address, as defined by postal services. "title": "CreditorPostalAddress", "type": "object", "properties": "CreditorPostalAddress": "description": Information that locates and identifies a specific address, as defined by postal services "type": "OBAddressType", "Department": "description": "Identification of a division of a large organisation or building”. "type": "string", "minLength": 1, "maxLength": 70 "Sub Department": "description": "Identification of a division of a large organisation or building”. "type": "string", "minLength": 1, "maxLength": 70 "StreetName": "description": "Name of a street or thoroughfare”. "type": "string", "minLength": 1, "maxLength": 70 "BuildingNumber": "description": "Number that identifies the position of a building on a street.”. "type": "string", "minLength": 1, "maxLength": 16 "PostCode": "description": "Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail..”. "type": "string", "minLength": 1, "maxLength": 16 "TownName": "description": "Name of a built-up area, with defined boundaries, and a local government.”. "type": "string", "minLength": 1, "maxLength": 35 "CountrySubDivision": "description": "Identifies a subdivision of a country such as state, region, county."type": "string", "minLength": 1, "maxLength": 35 "CountryCode": "description": "Nation with its own government.", "^[A-Z]{2,2}$” "AddressLine": "description": "Information that locates and identifies a specific address, as defined by postal services, presented in free format text.", "minLength": 1, "maxLength": 70 |
Ref 14 | Payment Initiation API | RemittanceInformation | Y | Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.", "title": "RemittanceInformation", "type": "object", "properties": "Unstructured": "description": "Information supplied to enable the matching\/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.", (For File Based BULK faster payments this should contain the Debit Reference for a payment. For a BULK file the Debit details specified on 1st payment record in the file will be used for the single debit.) "type": "string", "minLength": 1, "maxLength": 140 "Reference": "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only access 18 characters for the Reference Name field. If populated with data longer than 18, the extra characters will be truncated", (For File Based BULK faster payments this should contain the Credit Reference for a payment. For FP max allowed is 18 chars.) "type": "string", "minLength": 1, "maxLength": 35 |
Ref 15 | Payment Initiation API | SupplementaryData | Y | Additional information that cannot be captured in the structured fields and/or any other specific block. OBSupplementaryData1 "NCCCode" (The NCC code will be validated against the listed value. |
Ref 16 | Payment Initiation API | RequestedExecutionDateTime | Y | Date at which the initiating party requests the clearing agent to process the payment. (For File Based BULK faster payments this should NOT be used as ONLY same day payments are currently being allowed.) Usage: This is the date on which the debtor's account is to be debited. “ISODateTime” |
Ref 17 | Payment Initiation API | Frequency | Y | Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day 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 (-5 to -1, 1 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) 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 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)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ "type": "string", "minLength": 1, "maxLength": 35 |
Ref 18 | Payment Initiation API | Reference | Y | Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
"type": "string", "minLength": 1, "maxLength": 35 |
Ref 19 | Payment Initiation API | NumberOfPayments | Y | Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. "type": "string", "minLength": 1, "maxLength": 35 |
Ref 20 | Payment Initiation API | FirstPaymentDateTime | Y | The date on which the first payment for a Standing Order schedule will be made. "type": "ISODateTime” |
Ref 21 | Payment Initiation API | RecurringPaymentDateTime | Y | The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date. "type": "ISODateTime” |
Ref 22 | Payment Initiation API | FinalPaymentDateTime | Y | The date on which the final payment for a Standing Order schedule will be made. "type": "ISODateTime” |
Ref 23 | Payment Initiation API | FirstPaymentAmount | Y | The amount of the first Standing Order "type": "object", "properties": "Amount": “Description”: “A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.” "Currency": "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 - Codes for the representation of currencies and funds.", "type": "string", "pattern": "^[A-Z]{3,3}$" |
Ref 24 | Payment Initiation API | ReocurringtPaymentAmount | Y | The amount of the recurring Standing Order "type": "object", "properties": "Amount": “Description”: “A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.” "Currency": "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 - Codes for the representation of currencies and funds.", "type": "string", "pattern": "^[A-Z]{3,3}$" |
Ref 25 | Payment Initiation API | FinalPaymentAmount | Y | The amount of the final Standing Order "type": "object", "properties": "Amount": “Description”: “A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.” "Currency": "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 - Codes for the representation of currencies and funds.", "type": "string", "pattern": "^[A-Z]{3,3}$" |
Ref 26 | Payment Initiation API | Free text fields | N/A | Santander only support an international payment request where all the characters in the free text fields are from below character set. a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 / – ? : ( ) . , ‘ + CrLf Space |
Ref 27 | Payment Initiation API (file-payment-consent and file-payment) | Data | Y | "ConsentId" Unique identification as assigned by the ASPSP to uniquely identify the consent resource. Max128Text |
Ref 28 | Payment Initiation API (file-payment-consent and file-payment) | FileType | Y | Specifies the payment file type Usage: Mandatory - Only file type 'UK.OBIE.PaymentInitiation.3.0' is supported at this time. Any other file types will be rejected. "type": "Text", “minLength": 1, "maxLength": 35 |
Ref 29 | Payment Initiation API (file-payment-consent and file-payment) | FileHash | Y | Base64 encoding of a SHA256 hash of the file to be uploaded. Usage: Mandatory "type": "Text", “minLength": 1, "maxLength": 44 |
Ref 30 | Payment Initiation API (file-payment-consent and file-payment) | FileReference | Y | Reference for the file. "type": "Text", “minLength": 0, "maxLength": 40 |
Ref 31 | Payment Initiation API (file-payment-consent and file-payment) | NumberOfTransactions | Y | Number of individual transactions contained in the payment information group Usage: Mandatory - There is a requirement for this field to be populated otherwise payment Request will be rejected. "type": "NumericText" “minLength": 1, "maxLength": 15 |
Ref 32 | Payment Initiation API (file-payment-consent and file-payment) | ControlSum | Y | Total of all individual amounts included in the group, irrespective of currencies Usage: Mandatory - There is a requirement for this field to be populated otherwise payment Request will be rejected. "type": "DecimalNumber" |
Ref 33 | Payment Initiation API (file-payment-consent and file-payment) | RequestedExecutionDateTime | Y | Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. This date must be equal to or less than payment date submission. Future Dated dates are currently not allowed. "type": "ISODateTime" |
Ref 34 | Payment Initiation API (file-payment-consent and file-payment) | LocalInstrument | Y | User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. """type"": ""OBExternalLo calInstrument 1Code""" |
Ref 35 | Payment Initiation API (file-payment-consent and file-payment) | DebtorAccount | Y | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. "type": "OBCashAccountDebtor4" |
Ref 36 | Payment Initiation API (file-payment-consent and file-payment) | SchemeName | Y | Name of the identification scheme, in a coded form as published in an external list. Usage: Mandatory - Must be equal to "UK.OBIE.SortCodeAccountNumber" or non-enum "SortCodeAccountNumber" else the request will be rejected. """type"": ""OBExternalAc countIdentific ation4Code""" |
Ref 37 | Payment Initiation API (file-payment-consent and file-payment) | Identification | Y | Identification assigned by an institution to identify an account. This identification is known by the account owner. Usage: Mandatory - Identifies the Debit Account that should contain 6 digit sortcode and 8 digit account number. "type": "Text", “minLength": 1, "maxLength": 240 |
Ref 38 | Payment Initiation API (file-payment-consent and file-payment) | Name | Y | Name of the account, as assigned by the account servicing institution. Usage: Name of Debit Account holder "type": "Text", “minLength": 0, "maxLength": 70 |
Ref 39 | Payment Initiation API (file-payment-consent and file-payment) | SecondaryIdentification | Y | This is secondary identification of the account, as assigned by the account servicing institution. Usage: This is not used by Santander UK "type": "Text", “minLength": 0, "maxLength": 34 |
Ref 40 | Payment Initiation API (file-payment-consent and file-payment) | RemittanceInformation | Y | Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. "type": "OBRemittanceInformation1" |
Ref 41 | Payment Initiation API (file-payment-consent and file-payment) | Unstructured | Y | Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts'receivable system, in an unstructured form. Usage: This should contain the Debit Reference associated with the BULK/BATCH file payment. The max allowed for FP & CHAPS is 90 chars. "type": "Text", “minLength": 0, "maxLength": 140 |
Ref 42 | Payment Initiation API (file-payment-consent and file-payment) | Reference | Y | Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: This will contain the Credit Reference. For FP max allowed is 18 chars and for CHAPS it is 35 chars. "type": "Text", “minLength": 0, "maxLength": 35 |
Ref 43 | Payment Initiation API (file-payment-consent and file-payment) | SupplementaryData | Y | Additional information that can not be captured in the structured fields and/or any other specific block. Usage: This will not be used for Domestic payments. |
Ref 44 | Payment Initiation API (file-payment-consent and file-payment) | FP Free text fields | Y | UK Domestic Character Set When instructing a Faster Payment and Bulk payment only characters from the following set maybe used in the free format fields: A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 . - / & <space> |
Ref 45 | Payment Initiation API (file-payment-consent and file-payment) | CHAPS Free text fields | Y | CHAPS Character Set |
Open Data API
ATMs API
Swagger version | 2.1.0 |
---|---|
Base URI | https://openbanking.santander.co.uk/sanuk/external/open-banking/v2.1 |
Swagger version | 2.2.0 |
Base URI | https://openbanking.santander.co.uk/sanuk/external/open-banking/v2.2 |
General variances to specification | No variances to specification |
Non-functional limitations |
API Endpoints
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Endpoint 1 | GET /atms | - | Y | API Endpoint available |
Branches API
Swagger version | 2.1.0 |
---|---|
Base URI | https://openbanking.santander.co.uk/sanuk/external/open-banking/v2.1 |
Swagger version | 2.2.0 |
Base URI | https://openbanking.santander.co.uk/sanuk/external/open-banking/v2.2 |
General variances to specification | No variances to specification |
Non-functional limitations |
API Endpoints
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Endpoint 1 | GET /branches | - | Y | API Endpoint available |
Products API
Swagger version | 2.1.0 |
---|---|
Base URI | https://openbanking.santander.co.uk/sanuk/external/open-banking/v2.1 |
Swagger version | 2.2.0 |
Base URI | https://openbanking.santander.co.uk/sanuk/external/open-banking/v2.2 |
General variances to specification | No variances to specification |
Non-functional limitations |
API Endpoints
Ref | Area | Field | Available (Y/N) | Exception/Notes (inc details on classification codes, field limits, and field formats) |
---|---|---|---|---|
Endpoint 1 | GET /unsecured-sme-loans | - | Y | API Endpoint available |
Endpoint 2 | GET /business-current-accounts | - | Y | API Endpoint available |
Endpoint 3 | GET /personal-current-accounts | - | Y | API Endpoint available |
Endpoint 4 | GET /commercial-credit-cards | - | Y | API Endpoint available |