How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
UK Open Banking

UK Open Banking Scheduled Payments API

The Scheduled Payments API from UK Open Banking — 2 operation(s) for scheduled payments.

Documentation Provider Profile APIs.io OpenAPI GitHub

UK Open Banking Scheduled Payments API is one of 42 APIs that UK Open Banking publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scheduled Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and rate-limit docs.

This API exposes 2 operations across 2 paths, and defines 41 schemas. It is described by OpenAPI 3.0.0, at version 4.0.1.

Requests are made against a single base URL, /open-banking/v4.0/aisp.

2 operations 2 paths 41 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.1
Base URL
https://{aspsp-host}/open-banking/v4.0
Authentication
OAuth 2.0, OAuth 2.0
Contact
Service Desk
License
open-licence
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

UK Open Banking Scheduled Payments API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (TPPOAuth2Security) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (PSUOAuth2Security) using the authorizationCode flow, exposing 1 scope.

  • TPPOAuth2Security — TPP client credential authorisation flow with the ASPSP
  • PSUOAuth2Security — OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Scheduled Payments 2
GET
/accounts/{AccountId}/scheduled-payments
Get Scheduled Payments for an AccountId
GetAccountsAccountIdScheduledPayments 7 params → 200400401403404405406429
GET
/scheduled-payments
Get Scheduled Payments
GetScheduledPayments 6 params → 200400401403404405406429

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress7 (18 properties), OBScheduledPayment3 (9 properties), OBBranchAndFinancialInstitutionIdentification5_1 (5 properties), OBCashAccount5_1 (5 properties). Each schema is shown below with its type and property counts.

TownName
string
Name of a built-up area, with defined boundaries, and a local government.
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
OBActiveCurrencyAndAmount_SimpleType
string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Meta
object
Meta Data relevant to the payload
3 properties
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
LEI
string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Finan…
ActiveOrHistoricCurrencyCode_1
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international st…
Floor
string
Number that identifies the level within a building
PostBox
string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
Name_0
string
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 n…
ScheduledPaymentId
string
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
SecondaryIdentification
string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally ident…
UnitNumber
string
Number that identifies the unit of a specific address .
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
OBInternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to OBInternalFinancialInstitut…
CareOf
string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail f…
ExternalProxyAccountType1Code
string
Specifies the external proxy account type code, as published in the proxy account type external code set. For more information and a full list of values see Ex…
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties 2 required
OBBranchAndFinancialInstitutionIdentification5_1
object
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 t…
5 properties 2 required
OBReadScheduledPayment3
object
3 properties 1 required
OBInternalScheduleType1Code
string
Specifies the scheduled payment date type requested. For a full list of enumeration values refer to OBInternalScheduleType1Code in OBInternalCodeSet [here](htt…
OBScheduledPayment3
object
9 properties 4 required
StreetName
string
Name of a street or thoroughfare.
Links
object
Links relevant to the payload
5 properties 1 required
OBCashAccount5_1
object
Provides the details to identify the beneficiary account.
5 properties 2 required
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
ISODateTime
string
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:…
OBAddressType2Code
string
Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
ScheduledPaymentDateTime
string
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 resp…
Identification_1
string
Unique and unambiguous identification of the servicing institution.
DebtorReference
string
A reference value provided by the PSU to the PISP while setting up the scheduled payment.
Room
string
Information that locates and identifies a room to form part of an address
Reference
string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this…
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
BuildingName
string
Name of a referenced building.
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
OBActiveOrHistoricCurrencyAndAmount_1
object
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:…
2 properties 2 required
BuildingNumber
string
Number that identifies the position of a building on a street.
OBError1
object
4 properties 1 required
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
OBInternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to OBInternalAccountIdentifica…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

open-banking-uk-scheduled-payments-api-openapi.yml Raw ↑

Other APIs UK Open Banking publishes across the network.

UK Open Banking Open Data API
AE Profile APIs.io
UK Open Banking Dynamic Client Registration API
AE Profile APIs.io
UK Open Banking Directory API
AE Profile APIs.io
UK Open Banking Account Access Consents API
AE Profile APIs.io
UK Open Banking Accounts API
AE Profile APIs.io
UK Open Banking ATM API
AE Profile APIs.io
UK Open Banking Balances API
AE Profile APIs.io
UK Open Banking BCA API
AE Profile APIs.io
UK Open Banking Beneficiaries API
AE Profile APIs.io
UK Open Banking Branch API
AE Profile APIs.io
UK Open Banking CCC API
AE Profile APIs.io
UK Open Banking Direct Debits API
AE Profile APIs.io
#Scheduled Payments
← Back to U APIs
API Details
ID
open-banking-uk:open-banking-uk-scheduled-payments-api
Base URL
https://{aspsp-host}/open-banking/v4.0
Docs
https://openbankinguk.github.io/read-write-api-site3/v4.0.1/
Provider
UK Open Banking
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=open-banking-uk-scheduled-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/open-banking-uk-scheduled-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of UK Open Banking Scheduled Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.