Cashplus Bank International Payments API
The International Payments API from Cashplus Bank — 5 operation(s) for international payments.
The International Payments API from Cashplus Bank — 5 operation(s) for international payments.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/cashplus-international-payments-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Payment Initiation International Payments API
description: Swagger for Payment Initiation API Specification
termsOfService: https://www.openbanking.org.uk/terms
contact:
name: Service Desk
email: ServiceDesk@openbanking.org.uk
license:
name: open-licence
url: https://www.openbanking.org.uk/open-licence
version: 3.1.11
servers:
- url: /open-banking/v3.1/pisp
tags:
- name: International Payments
paths:
/international-payment-consents:
post:
tags:
- International Payments
summary: Create International Payment Consents
operationId: CreateInternationalPaymentConsents
parameters:
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-idempotency-key'
- $ref: '#/components/parameters/x-jws-signature'
- $ref: '#/components/parameters/x-customer-user-agent'
requestBody:
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBWriteInternationalConsent5'
application/json:
schema:
$ref: '#/components/schemas/OBWriteInternationalConsent5'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBWriteInternationalConsent5'
description: Default
required: true
responses:
201:
$ref: '#/components/responses/201InternationalPaymentConsentsCreated'
400:
$ref: '#/components/responses/400Error'
401:
$ref: '#/components/responses/401Error'
403:
$ref: '#/components/responses/403Error'
404:
$ref: '#/components/responses/404Error'
405:
$ref: '#/components/responses/405Error'
406:
$ref: '#/components/responses/406Error'
415:
$ref: '#/components/responses/415Error'
429:
$ref: '#/components/responses/429Error'
500:
$ref: '#/components/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/international-payment-consents/{ConsentId}:
get:
tags:
- International Payments
summary: Get International Payment Consents
operationId: GetInternationalPaymentConsentsConsentId
parameters:
- $ref: '#/components/parameters/ConsentId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
responses:
200:
$ref: '#/components/responses/200InternationalPaymentConsentsConsentIdRead'
400:
$ref: '#/components/responses/400Error'
401:
$ref: '#/components/responses/401Error'
403:
$ref: '#/components/responses/403Error'
404:
$ref: '#/components/responses/404Error'
405:
$ref: '#/components/responses/405Error'
406:
$ref: '#/components/responses/406Error'
429:
$ref: '#/components/responses/429Error'
500:
$ref: '#/components/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/international-payment-consents/{ConsentId}/funds-confirmation:
get:
tags:
- International Payments
summary: Get International Payment Consents Funds Confirmation
operationId: GetInternationalPaymentConsentsConsentIdFundsConfirmation
parameters:
- $ref: '#/components/parameters/ConsentId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
responses:
200:
$ref: '#/components/responses/200InternationalPaymentConsentsConsentIdFundsConfirmationRead'
400:
$ref: '#/components/responses/400Error'
401:
$ref: '#/components/responses/401Error'
403:
$ref: '#/components/responses/403Error'
404:
$ref: '#/components/responses/404Error'
405:
$ref: '#/components/responses/405Error'
406:
$ref: '#/components/responses/406Error'
429:
$ref: '#/components/responses/429Error'
500:
$ref: '#/components/responses/500Error'
security:
- PSUOAuth2Security:
- payments
/international-payments:
post:
tags:
- International Payments
summary: Create International Payments
operationId: CreateInternationalPayments
parameters:
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-idempotency-key'
- $ref: '#/components/parameters/x-jws-signature'
- $ref: '#/components/parameters/x-customer-user-agent'
requestBody:
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBWriteInternational3'
application/json:
schema:
$ref: '#/components/schemas/OBWriteInternational3'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBWriteInternational3'
description: Default
required: true
responses:
201:
$ref: '#/components/responses/201InternationalPaymentsCreated'
400:
$ref: '#/components/responses/400Error'
401:
$ref: '#/components/responses/401Error'
403:
$ref: '#/components/responses/403Error'
404:
$ref: '#/components/responses/404Error'
405:
$ref: '#/components/responses/405Error'
406:
$ref: '#/components/responses/406Error'
415:
$ref: '#/components/responses/415Error'
429:
$ref: '#/components/responses/429Error'
500:
$ref: '#/components/responses/500Error'
security:
- PSUOAuth2Security:
- payments
/international-payments/{InternationalPaymentId}:
get:
tags:
- International Payments
summary: Get International Payments
operationId: GetInternationalPaymentsInternationalPaymentId
parameters:
- $ref: '#/components/parameters/InternationalPaymentId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
responses:
200:
$ref: '#/components/responses/200InternationalPaymentsInternationalPaymentIdRead'
400:
$ref: '#/components/responses/400Error'
401:
$ref: '#/components/responses/401Error'
403:
$ref: '#/components/responses/403Error'
404:
$ref: '#/components/responses/404Error'
405:
$ref: '#/components/responses/405Error'
406:
$ref: '#/components/responses/406Error'
429:
$ref: '#/components/responses/429Error'
500:
$ref: '#/components/responses/500Error'
security:
- TPPOAuth2Security:
- payments
components:
responses:
415Error:
description: Unsupported Media Type
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
404Error:
description: Not found
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
400Error:
description: Bad request
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
429Error:
description: Too Many Requests
headers:
Retry-After:
description: Number in seconds to wait
schema:
type: integer
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
403Error:
description: Forbidden
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
401Error:
description: Unauthorized
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
201InternationalPaymentsCreated:
description: International Payments Created
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBWriteInternationalResponse5'
application/json:
schema:
$ref: '#/components/schemas/OBWriteInternationalResponse5'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBWriteInternationalResponse5'
200InternationalPaymentConsentsConsentIdRead:
description: International Payment Consents Read
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBWriteInternationalConsentResponse6'
application/json:
schema:
$ref: '#/components/schemas/OBWriteInternationalConsentResponse6'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBWriteInternationalConsentResponse6'
405Error:
description: Method Not Allowed
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
406Error:
description: Not Acceptable
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
200InternationalPaymentConsentsConsentIdFundsConfirmationRead:
description: International Payment Consents Read
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
application/json:
schema:
$ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
200InternationalPaymentsInternationalPaymentIdRead:
description: International Payments Read
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBWriteInternationalResponse5'
application/json:
schema:
$ref: '#/components/schemas/OBWriteInternationalResponse5'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBWriteInternationalResponse5'
500Error:
description: Internal Server Error
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
201InternationalPaymentConsentsCreated:
description: International Payment Consents Created
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBWriteInternationalConsentResponse6'
application/json:
schema:
$ref: '#/components/schemas/OBWriteInternationalConsentResponse6'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBWriteInternationalConsentResponse6'
schemas:
CountrySubDivision:
description: Identifies a subdivision of a country such as state, region, county.
type: string
minLength: 1
maxLength: 35
OBActiveCurrencyAndAmount_SimpleType:
description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
type: string
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
OBPostalAddress6:
type: object
additionalProperties: false
description: Information that locates and identifies a specific address, as defined by postal services.
properties:
AddressType:
$ref: '#/components/schemas/OBAddressTypeCode'
Department:
$ref: '#/components/schemas/Department'
SubDepartment:
$ref: '#/components/schemas/SubDepartment'
StreetName:
$ref: '#/components/schemas/StreetName'
BuildingNumber:
$ref: '#/components/schemas/BuildingNumber'
PostCode:
$ref: '#/components/schemas/PostCode'
TownName:
$ref: '#/components/schemas/TownName'
CountrySubDivision:
$ref: '#/components/schemas/CountrySubDivision'
Country:
$ref: '#/components/schemas/CountryCode'
AddressLine:
type: array
items:
description: Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
type: string
minLength: 1
maxLength: 70
minItems: 0
maxItems: 7
OBExternalLocalInstrument1Code:
description: 'User community specific instrument.
Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.'
type: string
x-namespaced-enum:
- UK.OBIE.BACS
- UK.OBIE.BalanceTransfer
- UK.OBIE.CHAPS
- UK.OBIE.Euro1
- UK.OBIE.FPS
- UK.OBIE.Link
- UK.OBIE.MoneyTransfer
- UK.OBIE.Paym
- UK.OBIE.SEPACreditTransfer
- UK.OBIE.SEPAInstantCreditTransfer
- UK.OBIE.SWIFT
- UK.OBIE.Target2
OBWriteInternationalResponse5:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
required:
- InternationalPaymentId
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Initiation
properties:
InternationalPaymentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the international payment resource.'
type: string
minLength: 1
maxLength: 40
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of the payment information group.
type: string
enum:
- AcceptedCreditSettlementCompleted
- AcceptedSettlementCompleted
- AcceptedSettlementInProcess
- AcceptedWithoutPosting
- Pending
- Rejected
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedExecutionDateTime:
description: "Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedSettlementDateTime:
description: "Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Refund:
type: object
additionalProperties: false
required:
- Account
properties:
Creditor:
type: object
additionalProperties: false
description: Set of elements used to identify a person or an organisation.
properties:
Name:
description: Name by which a party is known and which is usually used to identify that party.
type: string
minLength: 1
maxLength: 140
PostalAddress:
$ref: '#/components/schemas/OBPostalAddress6'
Agent:
type: object
additionalProperties: false
description: Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
properties:
SchemeName:
$ref: '#/components/schemas/OBExternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/components/schemas/Identification_1'
Name:
$ref: '#/components/schemas/Name'
PostalAddress:
$ref: '#/components/schemas/OBPostalAddress6'
Account:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Provides the details to identify an account.
properties:
SchemeName:
$ref: '#/components/schemas/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/components/schemas/Identification_0'
Name:
description: 'Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.'
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/components/schemas/SecondaryIdentification'
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/components/schemas/OBChargeBearerType1Code'
Type:
$ref: '#/components/schemas/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- ExchangeRate
- RateType
description: Further detailed information on the exchange rate that has been used in the payment transaction.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
type: number
RateType:
description: Specifies the type used to complete the currency exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
type: string
minLength: 1
maxLength: 256
ExpirationDateTime:
description: "Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- EndToEndIdentification
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
properties:
InstructionIdentification:
description: 'Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.'
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: 'Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction.
OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.'
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/components/schemas/OBExternalLocalInstrument1Code'
InstructionPriority:
description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
type: string
enum:
- Normal
- Urgent
Purpose:
description: 'Specifies the external purpose code in the format of character string with a maximum length of 4 characters.
The list of valid codes is an external code list published separately.
External code sets can be downloaded from www.iso20022.org.'
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/components/schemas/OBChargeBearerType1Code'
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: 'Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Usage: This amount has to be transported unchanged through the transaction chain.'
properties:
Amount:
$ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- RateType
description: Provides details on the currency exchange rate and contract.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
type: number
RateType:
description: Specifies the type used to complete the currency exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
type: string
minLength: 1
maxLength: 256
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/components/schemas/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/components/sch
# --- truncated at 32 KB (98 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cashplus/refs/heads/main/openapi/cashplus-international-payments-api-openapi.yml