| Warning |
|---|
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. |
...
| id | Summary |
|---|
...
AIB Group (UK) p.l.c.
...
AIB Group (UK) p.l.c.
...
https://developer.aibgb.co.uk/
On-boarding
...
First Trust Bank:
https://developer.firsttrustbank.co.uk/getting-started-FTB
Allied Irish Bank (GB):
https://developer.aibgb.co.uk/getting-started-GB
...
First Trust Bank:
https://openapi.firsttrustbank.co.uk/endpoints/v2/retail/.well-known/openid-configuration
Allied Irish Bank (GB):
https://openapi.aibgb.co.uk/endpoints/v2/retail/.well-known/openid-configuration
...
First Trust Bank:
https://developer.firsttrustbank.co.uk/getting-started-FTB
Allied Irish Bank (GB):
https://developer.aibgb.co.uk/getting-started-GB
Account Information API
Note to ASPSP: Please add a column per brand if relevant
...
First Trust Bank:
https://developer.firsttrustbank.co.uk/apis
Allied Irish Bank (GB):
https://developer.aibgb.co.uk/apis
...
First Trust Bank:
https://apis.firsttrustbank.co.uk/api/open-banking/v1.1
Allied Irish Bank (GB):
https://apis.aibgb.co.uk/api/open-banking/v1.1
...
...
...
...
...
...
Endpoint 1
...
POST /account-requests
...
-
...
Y
...
Mandatory
API Endpoint available
...
Endpoint 2
...
GET /account-requests/{AccountRequestId}
...
-
...
Y
...
Optional
API Endpoint available
...
Endpoint 3
...
DELETE /account-requests/{AccountRequestId}
...
-
...
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 - PCAs only.
...
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
...
-
...
N
...
Optional
API Endpoint not available
...
Endpoint 14
...
GET /direct-debits
...
-
...
N
...
Optional
API Endpoint not available
...
Endpoint 15
...
GET /products
...
-
...
N
...
Optional
API Endpoint not available
...
Endpoint 16
...
GET /standing-orders
...
-
...
N
...
Optional
API Endpoint not available
...
Endpoint 17
...
GET /transactions
...
-
...
N
...
Optional
API Endpoint not available
Field Information
Account Fields
...
...
...
...
...
...
Acc 1
...
Account - Mandatory
...
OBReadAccount1
...
Y
...
OBReadAccount1
...
Acc 2
...
Account - Mandatory
...
Data
...
Y
...
OBReadAccount1/Data
...
Acc 3
...
Account - Optional
...
Account
...
Y
...
OBReadAccount1/Account
Unambiguous identification of the account to which credit and debit entries are made.
...
Acc 4
...
Account - Mandatory
...
AccountId
...
Y
...
OBReadAccount1/Account/AccountId
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
...
Acc 5
...
Account - Mandatory
...
Currency
...
Y
...
OBReadAccount1/Account/CurrencyIdentification of the currency in which the account is held.
Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
...
Acc 6
...
Account - Optional
...
Nickname
...
Y
...
OBReadAccount1/Account/Nickname
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
...
Acc 7
...
Account - Optional
...
Account
...
Y
...
OBReadAccount1/Account/Account
Provides the details to identify an account.
...
Acc 8
...
Account - Mandatory
...
SchemeName
...
Y
...
OBReadAccount1/Account/Account/SchemeName
Name of the identification scheme, in a coded form as published in an external list.
...
Acc 9
...
Account - Mandatory
...
Identification
...
Y
...
OBReadAccount1/Account/Account/Identification
Identification assigned by an institution to identify an account. This identification is known by the account owner.
...
Acc 10
...
Account - Optional
...
Name
...
N
...
OBReadAccount1/Account/Account/Name
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.
...
Acc 11
...
Account - Optional
...
SecondaryIdentification
...
N
...
OBReadAccount1/Account/Account/SecondaryIdentification
This is secondary identification of the account, as assigned by the account servicing institution.
This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)."
...
Acc 12
...
Account - Optional
...
Servicer
...
N
...
OBReadAccount1/Account/Servicer
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.
...
Acc 13
...
Account - Optional
...
SchemeName
...
Y
...
OBReadAccount1/Account/Servicer/SchemeName
Name of the identification scheme, in a coded form as published in an external list.
...
Acc 14
...
Account - Optional
...
Identification
...
Y
...
OBReadAccount1/Account/Servicer/Identification
Unique and unambiguous identification of the servicing institution.
Balances Fields
...
...
...
...
...
...
Bal 1
...
Balances - Mandatory
...
OBReadBalance1
...
Y
...
OBReadBalance1
...
Bal 2
...
Balances - Mandatory
...
Data
...
Y
...
OBReadBalance1/Data
...
Bal 3
...
Balances - Mandatory
...
Balance
...
Y
...
OBReadBalance1/Balance
Set of elements used to define the balance details.
...
Bal 4
...
Balances - Mandatory
...
AccountId
...
Y
...
OBReadBalance1/Balance/AccountId
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
...
Bal 5
...
Balances - Mandatory
...
Amount
...
Y
...
OBReadBalance1/Balance/Amount
Amount of money of the cash balance.
...
Bal 6
...
Balances - Mandatory
...
Currency
...
Y
...
OBReadBalance1/Balance/Amount/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".
...
Bal 7
...
Balances - Mandatory
...
CreditDebitIndicator
...
Y
...
OBReadBalance1/Balance/CreditDebitIndicator
Indicates whether the balance is a credit or a debit balance.
Usage: A zero balance is considered to be a credit balance.
Balance type, in a coded form.
...
Bal 8
...
Balances - Mandatory
...
Type
...
Y
...
OBReadBalance1/Balance/Type
Balance type, in a coded form.
...
Bal 9
...
Balances - Mandatory
...
DateTime
...
Y
...
OBReadBalance1/Balance/DateTime
Indicates the date (and time) of the balance.
...
Bal 10
...
Balances - Optional
...
CreditLine
...
Y
...
OBReadBalance1/Balance/CreditLine
Set of elements used to provide details on the credit line.
...
Bal 11
...
Balances - Mandatory
...
Included
...
Y
...
OBReadBalance1/Balance/CreditLine/Included
Indicates whether or not the credit line is included in the balance of the account.
Usage: If not present, credit line is not included in the balance amount of the account.
...
Bal 12
...
Balances - Optional
...
Amount
...
Y
...
OBReadBalance1/Balance/CreditLine/Amount
Amount of money of the credit line.
...
Bal 13
...
Balances - Mandatory
...
Currency
...
Y
...
OBReadBalance1/Balance/CreditLine/Amount/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".
...
Bal 14
...
Balances API - Optional
...
Type
...
N
...
OBReadBalance1/Balance/CreditLine/Type
Limit type, coded form
Beneficiaries Fields
...
...
...
...
...
...
Ben 1
...
Beneficiaries - Mandatory
...
OBReadBeneficiary1
...
Y
...
OBReadBeneficiary1
...
Ben 2
...
Beneficiaries - Mandatory
...
Data
...
Y
...
OBReadBeneficiary1/Data
...
Ben 3
...
Beneficiaries - Optional
...
Beneficiary
...
Y
...
OBReadBeneficiary1/Beneficiary
...
Ben 4
...
Beneficiaries - Optional
...
AccountId
...
Y
...
OBReadBeneficiary1/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
...
OBReadBeneficiary1/Beneficiary/BeneficiaryId
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
...
Ben 6
...
Beneficiaries - Optional
...
CreditorReferenceInformation
...
Y
...
OBReadBeneficiary1/Beneficiary/CreditorReferenceInformation
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.
...
Ben 7
...
Beneficiaries - Optional
...
Servicer
...
Y
...
OBReadBeneficiary1/Beneficiary/Servicer
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.
This is the servicer of the beneficiary account.
Note, SCAN only for UK accounts.
...
Ben 8
...
Beneficiaries - Mandatory
...
SchemeName
...
Y
...
OBReadBeneficiary1/Beneficiary/Servicer/SchemeName
Name of the identification scheme, in a coded form as published in an external list.
...
Ben 9
...
Beneficiaries - Mandatory
...
Identification
...
Y
...
OBReadBeneficiary1/Beneficiary/Servicer/Identification
Unique and unambiguous identification of the servicing institution.
...
Ben 10
...
Beneficiaries - Optional
...
CreditorAccount
...
Y
...
OBReadBeneficiary1/Beneficiary/CreditorAccount
Provides the details to identify the beneficiary account.
...
Ben 11
...
Beneficiaries - Mandatory
...
SchemeName
...
Y
...
OBReadBeneficiary1/Beneficiary/CreditorAccount/SchemeName
Name of the identification scheme, in a coded form as published in an external list.
...
Ben 12
...
Beneficiaries - Mandatory
...
Identification
...
Y
...
OBReadBeneficiary1/Beneficiary/CreditorAccount/Identification
Identification assigned by an institution to identify an account. This identification is known by the account owner.
...
Ben 13
...
Beneficiaries - Optional
...
Name
...
Y
...
OBReadBeneficiary1/Beneficiary/CreditorAccount/Name
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.
...
Ben 14
...
Beneficiaries - Optional
...
SecondaryIdentification
...
N
...
OBReadBeneficiary1/Beneficiary/CreditorAccount/SecondaryIdentification
This is secondary identification of the account, as assigned by the account servicing institution.
This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Direct Debits Fields
...
...
...
...
...
...
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/DirectDebit
Account to or from which a cash entry is made.
...
DD 4
...
Direct Debit - Mandatory
...
AccountId
...
Y
...
OBReadDirectDebit1/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/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/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/DirectDebit/DirectDebitStatusCode
Specifies the status of the direct debit in code form.
...
DD 8
...
Direct Debit - Mandatory
...
Name
...
Y
...
OBReadDirectDebit1/DirectDebit/Name
Name of Service User.
...
DD 9
...
Direct Debit - Optional
...
PreviousPaymentDate
...
Y
...
OBReadDirectDebit1/DirectDebit/PreviousPaymentDate
Date of most recent direct debit collection.
...
DD 10
...
Direct Debit - Optional
...
PreviousPaymentAmount
...
Y
...
OBReadDirectDebit1/DirectDebit/PreviousPaymentAmount
The amount of the most recent direct debit collection.
...
DD 11
...
Direct Debit - Mandatory
...
Currency
...
Y
...
OBReadDirectDebit1/DirectDebit/PreviousPaymentAmount/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".
Products Fields
...
...
...
...
...
...
Prod 1
...
Products - Mandatory
...
OBReadProduct1
...
Y
...
OBReadProduct1
...
Prod 2
...
Products - Mandatory
...
Data
...
Y
...
OBReadProduct1/Data
...
Prod 3
...
Products - Optional
...
Product
...
Y
...
OBReadProduct1/Data/Product
...
Prod 4
...
Products - Mandatory
...
AccountId
...
Y
...
OBReadProduct1/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
...
ProductIdentifier
...
Y
...
OBReadProduct1/Data/Product/ProductIdentifier
Identifier within the parent organisation for the product. Must be unique in the organisation.
...
Prod 6
...
Products - Mandatory
...
ProductType
...
Y
...
OBReadProduct1/Data/Product/ProductType
Descriptive code for the product category.
...
Prod 7
...
Products - Optional
...
ProductName
...
Y
...
OBReadProduct1/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
...
SecondaryProductIdentifier
...
N
...
OBReadProduct1/Data/Product/SecondaryProductIdentifier
Identifier within the parent organisation for the product. Must be unique in the organisation.
Standing Orders Fields
...
...
...
...
...
...
SO 1
...
Standing Orders - Mandatory
...
OBReadStandingOrder1
...
Y
...
OBReadStandingOrder1
...
SO 2
...
Standing Orders - Mandatory
...
Data
...
Y
...
OBReadStandingOrder1/Data
...
SO 3
...
Standing Orders - Optional
...
StandingOrder
...
Y
...
OBReadStandingOrder1/StandingOrder
Account to or from which a cash entry is made.
...
SO 4
...
Standing Orders - Mandatory
...
AccountId
...
Y
...
OBReadStandingOrder1/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 Orders - Optional
...
StandingOrderId
...
N
...
OBReadStandingOrder1/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 Orders - Mandatory
...
Frequency
...
Y
OBReadStandingOrder1/StandingOrder/Frequency
...
SO 7
...
Standing Orders - Optional
...
CreditorReferenceInformation
...
Y
...
OBReadStandingOrder1/StandingOrder/CreditorReferenceInformation
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.
...
SO 8
...
Standing Orders - Optional
...
FirstPaymentDate
...
Y
...
OBReadStandingOrder1/StandingOrder/FirstPaymentDate
The date on which the first payment for a Standing Order schedule will be made.
...
SO 9
...
Standing Orders - Optional
...
FirstPaymentAmount
...
Y
...
OBReadStandingOrder1/StandingOrder/FirstPaymentAmount
The amount of the first Standing Order
...
SO 10
...
Standing Orders - Mandatory
...
FirstPaymentCurrency
...
Y
...
OBReadStandingOrder1/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 11
...
Standing Orders - Mandatory
...
NextPaymentDate
...
Y
...
OBReadStandingOrder1/StandingOrder/NextPaymentDate
The date on which the next payment for a Standing Order schedule will be made.
...
SO 12
...
Standing Orders - Mandatory
...
NextPaymentAmount
...
Y
...
OBReadStandingOrder1/StandingOrder/NextPaymentAmount
The amount of the next Standing Order
...
SO 13
...
Standing Orders - Mandatory
...
NextPaymentCurrency
...
Y
...
OBReadStandingOrder1/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 14
...
Standing Orders - Optional
...
FinalPaymentDate
...
Y
...
OBReadStandingOrder1/StandingOrder/FinalPaymentDate
The date on which the final payment for a Standing Order schedule will be made.
...
SO 15
...
Standing Orders - Optional
...
FinalPaymentAmount
...
Y
...
OBReadStandingOrder1/StandingOrder/FinalPaymentAmount
The amount of the final Standing Order
...
SO 16
...
Standing Orders - Mandatory
...
FinalPaymentCurrency
...
Y
...
OBReadStandingOrder1/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 17
...
Standing Orders - Optional
...
Servicer
...
N
...
OBReadStandingOrder1/StandingOrder/Servicer
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.
This is the servicer of the beneficiary account.
...
SO 18
...
Standing Orders - Mandatory
...
SchemeName
...
N
...
OBReadStandingOrder1/StandingOrder/Servicer/SchemeName
Name of the identification scheme, in a coded form as published in an external list.
...
SO 19
...
Standing Orders - Mandatory
...
Identification
...
N
...
OBReadStandingOrder1/StandingOrder/Servicer/Identification
Unique and unambiguous identification of the servicing institution.
...
SO 20
...
Standing Orders - Optional
...
CreditorAccount
...
Y
...
OBReadStandingOrder1/StandingOrder/CreditorAccount
Provides the details to identify the beneficiary account.
...
SO 21
...
Standing Orders - Mandatory
...
SchemeName
...
Y
...
OBReadStandingOrder1/StandingOrder/CreditorAccount/SchemeName
Name of the identification scheme, in a coded form as published in an external list.
...
SO 22
...
Standing Orders - Mandatory
...
Identification
...
Y
...
OBReadStandingOrder1/StandingOrder/CreditorAccount/Identification
Beneficiary account identification.
...
SO 23
...
Standing Orders - Optional
...
Name
...
Y
...
OBReadStandingOrder1/StandingOrder/CreditorAccount/Name
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.
...
SO 24
...
Standing Orders - Optional
...
SecondaryIdentification
...
N
...
OBReadStandingOrder1/StandingOrder/CreditorAccount/SecondaryIdentification
This is secondary identification of the account, as assigned by the account servicing institution.
This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Transactions Fields
...
...
...
...
...
...
Tran 1
...
Transactions - Mandatory
...
OBReadTransaction1
...
Y
...
OBReadTransaction1
...
Tran 2
...
Transactions - Mandatory
...
Data
...
Y
...
OBReadTransaction1/Data
...
Tran 3
...
Transactions - Optional
...
Transaction
...
Y
...
OBReadTransaction1/Transaction
Provides further details on an entry in the report.
...
Tran 4
...
Transactions - Mandatory
...
AccountId
...
Y
...
OBReadTransaction1/Transaction/AccountId
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
...
Tran 5
...
Transactions - Optional
...
TransactionId
...
N
...
OBReadTransaction1/Transaction/TransactionId
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable
...
Tran 6
...
Transactions - Optional
...
TransactionReference
...
Y
...
OBReadTransaction1/Transaction/TransactionReference
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
*This is not available for all transactions returned via Transactions endpoint.
...
Tran 7
...
Transactions - Mandatory
...
Amount
...
Y
...
OBReadTransaction1/Transaction/Amount
Amount of money in the cash transaction entry.
...
Tran 8
...
Transactions - Mandatory
...
Currency
...
Y
...
OBReadTransaction1/Transaction/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".
...
Tran 9
...
Transactions - Mandatory
...
CreditDebitIndicator
...
Y
...
OBReadTransaction1/Transaction/CreditDebitIndicator
Indicates whether the transaction is a credit or a debit entry.
...
Tran 10
...
Transactions - Mandatory
...
Status
...
Y
...
OBReadTransaction1/Transaction/Status
Status of a transaction entry on the books of the account servicer.
...
Tran 11
...
Transactions - Mandatory
...
BookingDate
...
Y
...
OBReadTransaction1/Transaction/BookingDate
Date and time when a transaction entry is posted to an account on the account servicer's books.
Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.
...
Tran 12
...
Transactions - Optional
...
ValueDate
...
N
...
OBReadTransaction1/Transaction/ValueDate
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry.
Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date.
For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.
...
Tran 13
...
Transactions - Optional
...
TransactionInformation
...
Y
...
OBReadTransaction1/Transaction/TransactionInformation
Further details of the transaction.
This is the transaction narrative, which in unstructured text.
...
Tran 14
...
Transactions - Optional
...
AddressLine
...
N
...
OBReadTransaction1/Transaction/AddressLine
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
...
Tran 15
...
Transactions - Optional
...
BankTransactionCode
...
N
...
OBReadTransaction1/Transaction/BankTransactionCode
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
...
Tran 16
...
Transactions - Mandatory
...
Code
...
N
...
OBReadTransaction1/Transaction/BankTransactionCode/Code
Specifies the family within a domain.
...
Tran 17
...
Transactions - Mandatory
...
SubCode
...
N
...
OBReadTransaction1/Transaction/BankTransactionCode/SubCode
Specifies the sub-product family within a specific family.
...
Tran 18
...
Transactions - Optional
...
ProprietaryBankTransactionCode
...
N
...
OBReadTransaction1/Transaction/ProprietaryBankTransactionCode
Set of elements to fully identify a proprietary bank transaction code.
...
Tran 19
...
Transactions - Mandatory
...
Code
...
N
...
OBReadTransaction1/Transaction/ProprietaryBankTransactionCode/Code
Proprietary bank transaction code to identify the underlying transaction.
...
Tran 20
...
Transactions - Optional
...
Issuer
...
N
...
OBReadTransaction1/Transaction/ProprietaryBankTransaction/Issuer
Identification of the issuer of the proprietary bank transaction code.
...
Tran 21
...
Transactions - Optional
...
Balance
...
Y
...
OBReadTransaction1/Transaction/Balance
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
...
Tran 22
...
Transactions - Mandatory
...
Amount
...
Y
...
OBReadTransaction1/Transaction/Amount
Amount of money of the cash balance after a transaction entry is applied to the account..
...
Tran 23
...
Transactions - Mandatory
...
Currency
...
Y
...
OBReadTransaction1/Transaction/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.
...
Tran 24
...
Transactions - Mandatory
...
CreditDebitIndicator
...
Y
...
OBReadTransaction1/Transaction/CreditDebitIndicator
Indicates whether the balance is a credit or a debit balance.
Usage: A zero balance is considered to be a credit balance.
...
Tran 25
...
Transactions - Mandatory
...
Type
...
Y
...
OBReadTransaction1/Transaction/Type
Balance type, in a coded form.
...
Tran 26
...
Transactions - Optional
...
MerchantDetails
...
N
...
OBReadTransaction1/Transaction/MerchantDetails
Details of the merchant involved in the transaction.
...
Tran 27
...
Transactions - Optional
...
Name
...
N
...
OBReadTransaction1/Transaction/Name
Name by which the merchant is known.
...
Tran 28
...
Transactions - Optional
...
MerchantCategoryCode
...
N
...
OBReadTransaction1/Transaction/MerchantCategoryCode
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Payment Initiation API
...
https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v1.1
...
Payment Initiation API
...
First Trust Bank:
https://developer.firsttrustbank.co.uk/apis
Allied Irish Bank (GB):
https://developer.aibgb.co.uk/apis
...
First Trust Bank:
https://apis.firsttrustbank.co.uk/api/open-banking/v1.1
Allied Irish Bank (GB):
https://apis.aibgb.co.uk/api/open-banking/v1.1
...
API Endpoints
...
...
...
...
...
...
Endpoint 1
...
POST /payments
...
-
...
Y
...
API Endpoint available
...
Open Data API
...
First Trust Bank:
https://developer.firsttrustbank.co.uk/apis
Allied Irish Bank (GB):
https://developer.aibgb.co.uk/apis
...
First Trust Bank:
https://openapi.firsttrustbank.co.uk/open-banking/v2.1
Allied Irish Bank (GB):
https://openapi.aibgb.co.uk/open-banking/v2.1
...
For the latest information on AIB's Open Banking API implementation across our UK brands please see below links to the Open Banking Transparency Calendar and the specific Developer Portals:
- Transparency Calendar - AIB Group (UK) plc - ASPSP Documentation - Confluence (atlassian.net)
- Developer Portal AIB NI (ASPSP Brand 1) - AIB (NI) | home (firsttrustbank.co.uk)
- Developer Portal AIB GB (ASPSP Brand 2) - Allied Irish Bank (GB) Developer Portal | home (aibgb.co.uk)
| Warning |
|---|
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. |