Account Information Services APIs

(0 reviews)
Download

Important Information & Bank of Ireland’s API Implementation

This page is a reflection of Bank of Ireland’s implementation of the Open Banking ‘Account and Transaction Service API’. Please use the below details for access to information on Bank of Ireland’s account(s).

Accounts supported
  • Personal Current Account (PCA)
  • Business Current Account (BCA)
  • Demand Deposit Account
  • Credit cards
Customer profiles supported

Customers registered on the following Bank of Ireland’s online channel

  • 365 online
  • Business On Line (BOL)
APIs supported – What’s on?

Please refer to the BOI API list for full details of what APIs are available in the Sandbox or in production, and on which brand

Bank of Ireland UK PLC
  • Accounts
    • Accounts supported – PCA, BCA, Demand Deposit, Credit cards
  • Balances
    • Accounts supported – PCA, BCA, Demand Deposit, Credit cards
  • Transactions
    • Accounts supported – PCA, BCA, Demand Deposit, Credit cards
    • Pagination, filtering supported
    • Pagination supported only for PCA, BCA and Demand Deposit accounts
  • Standing orders
    • Accounts supported – PCA, BCA, Demand Deposit
  • Beneficiaries
    • Accounts supported – PCA, BCA, Demand Deposit
  • Products
    • Accounts supported – PCA, BCA
  • Scheduled payments
    • Accounts supported – PCA, BCA, Demand Deposit
  • Statements
    • List of statements
    • Filtering for list of statements supported
    • Retrieve PDF version of a statement
    • Accounts supported – PCA, BCA, Demand Deposit, Credit cards
    • Pagination not supported for Statement List
Bank of Ireland (ROI)
  • Accounts
    • Accounts supported – PCA, BCA, Demand Deposit, Credit cards
  • Balances
    • Accounts supported – PCA, BCA, Demand Deposit, Credit cards
  • Transactions
    • Accounts supported – PCA, BCA, Demand Deposit, Credit cards
    • Pagination, filtering supported
    • Pagination supported only for PCA, BCA and Demand Deposit accounts
UK Post Office

UK Post Office Current Accounts are being discontinued, with all accounts to be closed in September 2019. Access to these Accounts will not be made available via APIs.

Post Office and AA Credit Cards

Post Office and AA Credit Cards provided by Bank of Ireland UK are being sold to a new Credit Card issuer. Access to Accounts will not be available on these Credit Card portfolios until enabled by the new card issuer.

Token implementation
  • Access token – 5 minutes
  • Refresh token – 90 days
  • TPPs will be provided with the pending duration of the refresh token through the id token.
APIs supported - What’s different?
  • Bank of Ireland UK supports V2.0 & V3.0 of the AISP APIs
  • Bank of Ireland (ROI) supports V3.0 AISP APIs
  • All APIs will only be returning one error message in the response in case of an error scenario. Please make sure that you have provided all information that is required for a successful API call.
  • Accounts-access-consent request will not be accepted if it contains the following permission – ReadParty, ReadOffers, ReadPartyPSU.
  • For account types not supported, Bank AISP APIs will always return an empty response if the account is still a valid consented online payment account e.g. Products endpoint will return an empty response for a valid consented credit card.
  • If the consented account is not a valid online payment account, then Bank AISP APIs will not return any account information.
  • Transactions
    • API will return an empty response if there are no transactions associated with an account when enquired.
    • Bank will be providing only a proprietary transaction code for every transaction. The list of transaction codes is available here.
    • A unique identifier will be provided for every transaction for the account types supported, with the below exception
      • A transaction identifier will not be returned for consumer credit cards. This will be provided when 3.1.2 APIs are implemented
    • For the following account types – PCA, BCA, Demand Deposit Account
      • A maximum of one year of transaction data will be returned, from the current date
      • The balance will be returned on the last transaction date. The balance for every individual transaction will not be returned.
      • Transaction narrative will be masked if it contains any sensitive payment data identified by the Bank
    • Transaction data based on the statement cycle for credit cards will be returned i.e. only for current cycle
  • Standing orders
    • An empty response will be returned if there are no standing orders associated with an account when enquired
    • An empty response will be returned if enquired for a valid consented credit card
    • Sensitive information like creditor information will be masked
    • Please note that there are a limited number of customers who have standing orders with payee account numbers less than 8 digits. In this scenario, we will return a 500 error to the SO API request. This is being fixed in a future release.
  • Beneficiaries

    • Bank will always return only active beneficiaries associated with a customer will be returned and not with a specific account
    • An empty response will be returned if there are no beneficiaries associated with the customer when enquired
    • Sensitive information like beneficiary account details will always be masked
    • An empty response will be returned if enquired for a valid consented credit card
    • A customised masking will be provided and customised scheme names for international beneficiaries
  • Products

    • An empty response will be returned if enquired for a valid consented credit card, Demand Deposit Account
  • Scheduled Payment

    • An empty response will be returned if there are no scheduled payments associated with an account when enquired
    • An empty response will be returned if enquired for a valid consented credit card
    • Only one-off ‘pending’ future dated payments will be returned
  • Statements
    • The statements API will not work for customers using Business On Line (BOL) credentials as BOL doesn’t support statements. The statements API is for business customers using 365 credentials.
    • An empty response will be returned if there are no statements associated with an account when enquired
    • Statements can be retrieved in PDF formats only. Any other file formats requested during enquiry will result in an error being returned
    • The Statement From Date and the Statement To Date will be set to the current date for PCA, BCA, Demand deposit account
    • Statement From Date and Statement To Date will be provided based on the frequency of the statement (monthly, annual) for credit cards

Reviews