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 Fps Payments API

The FpsPayments API from ClearBank — 2 operation(s) for fpspayments.

ClearBank Fps 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 FpsPayments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 3.0.FPS-payment.

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

2 operations 2 paths 23 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 2

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

FpsPayments 2
POST
/v3/payments/fps
Initiate a payment using the faster payments scheme. This endpoint is FTR compliant.
Post 3 params body → 202400404422
POST
/v3/payments/fps/return
Return an inbound Faster Payment. This endpoint can be used to return Faster Payments - including Faster Payments Originating Overseas - that cleared less than 90 days ago.
PostReturn 3 params body → 202400403404422

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are BatchCreditTransfer (6 properties), ValidationProblemDetails (6 properties), BatchPaymentInstruction (5 properties), BatchCounterpartAccountGenericIdentification (3 properties). Each schema is shown below with its type and property counts.

CounterpartAccountGenericIdentificationScheme
object
Information about the identification scheme in coded form or free-form text.
2 properties
PaymentInstructionResponse
object
The acceptance or rejection status of a payment instruction.
2 properties 2 required
BatchCreateCreditTransferRequest
object
Information that should be used to create a batch credit transfer.
1 property 1 required
BatchStructured
object
Information supplied by the remitter (in a structured form), to reconcile an entry with item(s) that the payment intends to settle (for example, a purchase ref…
1 property
HalLink
object
Hypermedia link.
3 properties 2 required
BatchRemittanceInformation
object
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an…
2 properties
ValidationProblemDetails
object
A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807
6 properties
BatchCreditorPartyIdentifier
object
The name and, optionally, the legal entity identifier of the account.
2 properties 1 required
BatchPaymentInstructionCounterpartAccount
object
Information about the counterpart in a given transaction.
1 property 1 required
BatchCreditTransferResponse
object
The result of each payment instruction and applicable links
2 properties
BatchCreditorReferenceInformation
object
Reference information provided by the ultimate debtor to allow the identification of underlying documents by the creditor.
1 property
CreateReturnCreditTransferRequest
object
Information that should be used to create a single credit return.
1 property 1 required
PaymentReturnInstruction
object
Information about the single payment return instruction.
2 properties 2 required
BatchCreditTransfer
object
Represents a creditor in a payment instruction.
6 properties 5 required
OtherProblemDetails
object
1 property
BatchAmount
object
Indicates the amount and the currency used in a given transaction or account balance.
2 properties 1 required
BatchDebtorPartyIdentifier
object
Optionally, the Legal Entity Identifier of the account. Mandatory the Address of the account.
2 properties 1 required
BatchCounterpartAccountGenericIdentification
object
Unique identification of an account, as assigned by the account servicer, using an identification scheme.
3 properties 2 required
BatchUnstructured
object
Information supplied by the remitter (in a structured form), to reconcile an entry with item(s) that the payment intends to settle (for example, a purchase ref…
1 property
BatchAdditionalReferenceInformation
object
Reference information provided by the ultimate debtor to allow the identification of underlying documents by the creditor.
1 property
BatchPaymentIdentification
object
Identification of the payment instruction.
2 properties 2 required
BatchPaymentInstructionCounterpartAccountIdentification
object
The identifiable information of an account.
2 properties
BatchPaymentInstruction
object
A payment from a single account to multiple creditors.
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

clearbank-fpspayments-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 External Return Payments V6 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 Fps 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.