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

Cashplus Bank File Payments API

The File Payments API from Cashplus Bank — 6 operation(s) for file payments.

Cashplus Bank File Payments API is one of 28 APIs that Cashplus Bank publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 6 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 3.1.11.

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

7 operations 6 paths 22 schemas 4 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Cashplus Bank File Payments 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 7

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

File Payments 7
POST
/file-payment-consents
Create File Payment Consents
CreateFilePaymentConsents 7 params body → 201400401403404405406415
GET
/file-payment-consents/{ConsentId}
Get File Payment Consents
GetFilePaymentConsentsConsentId 6 params → 200400401403404405406429
POST
/file-payment-consents/{ConsentId}/file
Create File Payment Consents
CreateFilePaymentConsentsConsentIdFile 8 params body → 200400401403404405406415
GET
/file-payment-consents/{ConsentId}/file
Get File Payment Consents
GetFilePaymentConsentsConsentIdFile 6 params → 200400401403404405406429
POST
/file-payments
Create File Payments
CreateFilePayments 7 params body → 201400401403404405406415
GET
/file-payments/{FilePaymentId}
Get File Payments
GetFilePaymentsFilePaymentId 6 params → 200400401403404405406429
GET
/file-payments/{FilePaymentId}/report-file
Get File Payments
GetFilePaymentsFilePaymentIdReportFile 6 params → 200400401403404405406429

Schemas 22

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

OBActiveCurrencyAndAmount_SimpleType
string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
OBExternalLocalInstrument1Code
string
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or serv…
OBActiveOrHistoricCurrencyAndAmount
object
Amount of money associated with the charge type.
2 properties 2 required
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
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:…
OBCashAccountDebtor4
object
^ Only incuded in the response if Data. ReadRefundAccount is set to Yes in the consent.
4 properties
OBError1
object
4 properties 2 required
OBWriteFileConsentResponse4
object
3 properties 1 required
Meta
object
Meta Data relevant to the payload
3 properties
File
object
SecondaryIdentification
string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally ident…
Links
object
Links relevant to the payload
5 properties 1 required
OBWriteFileResponse3
object
3 properties 1 required
ActiveOrHistoricCurrencyCode
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international st…
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBExternalPaymentChargeType1Code
string
Charge type, in a coded form.
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 3 required
OBChargeBearerType1Code
string
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
OBWriteFile2
object
1 property 1 required
OBSCASupportData1
object
Supporting Data provided by TPP, when requesting SCA Exemption.
3 properties
OBWriteFileConsent3
object
1 property 1 required
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cashplus-file-payments-api-openapi.yml Raw ↑

Other APIs Cashplus Bank publishes across the network.

Cashplus Identity API
Cashplus Accounts API
Cashplus Applications API
Cashplus Eligibility API
Cashplus Payments API
Cashplus Products API
Cashplus Transactions API
Cashplus Bank Account Access API
Cashplus Bank Accounts API
Cashplus Bank Balances API
Cashplus Bank Beneficiaries API
Cashplus Bank Direct Debits API
Where this information came from

This is an independent, third-party profile of Cashplus Bank File 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.