Cashplus Payment Initiation API
Open Banking Payment Initiation Service Provider (PISP) API conformant to the OBIE Read/Write API Standard, supporting domestic payments, domestic scheduled payments, and domestic standing orders with the customer approving each payment via PSD2 strong customer authentication over FAPI OAuth2/OIDC and mutual-TLS. The harvested OpenAPI is the shared OBIE standard the bank conforms to, not a bank-proprietary contract.
Cashplus Payment Initiation 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 Payment Initiation, PISP, 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 41 operations across 40 paths, organized into 8 resource areas, and defines 64 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/pisp.
41 operations
40 paths
64 schemas
26 GET15 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Cashplus Payment Initiation 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 ASPSPPSUOAuth2Security— 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 41
Across 40 paths, the API surfaces 41 operations — 26 GET, 15 POST. They span 8 resource areas: Domestic Payments, Payment Details, Domestic Scheduled Payments, Domestic Standing Orders, File Payments, International Payments, International Scheduled Payments, International Standing Orders. Each is listed below with its method, path, parameters, and response codes.
Domestic Payments 5
POST
/domestic-payment-consents
Create Domestic Payment Consents
GET
/domestic-payment-consents/{ConsentId}
Get Domestic Payment Consents
GET
/domestic-payment-consents/{ConsentId}/funds-confirmation
Get Domestic Payment Consents Funds Confirmation
POST
/domestic-payments
Create Domestic Payments
GET
/domestic-payments/{DomesticPaymentId}
Get Domestic Payments
Payment Details 7
GET
/domestic-payments/{DomesticPaymentId}/payment-details
Get Payment Details
GET
/domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details
Get Payment Details
GET
/domestic-standing-orders/{DomesticStandingOrderId}/payment-details
Get Payment Details
GET
/file-payments/{FilePaymentId}/payment-details
Get Payment Details
GET
/international-payments/{InternationalPaymentId}/payment-details
Get Payment Details
GET
/international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details
Get Payment Details
GET
/international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details
Get Payment Details
Domestic Scheduled Payments 4
POST
/domestic-scheduled-payment-consents
Create Domestic Scheduled Payment Consents
GET
/domestic-scheduled-payment-consents/{ConsentId}
Get Domestic Scheduled Payment Consents
POST
/domestic-scheduled-payments
Create Domestic Scheduled Payments
GET
/domestic-scheduled-payments/{DomesticScheduledPaymentId}
Get Domestic Scheduled Payments
Domestic Standing Orders 4
POST
/domestic-standing-order-consents
Create Domestic Standing Order Consents
GET
/domestic-standing-order-consents/{ConsentId}
Get Domestic Standing Order Consents
POST
/domestic-standing-orders
Create Domestic Standing Orders
GET
/domestic-standing-orders/{DomesticStandingOrderId}
Get Domestic Standing Orders
File Payments 7
POST
/file-payment-consents
Create File Payment Consents
GET
/file-payment-consents/{ConsentId}
Get File Payment Consents
POST
/file-payment-consents/{ConsentId}/file
Create File Payment Consents
GET
/file-payment-consents/{ConsentId}/file
Get File Payment Consents
POST
/file-payments
Create File Payments
GET
/file-payments/{FilePaymentId}
Get File Payments
GET
/file-payments/{FilePaymentId}/report-file
Get File Payments
International Payments 5
POST
/international-payment-consents
Create International Payment Consents
GET
/international-payment-consents/{ConsentId}
Get International Payment Consents
GET
/international-payment-consents/{ConsentId}/funds-confirmation
Get International Payment Consents Funds Confirmation
POST
/international-payments
Create International Payments
GET
/international-payments/{InternationalPaymentId}
Get International Payments
International Scheduled Payments 5
POST
/international-scheduled-payment-consents
Create International Scheduled Payment Consents
GET
/international-scheduled-payment-consents/{ConsentId}
Get International Scheduled Payment Consents
GET
/international-scheduled-payment-consents/{ConsentId}/funds-confirmation
Get International Scheduled Payment Consents Funds Confirmation
POST
/international-scheduled-payments
Create International Scheduled Payments
GET
/international-scheduled-payments/{InternationalScheduledPaymentId}
Get International Scheduled Payments
International Standing Orders 4
POST
/international-standing-order-consents
Create International Standing Order Consents
GET
/international-standing-order-consents/{ConsentId}
Get International Standing Order Consents
POST
/international-standing-orders
Create International Standing Orders
GET
/international-standing-orders/{InternationalStandingOrderPaymentId}
Get International Standing Orders
Schemas 64
The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress6 (10 properties), OBRisk1 (8 properties), Links (5 properties), OBCashAccountDebtor4 (4 properties). Each schema is shown below with its type and property counts.
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…
BuildingNumber
string
Number that identifies the position of a building on a street.
CountryCode
string
Nation with its own government.
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
Department
string
Identification of a division of a large organisation or building.
File
object
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:…
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Identification_1
string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Links
object
Links relevant to the payload
5 properties
1 required
Meta
object
Meta Data relevant to the payload
3 properties
Name
string
Name by which an agent is known and which is usually used to identify that agent.
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.
OBActiveOrHistoricCurrencyAndAmount
object
Amount of money associated with the charge type.
2 properties
2 required
OBAddressTypeCode
string
Identifies the nature of the postal address.
OBChargeBearerType1Code
string
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
OBCashAccountCreditor3
object
4 properties
3 required
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
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
3 required
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBExternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBExternalExtendedAccountType1Code
string
Specifies the extended type of account.
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…
OBExternalPaymentChargeType1Code
string
Charge type, in a coded form.
OBPostalAddress6
object
Information that locates and identifies a specific address, as defined by postal services.
10 properties
OBRisk1
object
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
8 properties
OBSCASupportData1
object
Supporting Data provided by TPP, when requesting SCA Exemption.
3 properties
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBWriteDomestic2
object
2 properties
2 required
OBWriteDomesticConsent4
object
2 properties
2 required
OBWriteDomesticConsentResponse5
object
4 properties
2 required
OBWriteDomesticResponse5
object
3 properties
1 required
OBWriteDomesticScheduled2
object
2 properties
2 required
OBWriteDomesticScheduledConsent4
object
2 properties
2 required
OBWriteDomesticScheduledConsentResponse5
object
4 properties
2 required
OBWriteDomesticScheduledResponse5
object
3 properties
1 required
OBWriteDomesticStandingOrder3
object
2 properties
2 required
OBWriteDomesticStandingOrderConsent5
object
2 properties
2 required
OBWriteDomesticStandingOrderConsentResponse6
object
4 properties
2 required
OBWriteDomesticStandingOrderResponse6
object
3 properties
1 required
OBWriteFile2
object
1 property
1 required
OBWriteFileConsent3
object
1 property
1 required
OBWriteFileConsentResponse4
object
3 properties
1 required
OBWriteFileResponse3
object
3 properties
1 required
OBWriteFundsConfirmationResponse1
object
3 properties
1 required
OBWriteInternational3
object
2 properties
2 required
OBWriteInternationalConsent5
object
2 properties
2 required
OBWriteInternationalConsentResponse6
object
4 properties
2 required
OBWriteInternationalResponse5
object
3 properties
1 required
OBWriteInternationalScheduled3
object
2 properties
2 required
OBWriteInternationalScheduledConsent5
object
2 properties
2 required
OBWriteInternationalScheduledConsentResponse6
object
4 properties
2 required
OBWriteInternationalScheduledResponse6
object
3 properties
1 required
OBWriteInternationalStandingOrder4
object
2 properties
2 required
OBWriteInternationalStandingOrderConsent6
object
2 properties
2 required
OBWriteInternationalStandingOrderConsentResponse7
object
4 properties
2 required
OBWriteInternationalStandingOrderResponse7
object
3 properties
1 required
OBWritePaymentDetailsResponse1
object
3 properties
1 required
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
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…
StreetName
string
Name of a street or thoroughfare.
SubDepartment
string
Identification of a sub-division of a large organisation or building.
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cashplus Bank 9
Other APIs Cashplus Bank publishes across the network.
Cashplus Account Information API
Cashplus Confirmation of Funds API
Cashplus Identity API
Cashplus Accounts API
Cashplus Applications API
Cashplus Eligibility API
Cashplus Payments API
Cashplus Products API
Cashplus Transactions API
#Payment Initiation#PISP#Open Banking#PSD2#OBIE