GRgroupebpce
CBPII

Payment coverage check request (CBPII)

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 was registered by the Registration Authority for the CBPII role
  • The TPP and the PSU have a contract that was registered by the ASPSP
    • At this step, the ASPSP has delivered an "Authorization Code", a "Resource Owner Password" or a "Client Credential" OAUTH2 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. This request cannot handle exchange rate and must be specified with the relevant account currency. The ASPSP answers with a structure embedding the original request and the result as a Boolean.

post/funds-confirmations

Request

  • Base URL
    https://www.30007.live.api.natixis.com/stet/psd2/v1.6.2
  • Auth
    • OAuth 2
      Authorization code: https://oauth2.aspsp/authorization
      Token URL: https://oauth2.aspsp/token scopes: cbpii
    • or OAuth 2
      Client credentials
      Token URL: https://oauth2.aspsp/token scopes: cbpii

Headers

Authorizationstring required

Access token to be passed as a header

PSU-IP-Addressstring

IP address used by the PSU's terminal when connecting to the TPP

PSU-IP-Portstring

IP port used by the PSU's terminal when connecting to the TPP

PSU-HTTP-Methodstring

Http method for the most relevant PSU’s terminal request to the TTP

PSU-Datestring

Timestamp of the most relevant PSU’s terminal request to the TTP

PSU-GEO-Locationstring

Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP

PSU-User-Agentstring

"User-Agent" header field sent by the PSU terminal when connecting to the TPP

PSU-Refererstring

"Referer" header field sent by the PSU terminal when connecting to the TPP. Notice that an initial typo in RFC 1945 specifies that "referer" (incorrect spelling) is to be used. The correct spelling "referrer" can be used but might not be understood.

PSU-Acceptstring

"Accept" header field sent by the PSU terminal when connecting to the TPP

PSU-Accept-Charsetstring

"Accept-Charset" header field sent by the PSU terminal when connecting to the TPP

PSU-Accept-Encodingstring

"Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP

PSU-Accept-Languagestring

"Accept-Language" header field sent by the PSU terminal when connecting to the TPP

PSU-Device-IDstring

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of installation identification this ID need to be unaltered until removal from device.

Digeststring

Digest of the body

Signaturestring required

http-signature of the request The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate.

X-Request-IDstring required

Correlation header to be set in a request and retrieved in the relevant response

Request body

paymentCoverageRequestIdstring required

Identification of the payment Coverage Request

payeestring

The merchant where the card is accepted as information to the PSU.

Response

payment coverage request

resultboolean required

Result of the coverage check :

  • true: the payment can be covered
  • false: the payment cannot be covered

Changes

No recorded changes to this operation across all 1 revision of this API.