Account Information Services APIs

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 Online (BOL)

APIs supported – What’s on?

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
• Direct debits
  • 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

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

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?

• Please note that Bank of Ireland will only be supporting V2.0 & V3.0 of the AISP APIs from March'19. V1.1 of the AISP APIs will be deprecated from March'19.
• 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.
• Bank will not accept an accounts-access-consent request 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.
  • Bank will be providing a unique identifier for every transaction for the account types supported, with the below exception
    • Bank will not be returning transaction identifier 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
    • Bank will return a maximum of one year of transaction data, from the current date
    • Bank will return the balance on the last transaction date. Bank will not return the balance for every transaction
    • Transaction narrative will be masked if it contains any sensitive payment data identified by the Bank
  • Bank will return transaction data based on the statement cycle for credit cards i.e. only for current cycle
• Standing orders
  • Bank will return an empty response if there are no standing orders associated with an account when enquired
  • Bank will return an empty response if enquired for a valid consented credit card
  • Sensitive information like creditor information will be masked
• Direct debits
  • Bank will always return an empty response when enquired
• Beneficiaries
  • Bank will always return only active beneficiaries associated with a customer and not with a specific account
  • Bank will return an empty response if there are no beneficiaries associated with the customer when enquired
  • Sensitive information like beneficiary account details will always be masked
  • Bank will return an empty response if enquired for a valid consented credit card
• Products
  • Bank will return an empty response if enquired for a valid consented credit card, Demand Deposit Account
  • Bank will be providing customised masking and customised scheme names for international beneficiaries
• Scheduled Payment
  • Bank will return an empty response if there are no scheduled payments associated with an account when enquired
  • Bank will return an empty response if enquired for a valid consented credit card
  • Bank will return only one-off ‘pending’ future dated payments