Allica Bank Transactions API

openapi: 3.2.0
info:
  title: Account and Transaction API Specification Transactions API
  description: '# AISP API Overview


    These APIs can be used to access account information for Allica Business Rewards accounts.


    ## Base URL

    The base URL for all AIS APIs is: `https://rs1.api.ob.allica.bank/open-banking/v4.0/aisp/**`


    ## Account Access Consents

    [Account Access Consents API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Account_Access)


    ## Accounts

    [Accounts API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Accounts)


    Accounts API supports only Business Rewards Account and Savings Pot.


    ## Balances

    [Balances API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Balances)


    Balances shown in this endpoint provide the `InterimAvailable` value.


    `InterimAvailable` balance is the value displayed most widely to our customers within the Allica apps.


    ## Transactions

    [Transactions API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Transactions)


    Pagination is supported on GET /accounts/{AccountId}/transactions end point with a page size of 100 transactions.


    > Please note GET /transactions end point is not supported


    ## Beneficiaries

    [Beneficiaries API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Beneficiaries)


    Payment recipients are accessible via the Beneficiaries API. This API is useful when setting up payments.


    ## Direct Debits

    [Direct Debits API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Direct_Debits)


    Only GET /accounts/{accountId}/direct-debits is supported.


    ## Standing Orders

    [Standing Orders API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Standing_Orders)


    Only GET /acccounts/{accountId}/standing-orders are supported



    ## Offers

    [Offers API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Offers)


    Not currently supported.


    ## Parties

    [Parties API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Parties)


    Not currently supported.


    ## Scheduled Payments

    [Scheduled Payments API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Scheduled_Payments)


    Only GET /accounts/{accountId}/scheduled-payments is supported.

    '
  termsOfService: https://www.openbanking.org.uk/terms
  contact:
    name: Service Desk
    email: ServiceDesk@openbanking.org.uk
  license:
    name: open-licence
    url: https://www.openbanking.org.uk/open-licence
  version: 3.1.10
