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.Jb5AMLexp-gkf-TxUCyoADhK7Re13N460HEDI6XjDjTRKxOCp_JErp6q1t6VCQiMh-Eg6lpU35wOHQ9Y8MIACALglgCiYRgS7cK6jdoV-izg0F-bzKMsFa11Gh1EJ7z923dxZbqBiVT4KZhfwDWVquokngutYhjHb5SB1jwfQlUkuOmqfN9sjEiLqgXpdyHjuHd7B8Nt3-Ism9W7BwZdhOc9oZG7qbtCd1VAOmQRl0EQux-9p5eoxvf2POj5d2l8fCJMdMSoooHn6uzwb_ZS97FjyiCHinxcnRo9YAFysypmMYqJRt51RBUZlmb8q-k20XRb_-xb6lK89_3sGq1WNA' \
-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.sjfw9bMm1OWzDMpXVzshNiLgZTSTE2-xoo_VJzzkIdlx0wkbGjNJaNL0gjKLP-5dRtVZ34Xi2-bKdoLYT4TeFub_lV07Zf-1-WOMjSBqtDthOeji3wkkDfEjkQGGRKLlpELEa-lvuql_6bl2ah9pqqIbnufJ5ivXy7OXa46UQ39ryN2HSpGdW88j-bjIQta-SFu8UaQXNxj65lsNsWwAQWLSYTM5R-dS2Lpw0ryXno83euXEy_wHUu507evfUKPXrRrGjQstn66O3Hs8Q3Pj8mw4s0GH7PAcwSdQXdnvEJh51PSYYNmKVMXvzPwrnfO1ZfHfWoAG1g7SnUD7OmE6Kw' \
-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.e4zf8DQrQ3GKPfsgrmhh69csvQ0FmS8y6GsFzlt6UJdsimOwvzwvx7D4w1kORtpqv1Fte5nNRF3KY5b09kfcgZm5R1QP_GUP6AhQuNR-SleHrbeC9duAZ0zjokwzs_uqFwcCr3SceD52V2q22-nlYJxKXmjBkalWK8o5Grhe9l0QBLT71nAxY7gq7Ogqr3ML6ba3A2vFEQuIg5zYVgRLniC_dLiyZo9GADPeSZ2TntOpyGwSEUEnZSetx2KAIWDb2QMPr1hoY3aA64NE11SvTHEkIlxtRAsN3rvBW4iP4kIl2sxrIoyYH3hEgR1BcFg5i5pZQRuekWUJcHXQg5T9Ow' \
-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.DPgDmqtPSVYq9GplbBDXS4TEpCIibQgBaI8BxbVrevsKXjHIav1Dd1FRacQiwdRNyS0UsB2VRtx_lVygsHv_82iU1lUUsccwz6gKZcMExiV9OZylBMYS6YVXyeb9jVMwFcHJZlTyCYxjEkl5z8C0GWqMJGF-SYIjeQ1ov4D_0Ghc4o524TvgZDXpS_RF6oUGCdmu1kxpds_lLUSp3BqkHE_MeUHz9IJRLpYqr89--E6IOzWdCtr6kcKKxxZ4PVGBIDPiiI8KS5MhhS_cDnR5_HuzZdKfsFO6Horc84vtt8dVX5qDX4ferz-e77m6Tx0PTrPg1EKR_xC2rMr0wLGKZg' \
-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 . |