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.eUVCeDeMET0-VMpm1zt8d55jAexhFncseHtIsucZBfECL7xQ8BnunDe0tk-xLHUZxyt11DI-8aCb43W3a2qinkKPsXjGX7GfM4Q3R5_NZDdN-sbC6VGXlrYyO8ECspbKo69xbfSIWHm5bAr4zIuXpKTL4PFIZIk-rF8WLKQJqgU9Rs6z-PdQHnRO4CZXaA8IgSVAoH7u6fTMqYCN43jZNaR8O7TFrsgsYUXiuHTFeYM9lyD6yd6Oe8UKFVSMi70E10S5NnpmfHDGuJqFT3kKpbPNsBGjqPx8F3Yi5eTfhz3J5J7MDykTuli2K5TmXgLuQp245FbMeKtEpMk3XSq10A' \
-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.t-6Dhza315vb-2BFhE3ve5cHs3yOm0UgCqk0RLQnftH1G3-TjKv8QmVHf71QaSx7Gm39UbSWZh4CBgWasu68jP6CGlf_fgxlNQkC_g8Doos-r_jMz5ggvAJfD3FyrjK1BQyqwx8pwQ1ULLtgD6tumjLQIhI1e35WCSikfmVlzK0a9C-YNKoVqMPNARL7dSpdfFt6-EHTm4vPKwslKuIyWgMd6ccGsYYCXaqTKyZLhvE-Ki9uAEy6YY8KDD7bl1JGP_KZFGUJ-J1_ySZ_ZwSjC9gQetbPbccIBobA5SKbOa-KnPdiqvrL9bL2VAZB6K5MFusIR3Cbp98Zecx0UBZIYQ' \
-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.rMtyUSwYLmLaNB6I9e2weqsZkHfqDoOC7Av84pkOVxdxmeTrgo083WEiiP3nKYHimzfxhbgr-O0nyO6nSuF8OlsMeob2cUQm1_DHNuLd64Xjgt0Rmhl0KYoLZpZIYwcIcPxjFc5fic4_v-zFMpv1QnsIxf-chKATPR39BWLI8fiI5qx2oBGiVOf3-ugKEUf8WEHVh_dG6hGCgn0rB8OrW1dEtEedr3Qx7D0SLyvV1wxUprQybw4FBiswpRP_4NLuUhSkLYP716fG2hWnEtcX6U51H_IMwPlL7a-CXOPRRenN60umk_8VBawt54A6BkWoxnbj6rAygZWY8FNGK_u_YQ' \
-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.Dqr_LboqmZ1Q8BGWQd_z2EXXG4F4JqClpJKczSejP-HBk0L3q79_IayOvL1hdETTFWtKqXExlogpYMSsCpqvxOuba0IJo3GK7_9OIYaH8xqVVpPok997K9olDHvzUl55RLRBWbZgFGTE3LqrhJkhU6t-RzvewSEBydCga87OaR3_HLsqs-pd7sYMUGdUFr4fIKL07rMnrZNgYSrk0TnaZXqECpByNlRcReS_528GW39CAp3KAMUND4yHR4peAnySMXHX4s0ta6p3-IIcHa2heg1k7a-2X6U_CYe-MgF3-0mw8APviJ-dJCRGArCBE5-tEtuRbT521H76A48qthBIfQ' \
-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 . |