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.FesH_uIDyagtd47D8hsDS2NXHW77gef6VoTgeMmHSt0mwgT5qyaKnslDgp2yIDZDPcpJgEtR-S8YQh1tQUzlES4pTd9XTcDql-R4oNEXKjDXD7HQNKqi9WeP-wFSN9Dw-QhIyQ7pFdONnaksoKk1r5oErqFJi_eofbxcbFRuDQSmtwizrX_tI0R5gDdWXTXN1GdjvjCU25D9LkBO5eC-elUHZJDfHH6hwOyJNawaD3KP5tuhdSU66SRahaWorInLMWpb34G9CtLYlckVvlRwbFG0ZAZkGVcr8tQc1tOM_97vMGipqMTIEVV9ie_1FYot-9_pAud0zIieiKxBFzN0BA' \ -X POST "/api/:provider_code/open-banking/v3.1/cbpii/funds-confirmation-consents"

curl -i  \ 
 -H "Authorization: Bearer authorization" \ 
 -H "Content-Type: application/json" \ 
 -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkV4cGlyYXRpb25EYXRlVGltZSI6IjIwMTctMDYtMDVUMTU6MTU6MTMrMDA6MDAiLCJEZWJ0b3JBY2NvdW50Ijp7IlNjaGVtZU5hbWUiOiJVSy5PQklFLlNvcnRDb2RlQWNjb3VudE51bWJlciIsIklkZW50aWZpY2F0aW9uIjoiMTEyODAwMDEyMzQ1NjciLCJOYW1lIjoiQW5kcmVhIFNtaXRoIiwiU2Vjb25kYXJ5SWRlbnRpZmljYXRpb24iOiIwMDAyIn19fQ.FesH_uIDyagtd47D8hsDS2NXHW77gef6VoTgeMmHSt0mwgT5qyaKnslDgp2yIDZDPcpJgEtR-S8YQh1tQUzlES4pTd9XTcDql-R4oNEXKjDXD7HQNKqi9WeP-wFSN9Dw-QhIyQ7pFdONnaksoKk1r5oErqFJi_eofbxcbFRuDQSmtwizrX_tI0R5gDdWXTXN1GdjvjCU25D9LkBO5eC-elUHZJDfHH6hwOyJNawaD3KP5tuhdSU66SRahaWorInLMWpb34G9CtLYlckVvlRwbFG0ZAZkGVcr8tQc1tOM_97vMGipqMTIEVV9ie_1FYot-9_pAud0zIieiKxBFzN0BA' \ 
