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.PQM1KNQ2gTrjyZSK8rbRn0XHLPacRhIVdGVG7nhb8TbK5x7gsdvdfU7-lTZgUHS1SOGNXsI_JKYyEYNr4dKPkWqi4U_v5Ua8P-lm87U0kjAT6GizLJnIiNSZvTAkrbIcTZ1LS12RWDL7f5x9ZQBe8r7m435JlEy4grReY6Krd3qEp9g9yiBQ79GB52ifvIFCG7yNTF3O9LLWGwXconV4osxyCzAAxF_c2GRJ2RDASdH-rmjfOobItkue7K6IjKyZdNmsqRgj8ZY5ZpP7mPeFeiEBt-kY_pZLjCcWTT3Ctx41opyYWTk1YKTc4zTzMTByxZB-DnSOQ0xSI4MyqJ5Ttg' \
-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.Yg2KRt-BR3woPCfXGA6bCfqC-RydX5C9e1f3IUihyePh0WjfWfalVl8qsOEDkRckqaw3qFEYWznpb9Jo2yFcNVXPDV_bBMCwv_5pycQwZnzuDst02tpHBPfvZdYz5vvVYYL7QsVd2i2FJRdCcMIr3JY6THJr63-GCEZZvMInGFq97oHO7i2In1C40mQgfPDw-7wqAPTqsmAYXo0EGRVMpR_42iDkOIn_9rIu6ihXtq6OsUFoT5wP8zqbVu3uVnUE_s63s4fJvTAXnQCvLFO1h7-G5U3xQCkSNsPc-1R1dXJeHhgURkclTCtaLQfuSvYHMdBMk6TacV53haw8vrGGYA' \
-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.Fv-sZYN2n4oo3izkqNty6ypcad6pRrzLyUBrrLYVxp2VhqrNFaGBwXXG77z1gvpSE8j_8IjM7cPU4gk93ISQAEouVTHLTYafmmh66NSrB7hKWu3MP6_ni23STEQnVqHt_61NCpG59xP2JMNJGEwiGfO2mMamCRKSsskIP8x-Sx0LIOSb9mWKnwtzktmUKwpnIp1YfeFHI9C2wuy5wq7LLeX1OfCVV0Ysw6Yovw1lS9k8VTPmA0h9hFAqm5euq7rv0oVjkoF57zlPBk8YmVbxuHoSC7Ls90i-5HBz2dY_9PGXGXWvj1pENZnh5GTbo0Fx8lBsQi41AF8Y9u2IhoVhWg' \
-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.meEbEQsU3X21N0ADSSnI0CLyl34_HGNa2YvO2gSxsB_W1WX9E6Z268Peejdb5NBB8WuxvX83WEk_OZT_kVQ7fZjry4BpO874R9T7ji87cn0oYdEUmvVEsnMqzmJTHSvx9PerwTjQ-3iLJQYOAjd8tGNODtOhNOSXcQ96J8T1X9eqzvzQ-gf5YcJ-We2qflsxhAY2-jH6mzW7OjqYyI4XL9TUkszgxlm_wYuKuFxESZZmYqnPmfytxL6F32xNdOM929k7ad-pJQtKubs7mXPjJmVxfNCIM1FJsmzeZLnpQzQJEoy1JaNaaFfkaDgcr6HWvZjbwiGR9PieP8Y3wPHRbQ' \
-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 . |