Salt Edge PSD2 Compliance Logo

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.Y5UGDxjw8PiWl4am1qXWuno7dFdc44fRQ_ee2JJ0LelmXUN4_wP3f7_Oo1k9rjQxsP9WpdRCiTFlKDkOz75FwnhbHrLB0sk40unuAH9fF3OZcjPNcHLIkcjqKG0-rzLlbSAaIK1OR5KFXKlzgK2y4QWIVE_7xVSmEsIYn0KuJxTA-mmHRHLBMmESBpkRbuVjrS2dpxiWecpO_CkPpZemlJQFXPaOp5DpJkF439pqRn0m3duEo2ePVLn0diHNbyl66FnoLk2vVyV_QJ2VO9bsD1lSSQPfLBMrYj3LrnNLiY46X2BSI9kAQ5rNzRItDLMG9Mkjtzpv9I8_J8DbAv4EoQ' \ 
-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
provider_code (path)
string, required
Human readable Provider identifier. Can raise: ResourceNotFound
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.


Meta
hash, required
Wrapper for the meta. Default value: {}
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.QZf22xsYpR6Ol8WVn7r0F06wsMiN9RN88-2bpiTk25r0jrufF65kIYAjWLLQVKdBLVJLfd0bMUBEGSdk0GTbmof12WjYMg12BBpCBwtaF6kYXJSJzkTCekx6nFi0YXkRtMhopt9Xp19u_UNohvzBfUcG-UE_jF4kRieuN4Zvu0O02Z6UaDnG3NOxT5s46ZCB40x6M7ZIkpKyaGdHi7cQlaxuChLYNuB6bsGeLwqRHeYmle6D-5KOOvN1cMsHRFMgyDYZRsT-2FuMPfOawraUMwjvHTTLbzC0bmdHoKk4a7WfgUvqtxCgHcoD-qGDf8HrXiYC3lQwRBQO0iXZB_jLUw' \ 
-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
provider_code (path)
string, required
Human readable Provider identifier. Can raise: ResourceNotFound
consent_id (path)
string, required
The consent identifier assigned to the created resource. Can raise: FieldInvalid, ResourceNotFound
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.


Meta
hash, required
Wrapper for the meta. Default value: {}
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.lcX6hLaw1TmiaVPSJzW56KLqDa-Wu0BaqGTqlNjgXw_Vxh9HBBK_LIIkxb4OZxdPhY3nDBCYcHwSO8eJfUTfScPo5exKk3xJmDekWIjmZJX0ajKlNGzrwGMU6bCxv1qx0LqSh_vVBtl1BWuGJLJ7M45w-qFnPovVLkGkgetxZa5_5P2RtmMGR8cg5aaDQ9_s-uqTDmlytJfZr4LEU7CUc9Nk3ozJN0PdR9vsDq5Wa0sLuKreFR0lGnSMussqQV_AGopRemUh7hr0VlWW30Cvi0GwK6stCD1ucR1LHtb_bRVjeU0QePmxc31q61ranK2vUh9djwwZHz_Vbqlhdv60RQ' \ 
-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
provider_code (path)
string, required
Human readable Provider identifier. Can raise: ResourceNotFound
consent_id (path)
string, required
The consent identifier assigned to the created resource. Can raise: FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus
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.

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.fE_bqJsDKC4NsqEHX_6u0KB6LBjsahy3am6bu-9RLcaCyI7Hy8pvTGoC_tkjLOybLBNyvVu3d-95ZUK8L703hrwi-UKmpq7tXeQGE6zBBXbRqK7SDQ2maECZtgd_T55vVu7bGiHTK4ipDkHf36gwS4qMsF3ro-fVaV4Vlf6wbCQ1Zaak11n7rcU_xrNvk7-cLvU0FACwea1KxMLgf8dh6koagg4c454M3n2MMr8FvPbMUv8rHM-TFDp72k6SvXlgc06KLZ2FZFsL0m-swPcPjzBHjCp0kBKDI79myo3TAfko7lTmxS_L4iA3NxXBagkt8y8tbZYACsNqIsLFGeWCKA' \ 
-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
provider_code (path)
string, required
Human readable Provider identifier. Can raise: ResourceNotFound
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.


Meta
hash, required
Wrapper for the meta. Default value: {}
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.