Sorry, you need to enable JavaScript to visit this website.

API Product Overview

API Product Overview

 

Accounts API

Our Accounts API will enable you to access account information, account balances and transactional history on customer accounts.

We have employed the 0Auth 2.0 consent model to enable our customers to grant access to third party service providers (your application) in a clear and secure manner. This API will provide the following:

  • Account balance information
  • Account transaction information

The Swagger definitions, available under the API Documentation section of this site, will provide information on API specification.

Further, should you provide the functionality in your application to allow the expiration date to be specified at the consent stage, the customer can set their preferred expiration date of the consent they are granting to you.

The maximum number of days for which the consent will remain active is 90 days, prior to this point or on expiry the customer will need to grant consent once again to the resources they wish you to access.

Our Accounts endpoints provide data for transactions with various statuses, including:

Transactions that have fully posted (demarked as "Booked" in the data shared with you)
This data is fully posted to our accounting system and reflects all transactions that have been fully processed on the dates specified.

Transactions being processed (demarked as "Pending" in the data shared with you)
An example here are card payments recently carried out at a point-of-sales (POS) terminal or on-line but have not yet been processed to the customer’s account. Timelines in relation to transactions moving from status "Pending" to "Booked" will vary and depend upon various elements including merchant processes and calendar events such as bank holidays.

For further information on payment status the following may be of use:
https://aib.ie/help-and-guidance/internet-banking-faqs

Our Accounts endpoints are in line with Open Banking Specification in the UK, available here: [https://openbanking.atlassian.net/wiki/spaces/DZ/pages/937820271/Account+and+Transaction+API+Specification+-+v3.1]

Payments API

Our Payments API will enable you to initiate payments from a customer's account and comprises three elements:

i. The setup of the payment resource.
ii. The submission of the payment instruction for processing, once the customer has approved you to do so.
iii. The ability for you to call the endpoint to retrieve a status of the payment.

The Swagger definitions, available under the API Documentation section of this site, will provide information on API specification.

We have employed the 0Auth 2.0 consent model to enable customers to grant access to 3rd party service providers (your application) in a clear and secure manner, ensuring they are in control of who is initiating payments on their behalf.

Our Payments endpoints are in line with Open Banking Specification in the UK, available here: [https://openbanking.atlassian.net/wiki/spaces/DZ/pages/937754701/Payment+Initiation+API+Specification+-+v3.1]

Confirmation of Funds API

Our Confirmation of Funds endpoints will enable you to create a Funds Confirmation resource at AIB, once agreement between the customer and AIB is reached in relation to responding to a request from you for availability of funds check, the Confirmation of Funds API will enable you to obtain a Yes/No response indicating whether or not funds are available for a particular payment.

The Swagger definitions, available under the API Documentation section of this site, will provide information on API specification.

Our Confirmation of Funds API is in line with Open Banking specification in the UK, available here: [https://openbanking.atlassian.net/wiki/spaces/DZ/pages/937951380/Confirmation+of+Funds+API+Specification+-+v3.1].

Credit Cards API

Our Credit Cards API will enable you to access balance and transactional information customer's credit card accounts.

We have employed the 0Auth 2.0 consent model to enable our customers to grant access to third party service providers (your application) in a clear and secure manner. This API will provide the following:

  • Account balance information
  • Account transaction information

The Swagger definitions, available under the API Documentation section of this site, will provide information on API specification.

If you require further information about any of our APIs please feel free to contact us at api@aib.ie