find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/allica-bank-direct-debits-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Account and Transaction API Specification Direct Debits 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: Direct Debits
paths:
  /accounts/{AccountId}/direct-debits:
    get:
      tags:
      - Direct Debits
      summary: Get Direct Debits
      operationId: GetAccountsAccountIdDirectDebits
      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: Direct Debits 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:
                      DirectDebit:
                        type: array
                        items:
                          type: object
                          description: Account to or from which a cash entry is made.
                          required:
                          - AccountId
                          - MandateIdentification
                          - Name
                          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
                            DirectDebitId:
                              description: A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.
                              type: string
                              minLength: 1
                              maxLength: 40
                            MandateIdentification:
                              description: Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.
                              type: string
                              minLength: 1
                              maxLength: 35
                            DirectDebitStatusCode:
                              description: Specifies the status of the direct debit in code form.
                              type: string
                              enum:
                              - Active
                              - Inactive
                            Name:
                              description: Name of Service User.
                              type: string
                              minLength: 1
                              maxLength: 70
                            PreviousPaymentDateTime:
                              description: 'Date of most recent direct debit collection.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
                            Frequency:
                              description: Regularity with which direct debit instructions are to be created and processed.
                              type: string
                              x-namespaced-enum:
                              - UK.OBIE.Annual
                              - UK.OBIE.Daily
                              - UK.OBIE.Fortnightly
                              - UK.OBIE.HalfYearly
                              - UK.OBIE.Monthly
                              - UK.OBIE.NotKnown
                              - UK.OBIE.Quarterly
                              - UK.OBIE.Weekly
                            PreviousPaymentAmount:
                              type: object
                              required:
                              - Amount
                              - Currency
                              description: The amount of the most recent direct debit collection.
                              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}$
                  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:
                      DirectDebit:
                        type: array
                        items:
                          type: object
                          description: Account to or from which a cash entry is made.
                          required:
                          - AccountId
                          - MandateIdentification
                          - Name
                          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
                            DirectDebitId:
                              description: A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.
                              type: string
                              minLength: 1
                              maxLength: 40
                            MandateIdentification:
                              description: Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.
                              type: string
                              minLength: 1
                              maxLength: 35
                            DirectDebitStatusCode:
                              description: Specifies the status of the direct debit in code form.
                              type: string
                              enum:
                              - Active
                              - Inactive
                            Name:
                              description: Name of Service User.
                              type: string
                              minLength: 1
                              maxLength: 70
                            PreviousPaymentDateTime:
                              description: 'Date of most recent direct debit collection.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
                            Frequency:
                              description: Regularity with which direct debit instructions are to be created and processed.
                              type: string
                              x-namespaced-enum:
                              - UK.OBIE.Annual
                              - UK.OBIE.Daily
                              - UK.OBIE.Fortnightly
                              - UK.OBIE.HalfYearly
                              - UK.OBIE.Monthly
                              - UK.OBIE.NotKnown
                              - UK.OBIE.Quarterly
                              - UK.OBIE.Weekly
                            PreviousPaymentAmount:
                              type: object
                              required:
                              - Amount
                              - Currency
                              description: The amount of the most recent direct debit collection.
                              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}$
                  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:
                      DirectDebit:
                        type: array
                        items:
                          type: object
                          description: Account to or from which a cash entry is made.
                          required:
                          - AccountId
                          - MandateIdentification
                          - Name
                          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
                            DirectDebitId:
                              description: A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.
                              type: string
                              minLength: 1
                              maxLength: 40
                            MandateIdentification:
                              description: Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.
                              type: string
                              minLength: 1
                              maxLength: 35
                            DirectDebitStatusCode:
                              description: Specifies the status of the direct debit in code form.
                              type: string
                              enum:
                              - Active
                              - Inactive
                            Name:
                              description: Name of Service User.
                              type: string
                              minLength: 1
                              maxLength: 70
                            PreviousPaymentDateTime:
                              description: 'Date of most recent direct debit collection.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
                            Frequency:
                              description: Regularity with which direct debit instructions are to be created and processed.
                              type: string
                              x-namespaced-enum:
                              - UK.OBIE.Annual
                              - UK.OBIE.Daily
                              - UK.OBIE.Fortnightly
                              - UK.OBIE.HalfYearly
                              - UK.OBIE.Monthly
                              - UK.OBIE.NotKnown
                              - UK.OBIE.Quarterly
                              - UK.OBIE.Weekly
                            PreviousPaymentAmount:
                              type: object
                              required:
                              - Amount
                              - Currency
                              description: The amount of the most recent direct debit collection.
                              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}$
                  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
        '400':
          description: Bad request
          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:
                description: An array of detail error codes, and messages, and URLs to documentation to help remediation.
                type: object
                properties:
                  Code:
                    description: High level textual error code, to help categorize the errors.
                    type: string
                    minLength: 1
                    maxLength: 40
                  Id:
                    description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
                    type: string
                    minLength: 1
                    maxLength: 40
                  Message:
                    description: Brief Error message, e.g., 'There is something wrong with the request parameters provided'
                    type: string
                    minLength: 1
                    maxLength: 500
                  Errors:
                    items:
                      type: object
                      properties:
                        ErrorCode:
                          description: Low level textual error code, e.g., UK.OBIE.Field.Missing
                          type: string
                          x-namespaced-enum:
                          - UK.OBIE.Field.Expected
                          - UK.OBIE.Field.Invalid
                          - UK.OBIE.Field.InvalidDate
                          - UK.OBIE.Field.Missing
                          - UK.OBIE.Field.Unexpected
                          - UK.OBIE.Header.Invalid
                          - UK.OBIE.Header.Missing
                          - UK.OBIE.Reauthenticate
                          - UK.OBIE.Resource.ConsentMismatch
                          - UK.OBIE.Resource.InvalidConsentStatus
                          - UK.OBIE.Resource.InvalidFormat
                          - UK.OBIE.Resource.NotFound
                          - UK.OBIE.Rules.AfterCutOffDateTime
                          - UK.OBIE.Rules.DuplicateReference
                          - UK.OBIE.Signature.Invalid
                          - UK.OBIE.Signature.InvalidClaim
                          - UK.OBIE.Signature.Malformed
                          - UK.OBIE.Signature.Missing
                          - UK.OBIE.Signature.MissingClaim
                          - UK.OBIE.Signature.Unexpected
                          - UK.OBIE.UnexpectedError
                          - UK.OBIE.Unsupported.AccountIdentifier
                          - UK.OBIE.Unsupported.AccountSecondaryIdentifier
                          - UK.OBIE.Unsupported.Currency
                          - UK.OBIE.Unsupported.Frequency
                          - UK.OBIE.Unsupported.LocalInstrument
                          - UK.OBIE.Unsupported.Scheme
                        Message:
                          description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future''

                            OBIE doesn''t standardise this field'
                          type: string
                          minLength: 1
                          maxLength: 500
                        Path:
                          description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
                          type: string
                          minLength: 1
                          maxLength: 500
                        Url:
                          description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc
                          type: string
                      required:
                      - ErrorCode
                      - Message
                      additionalProperties: false
                      minProperties: 1
                    type: array
                    minItems: 1
                required:
                - Code
                - Message
                - Errors
                additionalProperties: false
            application/json:
              schema:
                description: An array of detail error codes, and messages, and URLs to documentation to help remediation.
                type: object
                properties:
                  Code:
                    description: High level textual error code, to help categorize the errors.
                    type: string
                    minLength: 1
                    maxLength: 40
                  Id:
                    description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
                    type: string
                    minLength: 1
                    maxLength: 40
                  Message:
                    description: Brief Error message, e.g., 'There is something wrong with the request parameters provided'
                    type: string
                    minLength: 1
                    maxLength: 500
                  Errors:
                    items:
                      type: object
                      properties:
                        ErrorCode:
                          description: Low level textual error code, e.g., UK.OBIE.Field.Missing
                          type: string
                          x-namespaced-enum:
                          - UK.OBIE.Field.Expected
                          - UK.OBIE.Field.Invalid
                          - UK.OBIE.Field.InvalidDate
                          - UK.OBIE.Field.Missing
                          - UK.OBIE.Field.Unexpected
                          - UK.OBIE.Header.Invalid
                          - UK.OBIE.Header.Missing
                          - UK.OBIE.Reauthenticate
                          - UK.OBIE.Resource.ConsentMismatch
                          - UK.OBIE.Resource.InvalidConsentStatus
                          - UK.OBIE.Resource.InvalidFormat
                          - UK.OBIE.Resource.NotFound
                          - UK.OBIE.Rules.AfterCutOffDateTime
                          - UK.OBIE.Rules.DuplicateReference
                          - UK.OBIE.Signature.Invalid
                          - UK.OBIE.Signature.InvalidClaim
                          - UK.OBIE.Signature.Malformed
                          - UK.OBIE.Signature.Missing
                          - UK.OBIE.Signature.MissingClaim
                          - UK.OBIE.Signature.Unexpected
                          - UK.OBIE.UnexpectedError
                          - UK.OBIE.Unsupported.AccountIdentifier
                          - UK.OBIE.Unsupported.AccountSecondaryIdentifier
                          - UK.OBIE.Unsupported.Currency
                          - UK.OBIE.Unsupported.Frequency
                          - UK.OBIE.Unsupported.LocalInstrument
                          - UK.OBIE.Unsupported.Scheme
                        Message:
                          description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future''

                            OBIE doesn''t standardise this field'
                          type: string
                          minLength: 1
                          maxLength: 500
                        Path:
                          description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
                          type: string
                          minLength: 1
                          maxLength: 500
                        Url:
                          description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc
                          type: string
  

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