Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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-scheduled-payments-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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Account and Transaction API Specification Scheduled Payments 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: Scheduled Payments
paths:
/accounts/{AccountId}/scheduled-payments:
get:
tags:
- Scheduled Payments
summary: Get Scheduled Payments
operationId: GetAccountsAccountIdScheduledPayments
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: Scheduled Payments 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:
ScheduledPayment:
type: array
items:
type: object
required:
- AccountId
- ScheduledPaymentDateTime
- ScheduledType
- InstructedAmount
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
ScheduledPaymentId:
description: A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
type: string
minLength: 1
maxLength: 40
ScheduledPaymentDateTime:
description: 'The date on which the scheduled payment will be made.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
ScheduledType:
description: Specifies the scheduled payment date type requested
type: string
enum:
- Arrival
- Execution
Reference:
description: 'Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.
If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor''s reference or payment remittance identification should be quoted in the end-to-end transaction identification.'
type: string
minLength: 1
maxLength: 35
DebtorReference:
description: A reference value provided by the PSU to the PISP while setting up the scheduled payment.
type: string
minLength: 1
maxLength: 35
InstructedAmount:
type: object
required:
- Amount
- Currency
description: 'Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Usage: This amount has to be transported unchanged through the transaction chain.'
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}$
CreditorAgent:
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.
This is the servicer of the beneficiary 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
CreditorAccount:
type: object
required:
- SchemeName
- Identification
description: Provides the details to identify the beneficiary 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.BBAN
- UK.OBIE.IBAN
- UK.OBIE.PAN
- UK.OBIE.Paym
- UK.OBIE.SortCodeAccountNumber
Identification:
description: Beneficiary account identification.
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
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:
ScheduledPayment:
type: array
items:
type: object
required:
- AccountId
- ScheduledPaymentDateTime
- ScheduledType
- InstructedAmount
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
ScheduledPaymentId:
description: A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
type: string
minLength: 1
maxLength: 40
ScheduledPaymentDateTime:
description: 'The date on which the scheduled payment will be made.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
ScheduledType:
description: Specifies the scheduled payment date type requested
type: string
enum:
- Arrival
- Execution
Reference:
description: 'Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.
If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor''s reference or payment remittance identification should be quoted in the end-to-end transaction identification.'
type: string
minLength: 1
maxLength: 35
DebtorReference:
description: A reference value provided by the PSU to the PISP while setting up the scheduled payment.
type: string
minLength: 1
maxLength: 35
InstructedAmount:
type: object
required:
- Amount
- Currency
description: 'Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Usage: This amount has to be transported unchanged through the transaction chain.'
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}$
CreditorAgent:
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.
This is the servicer of the beneficiary 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
CreditorAccount:
type: object
required:
- SchemeName
- Identification
description: Provides the details to identify the beneficiary 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.BBAN
- UK.OBIE.IBAN
- UK.OBIE.PAN
- UK.OBIE.Paym
- UK.OBIE.SortCodeAccountNumber
Identification:
description: Beneficiary account identification.
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
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:
ScheduledPayment:
type: array
items:
type: object
required:
- AccountId
- ScheduledPaymentDateTime
- ScheduledType
- InstructedAmount
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
ScheduledPaymentId:
description: A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
type: string
minLength: 1
maxLength: 40
ScheduledPaymentDateTime:
description: 'The date on which the scheduled payment will be made.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
ScheduledType:
description: Specifies the scheduled payment date type requested
type: string
enum:
- Arrival
- Execution
Reference:
description: 'Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.
If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor''s reference or payment remittance identification should be quoted in the end-to-end transaction identification.'
type: string
minLength: 1
maxLength: 35
DebtorReference:
description: A reference value provided by the PSU to the PISP while setting up the scheduled payment.
type: string
minLength: 1
maxLength: 35
InstructedAmount:
type: object
required:
- Amount
- Currency
description: 'Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Usage: This amount has to be transported unchanged through the transaction chain.'
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}$
CreditorAgent:
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.
This is the servicer of the beneficiary 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
CreditorAccount:
type: object
required:
- SchemeName
- Identification
description: Provides the details to identify the beneficiary 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.BBAN
- UK.OBIE.IBAN
- UK.OBIE.PAN
- UK.OBIE.Paym
- UK.OBIE.SortCodeAccountNumber
Identification:
description: Beneficiary account identification.
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
m
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/allica-bank/refs/heads/main/openapi/allica-bank-scheduled-payments-api-openapi.yml