Skip to main content

Check availability of funds - Hello bank!

v1.1.0 based on STET v1.4.1.3
Provided by:
Elodie JOSEPH
Status:
Live
Category:
PSD2
Last update:
2023-11-17

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
    • At this step, the ASPSP has delivered an OAUTH2 "Authorization Code" or "Resource Owner Password" access token to the TPP (cf. ยง 3.4.2).
    • Each ASPSP has to implement either the "Authorization Code"/"Resource Owner Password" or the "Client Credential" OAUTH2 access token model.
    • Doing this, it will edit the [security] section on this path in order to specify which model it has chosen
  • 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. This API is based on STET API version 1.4.1.3.

Swagger versions

Version Description
1.1.0 From 22-SEP-2020
- Live : CBPII - Initial Version
1.0.0 From 11-MAY-2020
- Sandbox Only : CBPII - Initial Version


Details of implementation

Details of implementation
/funds-confirmations Sandox and Live


To access PSD2 BNP PARIBAS French Retail Banking API, scope Hello Bank!, please use one of the following links :

URL
PSD2 Sandbox (test data) https://api.sandbox.bddf.bnpparibas/psd2-sandbox/hellobank/V1.4
PSD2 Production (live data) https://api-psd2.bddf.bnpparibas/psd2/hellobank/V1.4

How to use sandbox API ?

  <table border="2">
    <thead>
      <tr>
        <td></td>
        <td style="text-align:center">Details of implementation</td>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td style="text-align:center">CBPII sandbox data</td>
        <td style="padding: 10px">The data are fictive. <br/> Only EUR currency</td>
      </tr>
      <tr>
        <td style="text-align:center">CBPII sandbox dataset</td>
        <td style="padding: 10px">
        <table border="1">
          <thead>
            <tr>
              <td style="text-align:center">IBAN</td>
              <td style="text-align:center">Balance</td>
              <td style="text-align:center">Details</td>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td style="text-align:center">FR7630004345670001555123412</td>
              <td style="padding: 10px">200 EUR</td>
              <td style="padding: 10px">Passing case</td>
            </tr>
            <tr>
              <td style="text-align:center">FR7630004789100008541345657</td>
              <td style="padding: 10px">-</td>
              <td style="padding: 10px">No client authorisation for TPP (non-passing-case).</td>
            </tr>
            <tr>
              <td style="text-align:center">FR76xxxxxxxxxxxxxxxxxxxxxxx <br/> (x : fictive value)</td>
              <td style="padding: 10px">-</td>
              <td style="padding: 10px">No available account (non-passing-case).</td>
            </tr>
            <tr>
              <td style="text-align:center">Other</td>
              <td style="padding: 10px">-</td>
              <td style="padding: 10px">Invalid iban (non-passing-case).</td>
            </tr>
          </tbody>
        </table>
        </td>
      </tr>
    </tbody>
  </table>

The API is designed on a REST model using JSON structures.