Ria Money Transfer

openFinance API Framework XS2A API as PSD2 Interface Implementation Guidelines - Confirmation of Funds Service (2.3)

The Berlin Group - A European Standards Initiative | info@: info@berlin-group.org | URL: https://www.berlin-group.org/

License: Creative Commons Attribution 4.0 International Public License

The component for Confirmation of Funds Service (PIIS) offers the following information service: * Information whether an amount necessary for the execution of a card-based payment transaction is available on the payment account of the payer

Confirm funds availability

POST /v2/funds-confirmations

Creates a confirmation of funds request at the ASPSP. See "XS2A API as PSD2 Interface Implementation Guidelines ", section "Confirmation of Funds Request".

Header Type Description
X-Request-ID string , required

Unique ID of the request, set by the initiating party and echoed back in the response.

Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

Format: uuid

Digest string , required

Integrity hash of the request body in the form SHA-256=<base64>. For an empty body, use the hash of an empty string. See Signing requests for how the Digest and signature are built.

Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=

x-jws-signature string , required

Detached JSON Web Signature over the signed request headers and body. See Signing requests for how it is constructed.

Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4

Consent-ID string , required

Identifier of the consent that authorises this access, as returned when the consent was created.

Example: 123cons456

Allowed length: max: 70

Field Type Description
payee string , optional

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

account object , required

PSU's account number.

cardNumber string , optional

Card Number of the card issued by the PIISP. Should be delivered if available.

instructedAmount object , required

Transaction amount to be checked within the funds check mechanism.

Select a status code to see the structure and an example of the response.

Field Type Description
fundsAvailable boolean , required

Equals true if sufficient funds are available at the time of the request, false otherwise.