Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cashplus Confirmation of Funds API

Open Banking Card Based Payment Instrument Issuer (CBPII) Confirmation of Funds API conformant to the OBIE Read/Write API Standard, letting authorised providers establish a funds-confirmation consent and check whether sufficient funds are available on a customer account, secured with FAPI OAuth2/OIDC, PSD2 SCA, and mutual-TLS. The harvested OpenAPI is the shared OBIE standard the bank conforms to, not a bank-proprietary contract.

Cashplus Confirmation of Funds API is one of 10 APIs that Cashplus Bank publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Confirmation of Funds, CBPII, Open Banking, PSD2, and OBIE. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 3.1.11.

Requests are made against a single base URL, /open-banking/v3.1/cbpii.

4 operations 3 paths 9 schemas 1 DELETE1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.1.11
Server
/open-banking/v3.1/cbpii
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Cashplus Confirmation of Funds 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 4

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

Funds Confirmations 4
POST
/funds-confirmation-consents
Create Funds Confirmation Consent
CreateFundsConfirmationConsents 5 params body → 201400401403405406415429
GET
/funds-confirmation-consents/{ConsentId}
Get Funds Confirmation Consent
GetFundsConfirmationConsentsConsentId 6 params → 200400401403405406429500
DELETE
/funds-confirmation-consents/{ConsentId}
Delete Funds Confirmation Consent
DeleteFundsConfirmationConsentsConsentId 6 params → 204400401403405406429500
POST
/funds-confirmations
Create Funds Confirmation
CreateFundsConfirmations 5 params body → 201400401403405406415429

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Links (5 properties), OBErrorResponse1 (4 properties), OBError1 (4 properties), OBFundsConfirmationConsentResponse1 (3 properties). Each schema is shown below with its type and property counts.

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:…
Links
object
Links relevant to the payload
5 properties 1 required
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties 2 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 3 required
OBFundsConfirmation1
object
1 property 1 required
OBFundsConfirmationConsent1
object
1 property 1 required
OBFundsConfirmationConsentResponse1
object
3 properties 1 required
OBFundsConfirmationResponse1
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cashplus-confirmation-of-funds-openapi.yml Raw ↑

Other APIs Cashplus Bank publishes across the network.

Cashplus Account Information API
Cashplus Payment Initiation API
Cashplus Identity API
Cashplus Accounts API
Cashplus Applications API
Cashplus Eligibility API
Cashplus Payments API
Cashplus Products API
Cashplus Transactions API