Confirmation of funds service

Create consent

In order to perform a confirmation of funds request, a confirmation of funds consent is required. This chapter describes the steps required to create such a consent. The created consent has to be approved in the next step before it can be used.

• Create JSON body
• Generate signature and set headers
• Perform request

Create JSON body

{
	"account": {
	  "iban": "NL34BNGT5532530633"
	}
}

Generate signature and set headers

Approve consent

After a confirmation of funds consent has been created, it has to be approved by the PSU. To do so, the following steps have to be taken:

• Redirect to OAuth2.0 endpoint
• Login
• Review consent
• Approve consent

Redirect to OAuth2.0 endpoint

Retrieve access token

An access code from the previous step can be exchanged for an access token by the following API

Body

Example of request body. Note: line breaks are for clarifying the example.

client_id=PSDNL-AUT-SANDBOX&
grant_type=authorization_code&
code=f1084fea123e4bc3bcca0a1e5a0a54e5b70e91811dce483aa2168dc539c5f70f&
code_verifier=someverifierdata1234&
state=438b3d36666341019366cf190b57a349&
redirect_uri=redirect_uri

Headers

The following headers are required for the request

Perform request

If the call was successful, a 201 status is returned along with the response body. See below an example of a response.

{
	"access_token": "eyJh...R49Q",
	"token_type": "Bearer",
	"expires_in": "604782",
	"refresh_token": "91f557fe-e01d-4498-bcb9-46dba668de08",
	"scope": "PIIS:ec1bff9e-79d2-4588-9112-2ae65ae2a14b"
}

For other possible return codes, see the API DOCUMENTATION page.

Please store access_token somewhere, for example in Notepad, as it is required in later steps. Note that the access token gives access to all API methods for the corresponding paymentInitiationId. In case a paymentInitiationBatchGroupId was used in a redirect, the access token will give access to all paymentInitiationIds that were generated from the bulk payment file, e.g. in a bulk payment file containing multiple bulk-payments/batches.

Retrieve consent status

To retrieve the status of a confirmation of funds consent, a confirmation of funds consent-id as well as an access_token is required, please see previous steps for directions on how to obtain those.

Headers

The following headers must be provided

Perform request

If the call was successful, a 200 status is returned along with the response body. See below an example of a response.

{
	"consentStatus": "valid"
}

For other possible return codes, see the API DOCUMENTATION page.

Retrieve consent details

To retrieve details of a confirmation of funds consent, a consent-id as well as an access_token is required, please see previous steps for directions on how to obtain those.

Headers

The following headers must be provided

Perform request

If the call was successful, a 200 status is returned along with the response body. See below an example of a response.

{
	"account": {
	  "iban": "NL34BNGT5532530633"
	},
	"lastActionDate": "2019-06-25T09:21:23.197Z",
	"consentStatus": "valid"
}

For other possible return codes, see the API DOCUMENTATION page.

Retrieve consent authorisations

To retrieve authorisations (confirmations) of a confirmation of funds consent, a consent-id as well as an access_token is required, please see previous steps for directions on how to obtain those.

Headers

The following headers must be provided

Perform request

If the call was successful, a 200 status is returned along with the response body. See below an example of a response.

{
	"authorisationIds": [
	  "19e54cc4-400e-4ba5-a9cd-0bfd39753f64"
	]
}

Store an authorisation-id, it is required for the next step.

For other possible return codes, see the API DOCUMENTATION page.

Retrieve consent authorisation details

To retrieve the details of an authorisation (confirmation) of a confirmation of funds consent, a consent-id as well as an access_token and an authorisation-id is required, please see previous steps for directions on how to obtain those.

Headers

The following headers must be provided

Perform request

If the call was successful, a 200 status is returned along with the response body. See below an example of a response.

{
	"scaStatus": "finalised"
}

For other possible return codes, see the API DOCUMENTATION page.

Perform confirmation of funds request

Checks whether a specific amount is available at point of time of the request on an account. To perform this request a confirmation of funds consent-id as well as an access_token is required, please see previous steps for directions on how to obtain those.

• Create JSON body
• Generate signature and set headers
• Perform request

Create JSON body

{
	"account": {
		"iban": "NL34NEMO1560818072"
	},
	"instructedAmount": {
		"amount": 123.45
		"currency": "EUR",
	}
}

Generate signature and set headers

Delete consent

To delete a confirmation of funds consent, a confirmation of funds consent-id as well as an access_token is required, please see previous steps for directions on how to obtain those.

After calling this API, the status of the consent will be set to "terminatedByTpp", the consent can no longer be used.

Headers

The following headers must be provided

Perform request

If the call was successful, an empty body and status 204 is returned.

For other possible return codes, see the API DOCUMENTATION page.