Consents
Create
The API allows the TPP to ask an ASPSP to create a new funds-confirmation-consent resource.
CURL
![]()
curl -i \
-H "Authorization: Bearer authorization" \
-H "Content-Type: application/json" \
-H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkV4cGlyYXRpb25EYXRlVGltZSI6IjIwMTctMDYtMDVUMTU6MTU6MTMrMDA6MDAiLCJEZWJ0b3JBY2NvdW50Ijp7IlNjaGVtZU5hbWUiOiJVSy5PQklFLlNvcnRDb2RlQWNjb3VudE51bWJlciIsIklkZW50aWZpY2F0aW9uIjoiMTEyODAwMDEyMzQ1NjciLCJOYW1lIjoiQW5kcmVhIFNtaXRoIiwiU2Vjb25kYXJ5SWRlbnRpZmljYXRpb24iOiIwMDAyIn19fQ.PPwqqOkE3dIkKZDkjvvyo7aXLu2Uy_VYa0bAlree2WJZKO9MNj-d8b6vVm3dnKPqcfQsPTpWO6hiWpWquv02r5AzImE_DSgE9Xe_tnxPK05CJVKg_XxLsaj6eu_7yLMyK74rYWmfXZbFFSit33v8oDYRWydAsMiDSkFkNUbN085ii9wil2rhzLPkYkDSq4yZOmqiqYbQTG-hOUlwHvPWO465V0dp66dZz39y2HcTr9hqSKhoc9IEcS5FS4wHg3off2FSsJWZNU11oX4inQbJZZrvFo9TZUJ6c2O3Ew-L1hAF9O6Awja-MehcryGTTyuuwiwiIpZMTQC72o7C6VHe7g' \
-X POST "/api/:provider_code/open-banking/v3.1/cbpii/funds-confirmation-consents"
Example of request
![]()
{"Data":{"ExpirationDateTime":"2017-06-05T15:15:13+00:00","DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"}}}
Example of response
![]()
{"Data":{"ConsentId":"18463","CreationDateTime":"2017-06-05T15:15:13+00:00","Status":"AwaitingAuthorisation","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ExpirationDateTime":"2017-06-05T15:15:13+00:00","DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"}},"Links":{"Self":"/open-banking/v3.1/cbpii/funds-confirmation-consents/18463"},"Meta":{}}
Request
POST
/api/:provider_code/open-banking/v3.1/cbpii/funds-confirmation-consents
Headers
Header | Type | Description |
---|---|---|
Content-Type
|
string, optional | The media type of the body of the request. Default value: application/json |
x-fapi-interaction-id
|
string, optional | An RFC4122 UID used as a correlation Id. |
Authorization
|
string, required | Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden |
Idempotency-Key
|
string, optional | Unique uuid used to recognize subsequent retries of the same request valid for 24 hours. Allowed length: max: 40 characters |
Request parameters
Response headers
Header | Type | Description |
---|---|---|
Content-Type
|
string, required | The media type of the body of the request. |
x-fapi-interaction-id
|
string, required | An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header. |
Retry-After
|
integer, optional | Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request. |
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
Related Errors
Class | Code | Description |
---|---|---|
ResourceNotFound | 400 | Specified resource doesn't exist. |
FieldInvalidDate | 400 | An invalid date is supplied. |
FieldInvalid | 400 | An invalid value is supplied in the field. More details in error_message . |
HeaderMissing | 400 | A required HTTP header has not been provided. |
HeaderInvalid | 400 | An invalid value is supplied in the HTTP header. |
Forbidden | 403 | Action is forbidden. More details in error_message . |
Show
The API allows the TPP to ask an ASPSP to show a funds-confirmation-consent resource.
CURL
![]()
curl -i \
-H "Authorization: Bearer authorization" \
-H "Content-Type: application/json" \
-H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.SSoyX9QFjVYMuvQbtZ-GcBotF4QdkodXfZ9bb4dyPpxGxJaElhBkXZ4cPREkDJN3jLOTO9X7sA2A6iM02eOGQFUrz3JFFpcfSjnvMUcg_-Oux3tuGoWTkx-fipfojWRGbhmCnV107XCsIAmld7XwbwQ-n-Z9qT40iVVJfOlKsWgBKyrPI5BI0CbtY1xzBg58OyF7VSjtT7v0qBVJ-6njbqYBq-ffNq8LgnjkgnNgLqJrz0WUGajk2e6WhoASIYJ7coFPmf08KH4uBNUxoHZul3koesDc8JCXu7E1nKOJRgDLBFf5H4uJ6p3dA-s_iG81dQ7WBTuJhXZjtj9jItyQNA' \
-X GET "/api/:provider_code/open-banking/v3.1/cbpii/funds-confirmation-consents/:consent_id"
Example of response
![]()
{"Data":{"ConsentId":"18463","CreationDateTime":"2017-06-05T15:15:13+00:00","Status":"AwaitingAuthorisation","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ExpirationDateTime":"2017-06-05T15:15:13+00:00","DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"}},"Links":{"Self":"/open-banking/v3.1/cbpii/funds-confirmation-consents/18463"},"Meta":{}}
Request
GET
/api/:provider_code/open-banking/v3.1/cbpii/funds-confirmation-consents/:consent_id
Headers
Header | Type | Description |
---|---|---|
Content-Type
|
string, optional | The media type of the body of the request. Default value: application/json |
x-fapi-interaction-id
|
string, optional | An RFC4122 UID used as a correlation Id. |
Authorization
|
string, required | Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden |
Request parameters
Response headers
Header | Type | Description |
---|---|---|
Content-Type
|
string, required | The media type of the body of the request. |
x-fapi-interaction-id
|
string, required | An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header. |
Retry-After
|
integer, optional | Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request. |
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
Related Errors
Class | Code | Description |
---|---|---|
ResourceNotFound | 400 | Specified resource doesn't exist. |
FieldInvalid | 400 | An invalid value is supplied in the field. More details in error_message . |
HeaderMissing | 400 | A required HTTP header has not been provided. |
HeaderInvalid | 400 | An invalid value is supplied in the HTTP header. |
Forbidden | 403 | Action is forbidden. More details in error_message . |
Destroy
If the PSU revokes consent to confirm funds with the TPP, the TPP must delete the funds-confirmation-consent resource.
CURL
![]()
curl -i \
-H "Authorization: Bearer authorization" \
-H "Content-Type: application/json" \
-H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.jGBprIHVXiYm4gC95g6RqEHUvEgDIAvXGRvpt8RUuSlv7aHycLuxW_9AJp8J4aD28EkaR0x4h8Eik2DciP1VhiU_au3Uhg9GxCCTaQIUK34ks3qilJud294HOWNjpxPI51TvRPHHhp1Tcj3FWKWOKKbxU5ekoxwM9Yb667pzLjktNwMdGdqB2vJrBm-CDHB_GaKy5afcqGGbg90qcEd-bqdS3GdwKG6D433yxvWzVgf7-0F7hnkKiFDKzU1S24phcShGupO2a7A01jUX4zuo6XPbNBGABrAFHfosTFIcpTyhrcXFgyI-ZjKfqE2rTKTyG0vVQpV3cg-sez6XaCZp9g' \
-X DELETE "/api/:provider_code/open-banking/v3.1/cbpii/funds-confirmation-consents/:consent_id"
Request
DELETE
/api/:provider_code/open-banking/v3.1/cbpii/funds-confirmation-consents/:consent_id
Headers
Header | Type | Description |
---|---|---|
Content-Type
|
string, optional | The media type of the body of the request. Default value: application/json |
x-fapi-interaction-id
|
string, optional | An RFC4122 UID used as a correlation Id. |
Authorization
|
string, required | Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden |
Request parameters
Response headers
Header | Type | Description |
---|---|---|
Content-Type
|
string, required | The media type of the body of the request. |
x-fapi-interaction-id
|
string, required | An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header. |
Retry-After
|
integer, optional | Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request. |
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
Related Errors
Class | Code | Description |
---|---|---|
ResourceNotFound | 400 | Specified resource doesn't exist. |
FieldInvalid | 400 | An invalid value is supplied in the field. More details in error_message . |
ResourceInvalidConsentStatus | 400 | The action can't be performed with current status of consent. |
HeaderMissing | 400 | A required HTTP header has not been provided. |
HeaderInvalid | 400 | An invalid value is supplied in the HTTP header. |
Unauthorized | 401 | Unauthorized access. |
Forbidden | 403 | Action is forbidden. More details in error_message . |
Funds Confirmation
Create
If the TPP would like to confirm funds with the ASPSP, it should create a new funds-confirmation resource, and check the funds available flag in the response.
CURL
![]()
curl -i \
-H "Authorization: Bearer authorization" \
-H "Content-Type: application/json" \
-H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkNvbnNlbnRJZCI6IjEyMyIsIlJlZmVyZW5jZSI6IlNvbWUgcmVmIiwiSW5zdHJ1Y3RlZEFtb3VudCI6eyJBbW91bnQiOiIxMTUuMyIsIkN1cnJlbmN5IjoiR0JQIn19fQ.vnMNIWz7MatU33LLFNduSClsJgyTwprBS5HeoTZXp7H_1Ks3XwCdh70g_zXGxCbUPIJK6aNthXpUEMuk2529ETL5T7uhi71IFky45YOIk2LDWKpMu-r3Sh1vi6R3LT7_KF30lP2QGMB-iKKaTBUL3c20oKVglrLnc53EDbEWjV91CxqTNGcPfF-nX_uxfrWSWJ2X4GNa11qtNz4xVWT1IKE67NJOCZm7IGZFoIR0usel-w-sSN9IC0RUEvgxfjcuxDic_QhPI6r7iP6yINz-0it4jbrkB7CJIPaoYvigmmH3gJ4rBAKALzz0lKxaZip6QqhcDDhBJ3yrSrcHlK4BYA' \
-X POST "/api/:provider_code/open-banking/v3.1/cbpii/funds-confirmations"
Example of request
![]()
{"Data":{"ConsentId":"123","Reference":"Some ref","InstructedAmount":{"Amount":"115.3","Currency":"GBP"}}}
Example of response
![]()
{"Data":{"FundsConfirmationId":"1321","ConsentId":"22123","CreationDateTime":"2017-06-05T15:15:13+00:00","FundsAvailable":true,"Reference":"Some ref","InstructedAmount":{"Amount":"115.3","Currency":"GBP"}},"Links":{"Self":"/open-banking/v3.1/cbpii/funds-confirmations/1321"},"Meta":{}}
Request
POST
/api/:provider_code/open-banking/v3.1/cbpii/funds-confirmations
Headers
Header | Type | Description |
---|---|---|
Content-Type
|
string, optional | The media type of the body of the request. Default value: application/json |
x-fapi-interaction-id
|
string, optional | An RFC4122 UID used as a correlation Id. |
Authorization
|
string, required | Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden |
Idempotency-Key
|
string, optional | Unique uuid used to recognize subsequent retries of the same request valid for 24 hours. Allowed length: max: 40 characters |
Request parameters
Response headers
Header | Type | Description |
---|---|---|
Content-Type
|
string, required | The media type of the body of the request. |
x-fapi-interaction-id
|
string, required | An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header. |
Retry-After
|
integer, optional | Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request. |
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
Related Errors
Class | Code | Description |
---|---|---|
ResourceNotFound | 400 | Specified resource doesn't exist. |
FieldInvalid | 400 | An invalid value is supplied in the field. More details in error_message . |
UnsupportedCurrency | 400 | The currency is not supported. |
HeaderMissing | 400 | A required HTTP header has not been provided. |
HeaderInvalid | 400 | An invalid value is supplied in the HTTP header. |
Forbidden | 403 | Action is forbidden. More details in error_message . |