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 External Cross Border Customer Payments V4 API

The ExternalCrossBorderCustomerPaymentsV4 API from ClearBank — 1 operation(s) for externalcrossbordercustomerpaymentsv4.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 1 operation across 1 path, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 4.0GBPCrossBorder.

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

1 operations 1 paths 20 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

ExternalCrossBorderCustomerPaymentsV4 1
POST
/payments/cross-border-sterling/v4/payments
This endpoint will send a cross-border customer payment in sterling (pacs.008).
ExternalCrossBorderCreateCustomerPayment-v7 3 params body → 202400404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are CreateCrossBorderCustomerPaymentDtoV7 (13 properties), PartyAddressDetailsDtoV5 (6 properties), PartyAddressDetailsDtoV4 (6 properties), IntermediaryAgentDetailsV4 (4 properties). Each schema is shown below with its type and property counts.

IntermediaryAgentDetailsV4
object
Information about the first account a payment has to go through before the payment is sent to the (ultimate) creditor.
4 properties 3 required
PartyAddressDetailsDtoV5
object
6 properties 3 required
CreateCrossBorderCustomerPaymentDtoV7
object
13 properties 11 required
CustomerPartyDetailsDtoV5
object
4 properties 2 required
CategoryPurposeCodeV5
string
Broader nature of the payment, as published in an external Category Purpose Code list.
PrivateIdentifierV5
object
Optional information to be provided when the payment recipient is an individual. If you use this object, do not use the OrganisationIdentifier object.
1 property
CrossBorderCreditorIdentificationIbanDtoV4
object
1 property 1 required
PurposeCodeV5
string
Underlying reason for the payment transaction, as published in an external purpose code list.
StructuredRemittanceInformationDtoV4
object
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' rec…
1 property
ApiHeadersSchema_DigitalSignatureType
string
The digital signature generated by the API consumer
CrossBorderCreditorAgentV6
object
Information that identifies the creditor agent as a financial institution.
1 property 1 required
AccountIdentificationOtherDtoV6
object
2 properties 2 required
AccountIdentificationIbanDtoV6
object
1 property 1 required
ApiHeadersSchema_AuthorizationType
string
Authorization header restricted to Bearer token only
PartyAddressDetailsDtoV4
object
6 properties 3 required
OrganisationIdentifierV5
object
Optional information to be provided when the payment recipient is a business or financial institution. If you use this object, do not use the privateIdentifier…
3 properties
InterBankSettlementAmountDtoV6
object
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
2 properties 2 required
CrossBorderCreditorIdentificationOtherDtoV4
object
2 properties 2 required
ApiHeadersSchema_CorrelationIdentifierType
string
A unique identifier generated by ClearBank®
ApiHeadersSchema_RequestIdentifierType
string
The request identifier supplied by the API consumer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

clearbank-externalcrossbordercustomerpaymentsv4-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 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 Payments API
AE Profile APIs.io
ClearBank Retail API
AE Profile APIs.io
#ExternalCrossBorderCustomerPaymentsV4
← Back to C APIs
API Details
ID
clearbank:clearbank-externalcrossbordercustomerpaymentsv4-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-externalcrossbordercustomerpaymentsv4-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/clearbank-externalcrossbordercustomerpaymentsv4-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 External Cross Border Customer Payments V4 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.