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

Paragon Bank Confirmation of Funds API (OBIE standard, unverified)

The OBIE Read/Write Confirmation of Funds (CBPII) API standard - FAPI-secured yes/no confirmation of available funds for a card-based payment instrument issuer. Captured here as the shared OBIE standard specification, not a Paragon-hosted contract; no Paragon CBPII endpoint was confirmed at profiling time.

Paragon Bank Confirmation of Funds API (OBIE standard, unverified) is one of 4 APIs that Paragon Bank publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Confirmation of Funds, CBPII, and FAPI. 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, organized into 2 resource areas, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 4.0.1.

Requests are made against a single base URL, /open-banking/v4.0/cbpii.

4 operations 3 paths 15 schemas 1 DELETE1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.1
Server
/open-banking/v4.0/cbpii
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
2

Authentication & Security 2

Paragon Bank Confirmation of Funds API (OBIE standard, unverified) 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. They span 2 resource areas: Funds Confirmation Consents, Funds Confirmations. Each is listed below with its method, path, parameters, and response codes.

Funds Confirmation Consents 3
POST
/funds-confirmation-consents
Create a Funds Confirmation Consent
CreateFundsConfirmationConsents 6 params body → 201400401403405406415429
GET
/funds-confirmation-consents/{ConsentId}
Get a Funds Confirmation Consent
GetFundsConfirmationConsentsConsentId 7 params → 200400401403405406429500
DELETE
/funds-confirmation-consents/{ConsentId}
Delete a Funds Confirmation Consent
DeleteFundsConfirmationConsentsConsentId 7 params → 204400401403405406429500
Funds Confirmations 1
POST
/funds-confirmations
Create a Funds Confirmation Request
CreateFundsConfirmations 6 params body → 201400401403405406415429

Schemas 15

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

Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties 2 required
ExternalProxyAccountType1Code
string
Specifies the external proxy account type code, as published in the proxy account type external code set. For a full list of values refer to ExternalProxyAccou…
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 1 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
OBFundsConfirmation1
object
1 property 1 required
OBFundsConfirmationConsent1
object
1 property 1 required
OBFundsConfirmationConsentResponse1
object
3 properties 1 required
OBInternalConsentStatus1Code
string
Specifies the status of consent resource in code form. For a full list of values refer to OBInternalConsentStatus1Code in OBInternalCodeSet [here](https://gith…
OBFundsConfirmationResponse1
object
3 properties 1 required
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
OBStatusReason
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

obie-confirmation-funds-standard.yaml Raw ↑

Other APIs Paragon Bank publishes across the network.

Paragon Bank Open Data API (OBIE standard, unverified)
Paragon Bank Account and Transaction Information API (OBIE standard, unverified)
Paragon Bank Payment Initiation API (OBIE standard, unverified)
Where this information came from

This is an independent, third-party profile of Paragon Bank Confirmation of Funds API (OBIE standard, unverified), 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.