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

ClearBank External Return Payments V6 API

The ExternalReturnPaymentsV6 API from ClearBank — 1 operation(s) for externalreturnpaymentsv6.

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

Tagged areas include ExternalReturnPaymentsV6. 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 9 schemas. It is described by OpenAPI 3.2.0, at version 6.0-CHAPS.

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

1 operations 1 paths 9 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
6.0-CHAPS
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.

ExternalReturnPaymentsV6 1
POST
/payments/chaps/v6/return-payments
Return a CHAPS payment. All CHAPS returns must be made by the next working day. The same operating hours apply for CHAPS returns as for regular CHAPS payments. Note that this endpoint only supports r…
ExternalReturnPayment-v6 3 params body → 202400404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ProblemDetails (6 properties), CreateReturnPaymentDtoV6 (4 properties), PaymentCreatedResponseDtoV6 (1 property). Each schema is shown below with its type and property counts.

CreateReturnPaymentDtoV6
object
4 properties 3 required
ApiHeadersSchema_AuthorizationType
string
Authorization header restricted to Bearer token only
ReturnReasonCodeV6
string
Specifies the reason for the return.
ClearBankSchema_PaymentId
string
ClearBank identifier that uniquely identifies the payment instruction. Supplied in response to the original payment instruction request.
ApiHeadersSchema_DigitalSignatureType
string
The digital signature generated by the API consumer
ApiHeadersSchema_CorrelationIdentifierType
string
A unique identifier generated by ClearBank®
PaymentCreatedResponseDtoV6
object
ClearBank identifier that uniquely identifies the new outbound/return payment instruction.
1 property 1 required
ApiHeadersSchema_RequestIdentifierType
string
The request identifier supplied by the API consumer
ProblemDetails
object
Properties of a given error
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

clearbank-externalreturnpaymentsv6-api-openapi.yml Raw ↑

Other APIs ClearBank publishes across the network.

ClearBank Accounts API
ClearBank Co P API
ClearBank Create Fx Quote Endpoint API
ClearBank Customer API
ClearBank Customer Due Diligence API
ClearBank External Cross Border Customer Payments V4 API
ClearBank External Customer Payments V6 API
ClearBank External Institution Payments V6 API
ClearBank Fps Payments API
ClearBank Fx Orders API
ClearBank Payments API
ClearBank Retail API
Where this information came from

This is an independent, third-party profile of ClearBank External Return Payments V6 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.