API Documentation

Supported 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

/ –. , ‘

Space

Special Rules:

P7 Refunds

  • Functionality allowing TPPs to receive customer account details for potential future refunds.
  • Applies to all PISP Domestic & International endpoints.
  • Does not apply to File Payments.
  • TPP submits ReadRefundAccount field within the Data block of the Consent Request (e.g. POST /domestic-payment-consents)
  • Field allows for only 2 values; Yes and No.
  • Only the ReadRefundAccount field is passed back in the Consent Response
  • No additional fields required from TPPs in Payment Order request(e.g. POST /domestic-payments)
  • Customer account details are passed back within the Payment Order response & responses to any GET requests (e.g. POST /domestic-payments & GET /domestic-payments/{DomesticPaymentId})

 

  • Domestic response:

Refund block within the Data block, containing Account block. Below data is returned in the Account block:

SchemeName – the name of the identification scheme (e.g. UK.OBIE.IBAN)

Identification – the Customer account details, i.e. the Debit Account number

Name – the name of the account owner on the Debit Account

  • International Response:

As Domestic, but with an additional Agent block containing:

SchemeName – the name of the identification scheme (e.g. UK.OBIE.BICFI)

Identification – the AIB BIC (ROI) or Sort Code (UK) for identifying the destination bank for non-SEPA refunds.

 

P8 SCA Exemptions

  • Applies to all PISP endpoints, including File Payments
  • Consent requests can include an optional SCASupportData block within the Data block, containing the following fields:

RequestedSCAExemptionType – the SCA Exemption being requested. Values must be as per the OBExternalSCAExemptionType1Code code class.

AppliedAuthenticationApproach – specifies whether the Customer was subject to SCA by the TPP. Values must be as per the OBExternalAppliedAuthenticationApproach1Code code class.

ReferencePaymentOrderId – the payment reference for the last payment where it is a recurring payment.

  • This data is accepted on an Accept & Store basis only.

 

Purpose of Payment

Mandatory for all International Payments and Chaps Payments.

Values accepted by AIB;

 

DestinationCountryCode

  • Applies to International endpoints only.
  • DestinationCountryCode appears in the Initiation block of the Consent request & is mandatory for all International payments.
  • If the CreditorAgent/PostalAddress/Country is included in the payload, it must match the DestinationCountryCode.

 

 

File payments:

We support the following UK file payments in CSV file format.

a) UK.AIB.APACS.Credit    
b) UK.AIB.APACS.Debit 
c) UK.AIB.CSVExcel.Credit          
d) UK.AIB.CSVExcel.Debit
 

 

Requirements for file uploading:

The File structure must match the File Type mentioned in the metadata payload

  • File Type - must be in APACS, CSV (Excel)
  • File Size Limit - 5 MB
  • Hash of the file must match the File Hash in the consent request.
  • No Of txns and Control sum if provided should match the actual count with the file.
  • If the File fails a validation, the status of consent will appear as "Rejected"

 

Timeout values for international payments:

The following CMA permissions are supported:

  • beneficiaries
  • standing-orders
  • direct-debits
  • products

Example scope in the consent setup request:

{
  "Data": {
    "Permissions": [
      "ReadAccountsDetail",
      "ReadBalances",
      "ReadTransactionsDetail",
      "ReadTransactionsCredits",
      "ReadTransactionsDebits",
      "ReadBeneficiariesDetail",
      "ReadDirectDebits",
      "ReadStandingOrdersDetail",
      "ReadProducts"
    ],
    "ExpirationDateTime": "2020-12-01T00:30:44.954Z",
    "TransactionFromDateTime": "2019-11-01T08:59:52.482Z",
    "TransactionToDateTime": "2019-12-01T08:59:52.482Z"
  },
  "Risk": {}
}

These permissions can be included in the scope of the POST /account-access-request API call across the AIB GB and AIB (NI) (formerly First Trust Bank) regions.

Please note, these permissions are not permitted for the ROI region. Should the scope include these permissions when calling the /account-access-request ROI endpoint the POST request will be immediately rejected, preventing the customer from being taken to the OAuth redirect flow.

Handling Credit Cards:

These permissions are not supported for Credit Cards. Where the scope of the API request includes all or any one of these CMA permissions, the customer will not have the ability to select their credit card(s) within the OAuth redirect. The OAuth redirect will display non-Credit Card accounts only where CMA permissions are included in the scope.

In order to share both credit card data and data on accounts (current and/or deposit) where CMA permissions are included, TPPs will require two apps defined on the AIB gateway within the region they wish to operate in i.e. if working with GB clients and utilising the GB API suite, two apps will be required on the AIB GB environment.

 

  • Weekly (WEEK)
  • Fortnightly (FRTN)
  • Every 4 weeks (FOWK)
  • Monthly (MNTH)
  • Every 2 months (TWMH)
  • Quarterly (QURT)
  • Every 4 months (FOMH)
  • Half yearly (MIAN)
  • Annually (YEAR)

And will reject the consent if AIB receive any other values

Frequency should match with value in "FirstPaymentDateTime" field. In case of mismatch, AIB will reject the Consent.