Allica Bank Products API

openapi: 3.2.0
info:
  title: Account and Transaction API Specification Products 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: Products
paths:
  /accounts/{AccountId}/product:
    get:
      tags:
      - Products
      summary: Get Products
      operationId: GetAccountsAccountIdProduct
      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
      responses:
        '200':
          description: Products 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
                description: Product details of Other Product which is not avaiable in the standard list
                properties:
                  Data:
                    type: object
                    description: Aligning with the read write specs structure.
                    properties:
                      Product:
                        type: array
                        items:
                          type: object
                          description: Product details associated with the Account
                          required:
                          - AccountId
                          - ProductType
                          properties:
                            ProductName:
                              description: The name of the Product used for marketing purposes from a customer perspective. I.e. what the customer would recognise.
                              type: string
                              minLength: 1
                              maxLength: 350
                            ProductId:
                              description: The unique ID that has been internally assigned by the financial institution to each of the current account banking products they market to their retail and/or small to medium enterprise (SME) customers.
                              type: string
                              minLength: 1
                              maxLength: 40
                            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
                            SecondaryProductId:
                              description: Any secondary Identification which  supports Product Identifier to uniquely identify the current account banking products.
                              type: string
                              minLength: 1
                              maxLength: 70
                            ProductType:
                              description: 'Product type : Personal Current Account, Business Current Account'
                              type: string
                              enum:
                              - BusinessCurrentAccount
                              - CommercialCreditCard
                              - Other
                              - PersonalCurrentAccount
                              - SMELoan
                            MarketingStateId:
                              description: Unique and unambiguous identification of a  Product Marketing State.
                              type: string
                              minLength: 1
                              maxLength: 35
                            OtherProductType:
                              type: object
                              required:
                              - Name
                              - Description
                              description: Other product type details associated with the account.
                              properties:
                                Name:
                                  description: Long name associated with the product
                                  type: string
                                  minLength: 1
                                  maxLength: 350
                                Description:
                                  description: Description of the Product associated with the account
                                  type: string
                                  minLength: 1
                                  maxLength: 350
                                ProductDetails:
                                  type: object
                                  properties:
                                    Segment:
                                      type: array
                                      items:
                                        description: 'Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another.

                                          Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd'
                                        type: string
                                        enum:
                                        - GEAS
                                        - GEBA
                                        - GEBR
                                        - GEBU
                                        - GECI
                                        - GECS
                                        - GEFB
                                        - GEFG
                                        - GEG
                                        - GEGR
                                        - GEGS
                                        - GEOT
                                        - GEOV
                                        - GEPA
                                        - GEPR
                                        - GERE
                                        - GEST
                                        - GEYA
                                        - GEYO
                                        - PSCA
                                        - PSES
                                        - PSNC
                                        - PSNP
                                        - PSRG
                                        - PSSS
                                        - PSST
                                        - PSSW
                                    FeeFreeLength:
                                      description: The length/duration of the fee free period
                                      type: integer
                                    FeeFreeLengthPeriod:
                                      description: The unit of period (days, weeks, months etc.) of the promotional length
                                      type: string
                                      enum:
                                      - PACT
                                      - PDAY
                                      - PHYR
                                      - PMTH
                                      - PQTR
                                      - PWEK
                                      - PYER
                                    MonthlyMaximumCharge:
                                      description: The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order
                                      type: string
                                      pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
                                    Notes:
                                      type: array
                                      items:
                                        description: Optional additional notes to supplement the Core product details
                                        type: string
                                        minLength: 1
                                        maxLength: 2000
                                    OtherSegment:
                                      type: object
                                      required:
                                      - Name
                                      - Description
                                      properties:
                                        Code:
                                          description: The four letter Mnemonic used within an XML file to identify a code
                                          type: string
                                          pattern: ^\\w{0,4}$
                                        Name:
                                          description: Long name associated with the code
                                          type: string
                                          minLength: 1
                                          maxLength: 70
                                        Description:
                                          description: Description to describe the purpose of the code
                                          type: string
                                          minLength: 1
                                          maxLength: 350
                                      additionalProperties: false
                                CreditInterest:
                                  type: object
                                  required:
                                  - TierBandSet
                                  description: Details about the interest that may be payable to the Account holders
                                  properties:
                                    TierBandSet:
                                      type: array
                                      items:
                                        type: object
                                        description: The group of tiers or bands for which credit interest can be applied.
                                        required:
                                        - TierBandMethod
                                        - Destination
                                        - TierBand
                                        properties:
                                          TierBandMethod:
                                            description: 'The methodology of how credit interest is paid/applied. It can be:-

                                              1. Banded

                                              Interest rates are banded. i.e. Increasing rate on whole balance as balance increases.

                                              2. Tiered

                                              Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.

                                              3. Whole

                                              The same interest rate is applied irrespective of the product holder''s account balance'
                                            type: string
                                            enum:
                                            - INBA
                                            - INTI
                                            - INWH
                                          CalculationMethod:
                                            description: Methods of calculating interest
                                            type: string
                                            enum:
                                            - ITCO
                                            - ITOT
                                            - ITSI
                                          Destination:
                                            description: Describes whether accrued interest is payable only to the BCA or to another bank account
                                            type: string
                                            enum:
                                            - INOT
                                            - INPA
                                            - INSC
                                          Notes:
                                            type: array
                                            items:
                                              description: Optional additional notes to supplement the Tier Band Set details
                                              type: string
                                              minLength: 1
                                              maxLength: 2000
                                          OtherCalculationMethod:
                                            type: object
                                            required:
                                            - Name
                                            - Description
                                            properties:
                                              Code:
                                                description: The four letter Mnemonic used within an XML file to identify a code
                                                type: string
                                                pattern: ^\\w{0,4}$
                                              Name:
                                                description: Long name associated with the code
                                                type: string
                                                minLength: 1
                                                maxLength: 70
                                              Description:
                                                description: Description to describe the purpose of the code
                                                type: string
                                                minLength: 1
                                                maxLength: 350
                                            additionalProperties: false
                                          OtherDestination:
                                            type: object
                                            required:
                                            - Name
                                            - Description
                                            properties:
                                              Code:
                                                description: The four letter Mnemonic used within an XML file to identify a code
                                                type: string
                                                pattern: ^\\w{0,4}$
                                              Name:
                                                description: Long name associated with the code
                                                type: string
                                                minLength: 1
                                                maxLength: 70
                                              Description:
                                                description: Description to describe the purpose of the code
                                                type: string
                                                minLength: 1
                                                maxLength: 350
                                            additionalProperties: false
                                          TierBand:
                                            type: array
                                            items:
                                              type: object
                                              description: Tier Band Details
                                              required:
                                              - TierValueMinimum
                                              - ApplicationFrequency
                                              - FixedVariableInterestRateType
                                              - AER
                                              properties:
                                                Identification:
                                                  description: Unique and unambiguous identification of a  Tier Band for the Product.
                                                  type: string
                                                  minLength: 1
                                                  maxLength: 35
                                                TierValueMinimum:
                                                  description: Minimum deposit value for which the credit interest tier applies.
                                                  type: string
                                                  pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
                                                TierValueMaximum:
                                                  description: Maximum deposit value for which the credit interest tier applies.
                                                  type: string
                                                  pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
                                                CalculationFrequency:
                                                  description: How often is credit interest calculated for the account.
                                                  type: string
                                                  enum:
                                                  - FQAT
                                                  - FQDY
                                                  - FQHY
                                                  - FQMY
                                                  - FQOT
                                                  - FQQY
                                                  - FQSD
                                                  - FQWY
                                                  - FQYY
                                                ApplicationFrequency:
                                                  description: How often is interest applied to the Product for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's account.
                                                  type: string
                                                  enum:
                                                  - FQAT
                                                  - FQDY
                                                  - FQHY
                                                  - FQMY
                                                  - FQOT
                                                  - FQQY
                                                  - FQSD
                                                  - FQWY
                                                  - FQYY
                                                DepositInterestAppliedCoverage:
                                                  description: Amount on which Interest applied.
                                                  type: string
                                                  enum:
                                                  - INBA
                                                  - INTI
                                                  - INWH
                                                FixedVariableInterestRateType:
                                                  description: Type of interest rate, Fixed or Variable
                                                  type: string
                                                  enum:
                                                  - INFI
                                                  - INVA
                                                AER:
                                                  description: 'The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made.

                                                    Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A'
                                                  type: string
                                                  pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
                                                BankInterestRateType:
                                                  description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the account holder's account.
                                                  type: string
                                                  enum:
                                                  - INBB
                                                  - INFR
                                                  - INGR
                                                  - INLR
                                                  - INNE
                                                  - INOT
                                                BankInterestRate:
                                                  description: Bank Interest for the product
                                                  type: string
                                                  pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
                                                Notes:
                                                  type: array
                                                  items:
                                                    description: Optional additional notes to supplement the Tier Band details
                                                    type: string
                                                    minLength: 1
                                                    maxLength: 2000
                                                OtherBankInterestType:
                                                  type: object
                                                  required:
                                                  - Name
                                                  - Description
                                                  description: Other interest rate types which are not available in the standard code list
                                                  properties:
                                                    Code:
                                                      description: The four letter Mnemonic used within an XML file to identify a code
                                                      type: string
                                                      pattern: ^\\w{0,4}$
                                                    Name:
                                                      description: Long name associated with the code
                                                      type: string
                                                      minLength: 1
                                                      maxLength: 70
                                                    Description:
                                                      description: Description to describe the purpose of the code
                                                      type: string
                                                      minLength: 1
                                                      maxLength: 350
                                                OtherApplicationFrequency:
                                                  type: object
                                                  required:
                                                  - Name
                                                  - Description
                                                  description: Other application frequencies that are not available in the standard code list
                                                  properties:
                                                    Code:
                                                      description: The four letter Mnemonic used within an XML file to identify a code
                                                      type: string
                                                      pattern: ^\\w{0,4}$
                                                    Name:
                                                      description: Long name associated with the code
                                                      type: string
                                                      minLength: 1
                                                      maxLength: 70
                                                    Description:
                                                      description: Description to describe the purpose of the code
                                                      type: string
                                                      minLength: 1
                                                      maxLength: 350
                                                  additionalProperties: false
                                                OtherCalculationFrequency:
                                                  type: object
                                                  required:
                                                  - Name
                                                  - Description
                                                  description: Other calculation frequency which is not available in the standard code set.
                                                  properties:
                                                    Code:
                                                      description: The four letter Mnemonic used within an XML file to identify a code
                                                      type: string
                                                      pattern: ^\\w{0,4}$
                                                    Name:
                                                      description: Long name associated with the code
                                                      type: string
                                                      minLength: 1
                                                      maxLength: 70
                                                    Description:
                                                      description: Description to describe the purpose of the code
                                                      type: string
                                                      minLength: 1
                                                      maxLength: 350
                                                  additionalProperties: false
                                            minItems: 1
                                      minItems: 1
                                Overdraft:
                                  type: object
                                  required:
                                  - OverdraftTierBandSet
                                  description: Borrowing details
                                  properties:
                                    Notes:
                                      type: array
                                      items:
                                        description: Associated Notes about the overdraft rates
                                        type: string
                                        minLength: 1
                                        maxLength: 2000
                                    OverdraftTierBandSet:
                   

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