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
ClearBank

ClearBank Payments API

The Payments API from ClearBank — 3 operation(s) for payments.

Documentation Provider Profile APIs.io OpenAPI GitHub

ClearBank Payments API is one of 15 APIs that ClearBank publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 1.0.Dec21.

Requests are made against the base URL https://institution-api.clearbank.co.uk.

3 operations 3 paths 12 schemas 2 DELETE1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.Dec21
Base URL
https://institution-api.clearbank.co.uk
Resource Areas
1

Paths & Operations 3

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

Payments 3
POST
/v1/mccy/payments
This endpoint is used to initiate payments.
3 params body → 202400404406409422500503
DELETE
/v1/mccy/payments/{batchId}
This endpoint is used to cancel an entire batch of payments with a matching batch ID. It must be sent at least one hour prior to the opening of the currency payment window in order to successfully ca…
3 params → 204400404406422500503
DELETE
/v1/mccy/payments/{batchId}/{endToEndId}
This endpoint is used to cancel a single payment within a batch, with a matching batch ID and end-to-end ID. It must be sent at least one hour prior to the opening of the currency payment window in o…
4 params → 204400404406422500503

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are PaymentRequestItem (16 properties), Creditor (9 properties), ProblemDetails (5 properties), UltimateCreditor (4 properties). Each schema is shown below with its type and property counts.

PaymentRequestItem
object
16 properties 8 required
Purpose
objectnull
Information about the purpose of the transaction.
2 properties
PaymentResponse
object
1 property
AccountIdentifier
object
The unique identifier for the account.
2 properties 2 required
RemittanceInformation
objectnull
Remittance information to accompany the payment.
1 property
PaymentRequest
object
3 properties 2 required
Creditor
object
Information about the creditor of the transaction.
9 properties 2 required
IntermediaryAgent
object
Information about the intermediary/correspondent bank.
1 property
AccountIdentifierKind
string
The kind of account identifier provided. This can either be IBAN or AccountId. This field is case insensitive.
UltimateCreditor
objectnull
Information about the ultimate creditor of the transaction. To be used where there is a “for further credit to” scenario.
4 properties 2 required
CreditorAgent
object
2 properties 1 required
ProblemDetails
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

clearbank-payments-api-openapi.yml Raw ↑

Other APIs ClearBank publishes across the network.

ClearBank Accounts API
AE Profile APIs.io
ClearBank Co P API
AE Profile APIs.io
ClearBank Create Fx Quote Endpoint API
AE Profile APIs.io
ClearBank Customer API
AE Profile APIs.io
ClearBank Customer Due Diligence API
AE Profile APIs.io
ClearBank External Cross Border Customer Payments V4 API
AE Profile APIs.io
ClearBank External Customer Payments V6 API
AE Profile APIs.io
ClearBank External Institution Payments V6 API
AE Profile APIs.io
ClearBank External Return Payments V6 API
AE Profile APIs.io
ClearBank Fps Payments API
AE Profile APIs.io
ClearBank Fx Orders API
AE Profile APIs.io
ClearBank Retail API
AE Profile APIs.io
#Payments
← Back to C APIs
API Details
ID
clearbank:clearbank-payments-api
Base URL
https://institution-api.clearbank.co.uk
Docs
https://clearbank.github.io/uk/docs/api/
Provider
ClearBank
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=clearbank-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/clearbank-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 ClearBank 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.