servers:
- url: /open-banking/v3.1/aisp
tags:
- name: Transactions
paths:
  /accounts/{AccountId}/transactions:
    get:
      tags:
      - Transactions
      summary: Get Transactions
      operationId: GetAccountsAccountIdTransactions
      parameters:
      - name: AccountId
        in: path
        description: AccountId
        required: true
        schema:
          type: string
      - in: header
        name: x-fapi-auth-date
        required: false
        description: 'The time when the PSU last logged in with the TPP.

          All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:

          Sun, 10 Sep 2017 19:43:31 UTC'
        schema:
          type: string
          pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
      - in: header
        name: x-fapi-customer-ip-address
        required: false
        description: The PSU's IP address if the PSU is currently logged in with the TPP.
        schema:
          type: string
      - in: header
        name: x-fapi-interaction-id
        required: false
        description: An RFC4122 UID used as a correlation id.
        schema:
          type: string
      - in: header
        name: Authorization
        required: true
        description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        schema:
          type: string
      - in: header
        name: x-customer-user-agent
        description: Indicates the user-agent that the PSU is using.
        required: false
        schema:
          type: string
      - in: query
        name: fromBookingDateTime
        description: 'The UTC ISO 8601 Date Time to filter transactions FROM

          NB Time component is optional - set to 00:00:00 for just Date.

          If the Date Time contains a timezone, the ASPSP must ignore the timezone component.'
        schema:
          type: string
          format: date-time
      - in: query
        name: toBookingDateTime
        description: 'The UTC ISO 8601 Date Time to filter transactions TO

          NB Time component is optional - set to 00:00:00 for just Date.

          If the Date Time contains a timezone, the ASPSP must ignore the timezone component.'
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Transactions Read
          headers:
            x-fapi-interaction-id:
              description: An RFC4122 UID used as a correlation id.
              required: true
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                required:
                - Data
                properties:
                  Data:
                    type: object
                    properties:
                      Transaction:
                        type: array
                        items:
                          type: object
                          description: Provides further details on an entry in the report.
                          required:
                          - AccountId
                          - CreditDebitIndicator
                          - Status
                          - BookingDateTime
                          - Amount
                          properties:
                            AccountId:
                              description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
                              type: string
                              minLength: 1
                              maxLength: 40
                            TransactionId:
                              description: Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
                              type: string
                              minLength: 1
                              maxLength: 210
                            TransactionReference:
                              description: Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
                              type: string
                              minLength: 1
                              maxLength: 210
                            StatementReference:
                              type: array
                              items:
                                description: Unique reference for the statement. This reference may be optionally populated if available.
                                type: string
                                minLength: 1
                                maxLength: 35
                            CreditDebitIndicator:
                              description: Indicates whether the transaction is a credit or a debit entry.
                              type: string
                              enum:
                              - Credit
                              - Debit
                            Status:
                              description: Status of a transaction entry on the books of the account servicer.
                              type: string
                              enum:
                              - Booked
                              - Pending
                              - Rejected
                            TransactionMutability:
                              description: Specifies the Mutability of the Transaction record.
                              type: string
                              enum:
                              - Mutable
                              - Immutable
                            BookingDateTime:
                              description: '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.All dates in the JSON payloads are represented in ISO 8601 date-time format.

                                All date-time fields in responses must include the timezone. An example is below:

                                2017-04-05T10:43:07+00:00'
                              type: string
                              format: date-time
                            ValueDateTime:
                              description: '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.All dates in the JSON payloads are represented in ISO 8601 date-time format.

                                All date-time fields in responses must include the timezone. An example is below:

                                2017-04-05T10:43:07+00:00'
                              type: string
                              format: date-time
                            TransactionInformation:
                              description: 'Further details of the transaction.

                                This is the transaction narrative, which is unstructured text.'
                              type: string
                              minLength: 1
                              maxLength: 500
                            AddressLine:
                              description: Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
                              type: string
                              minLength: 1
                              maxLength: 70
                            Amount:
                              type: object
                              required:
                              - Amount
                              - Currency
                              description: Amount of money in the cash transaction entry.
                              properties:
                                Amount:
                                  description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
                                  type: string
                                  pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
                                Currency:
                                  description: 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".
                                  type: string
                                  pattern: ^[A-Z]{3,3}$
                            ChargeAmount:
                              type: object
                              required:
                              - Amount
                              - Currency
                              description: Transaction charges to be paid by the charge bearer.
                              properties:
                                Amount:
                                  description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
                                  type: string
                                  pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
                                Currency:
                                  description: 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".
                                  type: string
                                  pattern: ^[A-Z]{3,3}$
                            CurrencyExchange:
                              type: object
                              required:
                              - SourceCurrency
                              - ExchangeRate
                              description: Set of elements used to provide details on the currency exchange.
                              properties:
                                SourceCurrency:
                                  description: Currency from which an amount is to be converted in a currency conversion.
                                  type: string
                                  pattern: ^[A-Z]{3,3}$
                                TargetCurrency:
                                  description: Currency into which an amount is to be converted in a currency conversion.
                                  type: string
                                  pattern: ^[A-Z]{3,3}$
                                UnitCurrency:
                                  description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
                                  type: string
                                  pattern: ^[A-Z]{3,3}$
                                ExchangeRate:
                                  description: 'Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.

                                    Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).'
                                  type: number
                                ContractIdentification:
                                  description: Unique identification to unambiguously identify the foreign exchange contract.
                                  type: string
                                  minLength: 1
                                  maxLength: 35
                                QuotationDate:
                                  description: 'Date and time at which an exchange rate is quoted.All dates in the JSON payloads are represented in ISO 8601 date-time format.

                                    All date-time fields in responses must include the timezone. An example is below:

                                    2017-04-05T10:43:07+00:00'
                                  type: string
                                  format: date-time
                                InstructedAmount:
                                  type: object
                                  required:
                                  - Amount
                                  - Currency
                                  description: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
                                  properties:
                                    Amount:
                                      description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
                                      type: string
                                      pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
                                    Currency:
                                      description: 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".
                                      type: string
                                      pattern: ^[A-Z]{3,3}$
                            BankTransactionCode:
                              type: object
                              required:
                              - Code
                              - SubCode
                              description: Set of elements used to fully identify the type of underlying transaction resulting in an entry.
                              properties:
                                Code:
                                  description: Specifies the family within a domain.
                                  type: string
                                SubCode:
                                  description: Specifies the sub-product family within a specific family.
                                  type: string
                            ProprietaryBankTransactionCode:
                              type: object
                              required:
                              - Code
                              description: Set of elements to fully identify a proprietary bank transaction code.
                              properties:
                                Code:
                                  description: Proprietary bank transaction code to identify the underlying transaction.
                                  type: string
                                  minLength: 1
                                  maxLength: 35
                                Issuer:
                                  description: Identification of the issuer of the proprietary bank transaction code.
                                  type: string
                                  minLength: 1
                                  maxLength: 35
                              additionalProperties: false
                            Balance:
                              type: object
                              required:
                              - CreditDebitIndicator
                              - Type
                              - Amount
                              description: 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.
                              properties:
                                CreditDebitIndicator:
                                  description: 'Indicates whether the balance is a credit or a debit balance.

                                    Usage: A zero balance is considered to be a credit balance.'
                                  type: string
                                  enum:
                                  - Credit
                                  - Debit
                                Type:
                                  description: Balance type, in a coded form.
                                  type: string
                                  enum:
                                  - ClosingAvailable
                                  - ClosingBooked
                                  - ClosingCleared
                                  - Expected
                                  - ForwardAvailable
                                  - Information
                                  - InterimAvailable
                                  - InterimBooked
                                  - InterimCleared
                                  - OpeningAvailable
                                  - OpeningBooked
                                  - OpeningCleared
                                  - PreviouslyClosedBooked
                                Amount:
                                  type: object
                                  required:
                                  - Amount
                                  - Currency
                                  description: Amount of money of the cash balance after a transaction entry is applied to the account..
                                  properties:
                                    Amount:
                                      description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
                                      type: string
                                      pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
                                    Currency:
                                      description: 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".
                                      type: string
                                      pattern: ^[A-Z]{3,3}$
                              additionalProperties: false
                            MerchantDetails:
                              type: object
                              description: Details of the merchant involved in the transaction.
                              properties:
                                MerchantName:
                                  description: Name by which the merchant is known.
                                  type: string
                                  minLength: 1
                                  maxLength: 350
                                MerchantCategoryCode:
                                  description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
                                  type: string
                                  minLength: 3
                                  maxLength: 4
                            CreditorAgent:
                              type: object
                              description: Financial institution servicing an account for the creditor.
                              properties:
                                SchemeName:
                                  description: Name of the identification scheme, in a coded form as published in an external list.
                                  type: string
                                  x-namespaced-enum:
                                  - UK.OBIE.BICFI
                                Identification:
                                  description: Unique and unambiguous identification of a financial institution or a branch of a financial institution.
                                  type: string
                                  minLength: 1
                                  maxLength: 35
                                Name:
                                  description: Name by which an agent is known and which is usually used to identify that agent.
                                  type: string
                                  minLength: 1
                                  maxLength: 140
                                PostalAddress:
                                  type: object
                                  description: Information that locates and identifies a specific address, as defined by postal services.
                                  properties:
                                    AddressType:
                                      description: Identifies the nature of the postal address.
                                      type: string
                                      enum:
                                      - Business
                                      - Correspondence
                                      - DeliveryTo
                                      - MailTo
                                      - POBox
                                      - Postal
                                      - Residential
                                      - Statement
                                    Department:
                                      description: Identification of a division of a large organisation or building.
                                      type: string
                                      minLength: 1
                                      maxLength: 70
                                    SubDepartment:
                                      description: Identification of a sub-division of a large organisation or building.
                                      type: string
                                      minLength: 1
                                      maxLength: 70
                                    StreetName:
                                      description: Name of a street or thoroughfare.
                                      type: string
                                      minLength: 1
                                      maxLength: 70
                                    BuildingNumber:
                                      description: Number that identifies the position of a building on a street.
                                      type: string
                                      minLength: 1
                                      maxLength: 16
                                    PostCode:
                                      description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
                                      type: string
                                      minLength: 1
                                      maxLength: 16
                                    TownName:
                                      description: Name of a built-up area, with defined boundaries, and a local government.
                                      type: string
                                      minLength: 1
                                      maxLength: 35
                                    CountrySubDivision:
                                      description: Identifies a subdivision of a country such as state, region, county.
                                      type: string
                                      minLength: 1
                                      maxLength: 35
                                    Country:
                                      description: Nation with its own government.
                                      type: string
                                      pattern: ^[A-Z]{2,2}$
                                    AddressLine:
                                      type: array
                                      items:
                                        description: Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
                                        type: string
                                        minLength: 1
                                        maxLength: 70
                                      minItems: 0
                                      maxItems: 7
                            CreditorAccount:
                              type: object
                              description: Unambiguous identification of the account of the creditor, in the case of a debit transaction.
                              properties:
                                SchemeName:
                                  description: Name of the identification scheme, in a coded form as published in an external list.
                                  type: string
                                  x-namespaced-enum:
                                  - UK.OBIE.BBAN
                                  - UK.OBIE.IBAN
                                  - UK.OBIE.PAN
                                  - UK.OBIE.Paym
                                  - UK.OBIE.SortCodeAccountNumber
                                Identification:
                                  description: Identification assigned by an institution to identify an account. This identification is known by the account owner.
                                  type: string
                                  minLength: 1
                                  maxLength: 256
                                Name:
                                  description: 'The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP''s online channels.

                                    Note, the account name is not the product name or the nickname of the account.'
                                  type: string
                                  minLength: 1
                                  maxLength: 350
                                SecondaryIdentification:
                                  description: '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).'
                                  type: string
                                  minLength: 1
                                  maxLength: 34
                            DebtorAgent:
                              type: object
                              description: Financial institution servicing an account for the debtor.
                              properties:
                                SchemeName:
                                  description: Name of the identification scheme, in a coded form as published in an external list.
                                  type: string
                                  x-namespaced-enum:
                                  - UK.OBIE.BICFI
                                Identification:
                                  description: Unique and unambiguous identification of a financial institution or a branch of a financial institution.
                                  type: string
                                  minLength: 1
                                  maxLength: 35
                                Name:
                                  description: Name by which an agent is known and which is usually used to identify that agent.
                                  type: string
                                  minLength: 1
                                  maxLength: 140
                                PostalAddress:
                                  type: object
                                  description: Information that locates and identifies a specific address, as defined by postal services.
                                  properties:
                                    AddressType:
                                      description: Identifies the nature of the postal address.
                                      type: string
                                      enum:
                                      - Business
                                      - Correspondence
                                      - DeliveryTo
                                      - MailTo
                                      - POBox
                                      - Postal
                                      - Residential
                                      - Statement
                                    Department:
                                      description: Identification of a division of a large organisatio

# --- truncated at 32 KB (151 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/allica-bank/refs/heads/main/openapi/allica-bank-transactions-api-openapi.yml