Allica Bank Accounts API

openapi: 3.2.0
info:
  title: Account and Transaction API Specification Accounts 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: Accounts
paths:
  /accounts:
    get:
      tags:
      - Accounts
      summary: Get Accounts
      operationId: GetAccounts
      parameters:
      - 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: Accounts 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:
                      Account:
                        type: array
                        items:
                          type: object
                          description: "Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched:\n\n  * Data.Currency\n  * Data.AccountType\n  * Data.AccountSubType\n\nFor all other accounts, the fields must be populated by the ASPSP."
                          required:
                          - AccountId
                          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
                            Status:
                              description: Specifies the status of account resource in code form.
                              type: string
                              enum:
                              - Deleted
                              - Disabled
                              - Enabled
                              - Pending
                              - ProForma
                            StatusUpdateDateTime:
                              description: 'Date and time at which the resource status was updated.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
                            Currency:
                              description: 'Identification 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.'
                              type: string
                              pattern: ^[A-Z]{3,3}$
                            AccountType:
                              description: Specifies the type of account (personal or business).
                              type: string
                              enum:
                              - Business
                              - Personal
                            AccountSubType:
                              description: Specifies the sub type of account (product family group).
                              type: string
                              enum:
                              - ChargeCard
                              - CreditCard
                              - CurrentAccount
                              - EMoney
                              - Loan
                              - Mortgage
                              - PrePaidCard
                              - Savings
                            Description:
                              description: Specifies the description of the account type.
                              type: string
                              minLength: 1
                              maxLength: 35
                            Nickname:
                              description: The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
                              type: string
                              minLength: 1
                              maxLength: 70
                            OpeningDate:
                              description: 'Date on which the account and related basic services are effectively operational for the account owner.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
                            MaturityDate:
                              description: 'Maturity date of the account.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
                            SwitchStatus:
                              description: Specifies the switch status for the account, in a coded form.
                              type: string
                              x-namespaced-enum:
                              - UK.CASS.NotSwitched
                              - UK.CASS.SwitchCompleted
                            Account:
                              type: array
                              items:
                                type: object
                                description: Provides the details to identify an account.
                                required:
                                - SchemeName
                                - Identification
                                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
                            Servicer:
                              type: object
                              required:
                              - SchemeName
                              - Identification
                              description: 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.
                              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 the servicing institution.
                                  type: string
                                  minLength: 1
                                  maxLength: 35
                          additionalProperties: false
                  Links:
                    type: object
                    description: Links relevant to the payload
                    properties:
                      Self:
                        type: string
                        format: uri
                      First:
                        type: string
                        format: uri
                      Prev:
                        type: string
                        format: uri
                      Next:
                        type: string
                        format: uri
                      Last:
                        type: string
                        format: uri
                    additionalProperties: false
                    required:
                    - Self
                  Meta:
                    title: MetaData
                    type: object
                    description: Meta Data relevant to the payload
                    properties:
                      TotalPages:
                        type: integer
                        format: int32
                      FirstAvailableDateTime:
                        description: '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
                      LastAvailableDateTime:
                        description: '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
                    additionalProperties: false
                additionalProperties: false
            application/json:
              schema:
                type: object
                required:
                - Data
                properties:
                  Data:
                    type: object
                    properties:
                      Account:
                        type: array
                        items:
                          type: object
                          description: "Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched:\n\n  * Data.Currency\n  * Data.AccountType\n  * Data.AccountSubType\n\nFor all other accounts, the fields must be populated by the ASPSP."
                          required:
                          - AccountId
                          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
                            Status:
                              description: Specifies the status of account resource in code form.
                              type: string
                              enum:
                              - Deleted
                              - Disabled
                              - Enabled
                              - Pending
                              - ProForma
                            StatusUpdateDateTime:
                              description: 'Date and time at which the resource status was updated.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
                            Currency:
                              description: 'Identification 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.'
                              type: string
                              pattern: ^[A-Z]{3,3}$
                            AccountType:
                              description: Specifies the type of account (personal or business).
                              type: string
                              enum:
                              - Business
                              - Personal
                            AccountSubType:
                              description: Specifies the sub type of account (product family group).
                              type: string
                              enum:
                              - ChargeCard
                              - CreditCard
                              - CurrentAccount
                              - EMoney
                              - Loan
                              - Mortgage
                              - PrePaidCard
                              - Savings
                            Description:
                              description: Specifies the description of the account type.
                              type: string
                              minLength: 1
                              maxLength: 35
                            Nickname:
                              description: The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
                              type: string
                              minLength: 1
                              maxLength: 70
                            OpeningDate:
                              description: 'Date on which the account and related basic services are effectively operational for the account owner.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
                            MaturityDate:
                              description: 'Maturity date of the account.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
                            SwitchStatus:
                              description: Specifies the switch status for the account, in a coded form.
                              type: string
                              x-namespaced-enum:
                              - UK.CASS.NotSwitched
                              - UK.CASS.SwitchCompleted
                            Account:
                              type: array
                              items:
                                type: object
                                description: Provides the details to identify an account.
                                required:
                                - SchemeName
                                - Identification
                                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
                            Servicer:
                              type: object
                              required:
                              - SchemeName
                              - Identification
                              description: 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.
                              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 the servicing institution.
                                  type: string
                                  minLength: 1
                                  maxLength: 35
                          additionalProperties: false
                  Links:
                    type: object
                    description: Links relevant to the payload
                    properties:
                      Self:
                        type: string
                        format: uri
                      First:
                        type: string
                        format: uri
                      Prev:
                        type: string
                        format: uri
                      Next:
                        type: string
                        format: uri
                      Last:
                        type: string
                        format: uri
                    additionalProperties: false
                    required:
                    - Self
                  Meta:
                    title: MetaData
                    type: object
                    description: Meta Data relevant to the payload
                    properties:
                      TotalPages:
                        type: integer
                        format: int32
                      FirstAvailableDateTime:
                        description: '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
                      LastAvailableDateTime:
                        description: '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
                    additionalProperties: false
                additionalProperties: false
            application/jose+jwe:
              schema:
                type: object
                required:
                - Data
                properties:
                  Data:
                    type: object
                    properties:
                      Account:
                        type: array
                        items:
                          type: object
                          description: "Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched:\n\n  * Data.Currency\n  * Data.AccountType\n  * Data.AccountSubType\n\nFor all other accounts, the fields must be populated by the ASPSP."
                          required:
                          - AccountId
                          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
                            Status:
                              description: Specifies the status of account resource in code form.
                              type: string
                              enum:
                              - Deleted
                              - Disabled
                              - Enabled
                              - Pending
                              - ProForma
                            StatusUpdateDateTime:
                              description: 'Date and time at which the resource status was updated.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
                            Currency:
                              description: 'Identification 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.'
                              type: string
                              pattern: ^[A-Z]{3,3}$
                            AccountType:
                              description: Specifies the type of account (personal or business).
                              type: string
                              enum:
                              - Business
                              - Personal
                            AccountSubType:
                              description: Specifies the sub type of account (product family group).
                              type: string
                              enum:
                              - ChargeCard
                              - CreditCard
                              - CurrentAccount
                              - EMoney
                              - Loan
                              - Mortgage
                              - PrePaidCard
                              - Savings
                            Description:
                              description: Specifies the description of the account type.
                              type: string
                              minLength: 1
                              maxLength: 35
                            Nickname:
                              description: The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
                              type: string
                              minLength: 1
                              maxLength: 70
                            OpeningDate:
                              description: 'Date on which the account and related basic services are effectively operational for the account owner.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
                            MaturityDate:
                              description: 'Maturity date of the account.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
                            SwitchStatus:
                              description: Specifies the switch status for the account, in a coded form.
                              type: string
                              x-namespaced-enum:
                              - UK.CASS.NotSwitched
                              - UK.CASS.SwitchCompleted
                            Account:
                              type: array
                              items:
                                type: object
                                description: Provides the details to identify an account.
                                required:
                                - SchemeName
                                - Identification
                                properties:
                                  SchemeName:
                                    description: Name of the identification sc

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