-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
`Accept`	string, optional	Media type that is acceptable for the response. Default value: application/json
`x-fapi-interaction-id`	string, optional	An RFC4122 UID used as a correlation Id.
`Content-Type`	string, optional	The media type of the body of the request. Default value: application/json
`Idempotency-Key`	string, optional	Unique uuid used to recognize subsequent retries of the same request valid for 24 hours. Allowed length: max: 40 characters
`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

Data

object, required

Wrapper for the data.

ExpirationDateTime

datetime, optional

Specified date and time the funds confirmation authorisation will expire. If this is not populated, the authorisation will be open ended. Values in range between: 2026-08-24T19:01:55+00:00 and 2026-11-22T19:01:55Z Can raise: FieldInvalidDate

DebtorAccount

object, required

Unambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied.

SchemeName

string, required

Name of the identification scheme, in a coded form as published in an external list. Allowed values: UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN Can raise: FieldInvalid

Identification

string, required

Identification assigned by an institution to identify an account. This identification is known by the account owner. Allowed length: max: 256 characters Can raise: FieldInvalid

Name

string, optional

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Allowed length: max: 350 characters Can raise: FieldInvalid

SecondaryIdentification

string, optional

This is secondary identification of the account, as assigned by the account servicing institution. Allowed length: max: 34 characters Can raise: FieldInvalid

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.jejKgEgmEn3gsQNb2d6TicRG_PBKuuvNl1zQlwyRUihPwlpH139CSuxlagcGiF1GtK32_GYNoSa6QvYC5IdTv1uYz7zAFv-BQL0YO4F2SZtVUQegU-P6FkQGqLXCpjag1fE1qhv7dKnkCjQVOnVsunUZG2-Wh5FapyfNikp672EVxS7N-UQl-e7LmwYb2HldcXQJnLRXk_tc1OYAXsgWE6-WMWevwkFRvL76VsHHvNCpDZm9yIi_SNU2g_1cvdHbSRw4ACTQMlaEfWMfzwmd9QiaodUKo9ZJAmgpY95WboN59BBjugKXJkz2ZOaONK40VMA0brwyToQoLIibJxfxSg' \ -X GET "/api/:provider_code/open-banking/v3.1/cbpii/funds-confirmation-consents/:consent_id"

curl -i  \ 
 -H "Authorization: Bearer authorization" \ 
 -H "Content-Type: application/json" \ 
 -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.jejKgEgmEn3gsQNb2d6TicRG_PBKuuvNl1zQlwyRUihPwlpH139CSuxlagcGiF1GtK32_GYNoSa6QvYC5IdTv1uYz7zAFv-BQL0YO4F2SZtVUQegU-P6FkQGqLXCpjag1fE1qhv7dKnkCjQVOnVsunUZG2-Wh5FapyfNikp672EVxS7N-UQl-e7LmwYb2HldcXQJnLRXk_tc1OYAXsgWE6-WMWevwkFRvL76VsHHvNCpDZm9yIi_SNU2g_1cvdHbSRw4ACTQMlaEfWMfzwmd9QiaodUKo9ZJAmgpY95WboN59BBjugKXJkz2ZOaONK40VMA0brwyToQoLIibJxfxSg' \ 
-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
`Accept`	string, optional	Media type that is acceptable for the response. 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.

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.pI40phIhQxOzNTKAR3P6q6OShK9vahDsLDStriZbZ0JRD4KOJl5CmNz8SZ1UiHvYOftozM1LcA4qzFj8QIyC2JB7_jGRNEcbqj6PSio7Vc0fnpFUT0I0wdxK0Wwu5VLRnJ7C5pXY3CFReeDT4VGDmiRO_ZxftItZTffEcqK4MtHr2NX_ct0oYI1dgekBODiqntGEzqqYTGfA2pYSlXZM9jXjONa4xB64ZR6Z_U3mlspYzYGH4OTjsbuFJPn0s4ANrdEu3c6iy0OgTLiYWCjIWb3rcpJh3oDhsjgf4flI0UWO9WqoHTpF5lYqgvhZKd8K6a919MZgbPywEsfd8adNDA' \ -X DELETE "/api/:provider_code/open-banking/v3.1/cbpii/funds-confirmation-consents/:consent_id"

curl -i  \ 
 -H "Authorization: Bearer authorization" \ 
 -H "Content-Type: application/json" \ 
 -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.pI40phIhQxOzNTKAR3P6q6OShK9vahDsLDStriZbZ0JRD4KOJl5CmNz8SZ1UiHvYOftozM1LcA4qzFj8QIyC2JB7_jGRNEcbqj6PSio7Vc0fnpFUT0I0wdxK0Wwu5VLRnJ7C5pXY3CFReeDT4VGDmiRO_ZxftItZTffEcqK4MtHr2NX_ct0oYI1dgekBODiqntGEzqqYTGfA2pYSlXZM9jXjONa4xB64ZR6Z_U3mlspYzYGH4OTjsbuFJPn0s4ANrdEu3c6iy0OgTLiYWCjIWb3rcpJh3oDhsjgf4flI0UWO9WqoHTpF5lYqgvhZKd8K6a919MZgbPywEsfd8adNDA' \ 
-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
`Accept`	string, optional	Media type that is acceptable for the response. 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`.

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.fBOqtTYMlwGW2WecIYM8JAdG3BvGj3Qiq2Su1zDp0aUZG9-pmffKKnunzG8y5YHK1YKniPF0at-D8TZ4FvOvcOx8sIXBMu04MFI5Gq0Ed-a-IJXsciE-S1KpzXWipA7YRyPJII96V_sbU9SxnuwPHFCXyEuWqJysFnQHYc9RkFswO0Oanp0L3eQojqIqt2VxnW4_42yTJOKN4hP1MvG_z6WNjxsyj0i_GWN8OfIbhoVCbmkm5PZJA5lhCVCMwibLQEh-FM_DFKFN7Yw8TAfmmF9i4h2pVGQuZ6Mq9x_UOZGlwqOQYHX_Q3wExwkErqctfSHnBs6nYG843mx026qpcQ' \ -X POST "/api/:provider_code/open-banking/v3.1/cbpii/funds-confirmations"

curl -i  \ 
 -H "Authorization: Bearer authorization" \ 
 -H "Content-Type: application/json" \ 
 -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkNvbnNlbnRJZCI6IjEyMyIsIlJlZmVyZW5jZSI6IlNvbWUgcmVmIiwiSW5zdHJ1Y3RlZEFtb3VudCI6eyJBbW91bnQiOiIxMTUuMyIsIkN1cnJlbmN5IjoiR0JQIn19fQ.fBOqtTYMlwGW2WecIYM8JAdG3BvGj3Qiq2Su1zDp0aUZG9-pmffKKnunzG8y5YHK1YKniPF0at-D8TZ4FvOvcOx8sIXBMu04MFI5Gq0Ed-a-IJXsciE-S1KpzXWipA7YRyPJII96V_sbU9SxnuwPHFCXyEuWqJysFnQHYc9RkFswO0Oanp0L3eQojqIqt2VxnW4_42yTJOKN4hP1MvG_z6WNjxsyj0i_GWN8OfIbhoVCbmkm5PZJA5lhCVCMwibLQEh-FM_DFKFN7Yw8TAfmmF9i4h2pVGQuZ6Mq9x_UOZGlwqOQYHX_Q3wExwkErqctfSHnBs6nYG843mx026qpcQ' \ 
-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
`Accept`	string, optional	Media type that is acceptable for the response. Default value: application/json
`x-fapi-interaction-id`	string, optional	An RFC4122 UID used as a correlation Id.
`Content-Type`	string, optional	The media type of the body of the request. Default value: application/json
`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

Data

object, required

Wrapper for the data. Can raise: ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus

ConsentId

string, required

Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource. Can raise: FieldInvalid

Reference

string, required

Unique reference, as assigned by the TPP, to unambiguously refer to the request related to the payment transaction. Can raise: FieldInvalid

InstructedAmount

object, required

Amount of money to be confirmed as available funds in the debtor account. Contains an Amount and a Currency.

Amount

string, required

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. Can raise: FieldInvalid, RequestFormatInvalid

Currency

string, required

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". Can raise: FieldInvalid, UnsupportedCurrency

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`.
RequestFormatInvalid	400	Request format is wrong. Details are stored 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.
ServiceInvalid	400	Something went wrong on Provider(ASPSP) side.
Forbidden	403	Action is forbidden. More details in `error_message`.
UnprocessableEntity	422	The request was well-formed but the Provider(ASPSP) could not process it. More details in `error_message`.