v1.4 (12 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Payment coverage check request (CBPII)

NOTE: This endpoint currently only returns example data.

        ### Description

The CBPII can ask an ASPSP to check if a given amount can be covered by the liquidity that is available on a PSU cash account or payment card.

Prerequisites

  • The TPP has been registered by the Registration Authority for the CBPII role
  • The TPP and the PSU have a contract that has been registered by the ASPSP
  • The TPP and the ASPSP have successfully processed a mutual check and authentication
  • The TPP has presented its OAUTH2 "Authorization Code", "Resource Owner Password" or "Client Credential" access token which allows the ASPSP to identify the relevant PSU.

Business flow

The CBPII requests the ASPSP for a payment coverage check against either a bank account or a card primary identifier. The ASPSP answers with a structure embedding the original request and the result as a Boolean.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
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: STETv1.4, function_name: by fundsConfirmationsPost, operation_id: STETv1.4-fundsConfirmationsPost Tags: CBPII, Mocked-Data,