API Explorer

⯆

API Explorer

My Collections

Account Information Service (AIS)
- Consent status request
- Create consent
- Delete Consent
- Get Consent Authorisation Sub-Resources Request
- Get Consent Request
- Read Account Details
- Read Account List
- Read Balance
- Read Transaction Details
- Read card account balances
- Read the SCA status of the consent authorisation
- Read transaction list of a card account
- Read transaction list of an account
- Reads a list of card accounts
- Reads details about a card account
- Start the authorisation process for a consent(selectPsuAuthenticationMethod)
- Start the authorisation process for a consent(transactionAuthorisation)
- Start the authorisation process for a consent(updatePsuAuthentication)
- Update PSU Data for consents (authorisationConfirmation)
- Update PSU Data for consents (selectPsuAuthenticationMethod)
- Update PSU Data for consents (transactionAuthorisation)
- Update PSU Data for consents (updatePsuAuthentication)
Bank Accounts (Dynamic Endpoint)
- Get Bank Account By Id
- Post Accounts
Confirmation of Funds Service (PIIS)
- Confirmation of Funds Request
Dynamic Resource Doc
- A test endpoint
Payment Initiation Service (PIS)
- Get Cancellation Authorisation Sub-Resources Request
- Get Payment Information
- Get Payment Initiation Authorisation Sub-Resources Request
- Payment Cancellation Request
- Payment initiation request(bulk-payments)
- Payment initiation request(payments)
- Payment initiation request(periodic-payments)
- Payment initiation status request
- Read the SCA Status of the payment authorisation
- Read the SCA status of the payment cancellation's authorisation
- Start the authorisation process for a payment initiation (selectPsuAuthenticationMethod)
- Start the authorisation process for a payment initiation (transactionAuthorisation)
- Start the authorisation process for a payment initiation (updatePsuAuthentication)
- Start the authorisation process for the cancellation of the addressed payment (selectPsuAuthenticationMethod)
- Start the authorisation process for the cancellation of the addressed payment (transactionAuthorisation)
- Start the authorisation process for the cancellation of the addressed payment (updatePsuAuthentication)
- Update PSU Data for payment initiation cancellation (authorisationConfirmation)
- Update PSU Data for payment initiation cancellation (selectPsuAuthenticationMethod)
- Update PSU Data for payment initiation cancellation (transactionAuthorisation)
- Update PSU Data for payment initiation cancellation (updatePsuAuthentication)
- Update PSU data for payment initiation (authorisationConfirmation)
- Update PSU data for payment initiation (selectPsuAuthenticationMethod)
- Update PSU data for payment initiation (transactionAuthorisation)
- Update PSU data for payment initiation (updatePsuAuthentication)
Signing Baskets
- Create a signing basket resource
- Delete the signing basket
- Get Signing Basket Authorisation Sub-Resources Request
- Read the SCA status of the signing basket authorisation
- Read the status of the signing basket
- Returns the content of an signing basket object
- Start the authorisation process for a signing basket
- Update PSU Data for signing basket
_Covid APIDays
- Create new Covid APIDays
- Delete Covid APIDays by id
- Get Covid APIDays List
- Get Covid APIDays by id
- Update Covid APIDays
_Customer Cars
- Create new Customer Cars
- Delete Customer Cars by id
- Get Customer Cars List
- Get Customer Cars by id
- Update Customer Cars
_D Entity1(gh.29.uk)
- Create new D Entity1
- Delete D Entity1 by id
- Get D Entity1 List
- Get D Entity1 by id
- Update D Entity1
_Fish Port
- Create new Fish Port
- Delete Fish Port by id
- Get Fish Port List
- Get Fish Port by id
- Update Fish Port
_Foo Bar
- Create new Foo Bar
- Delete Foo Bar by id
- Get Foo Bar List
- Get Foo Bar by id
- Update Foo Bar
_Insurance Policy(gh.29.uk)
- Create new Insurance Policy
- Delete Insurance Policy by id
- Get Insurance Policy List
- Get Insurance Policy by id
- Update Insurance Policy
_Insurance Premium(gh.29.uk)
- Create new Insurance Premium
- Delete Insurance Premium by id
- Get Insurance Premium List
- Get Insurance Premium by id
- Update Insurance Premium
_March Hare(gh.29.uk)
- Create new March Hare
- Delete March Hare by id
- Get March Hare List
- Get March Hare by id
- Update March Hare
_Obp Activity(obp.testing.01)
- Create new Obp Activity
- Delete Obp Activity by id
- Get Obp Activity List
- Get Obp Activity by id
- Update Obp Activity
_Odometer(gh.29.uk)
- Create new Odometer
- Delete Odometer by id
- Get Odometer List
- Get Odometer by id
- Update Odometer
_Simon Covid
- Create new Simon Covid
- Delete Simon Covid by id
- Get Simon Covid List
- Get Simon Covid by id
- Update Simon Covid
_Sustrans
- Create new Sustrans
- Delete Sustrans by id
- Get Sustrans List
- Get Sustrans by id
- Update Sustrans
_Test Daniel707
- Create new My Test Daniel707
- Create new Test Daniel707
- Delete My Test Daniel707 by id
- Delete Test Daniel707 by id
- Get My Test Daniel707 List
- Get My Test Daniel707 by id
- Get Test Daniel707 List
- Get Test Daniel707 by id
- Update My Test Daniel707
- Update Test Daniel707
_Test1
- Create new Test1
- Delete Test1 by id
- Get Test1 List
- Get Test1 by id
- Update Test1

v1.3 (133 APIs)

API Host: https://apisandbox.openbankproject.com

Confirmation of Funds Request

Creates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point
of time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by
IBAN and TPP respectively. If the related extended services are used a conditional Consent-ID is contained
in the header. This field is contained but commented out in this specification.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									{
  "fundsAvailable":true
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Connector Methods:

Version: BGv1.3, function_name: by checkAvailabilityOfFunds, operation_id: BGv1.3-checkAvailabilityOfFunds Tags: Confirmation of Funds Service (PIIS), Berlin-Group-M,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

v1.3 (133 APIs)

Confirmation of Funds Request