Funds Confirmation Consent v3.1

Version Control

VersionDateAuthorComments
3.0 OB R/W API TeamThis is the baseline version. No change from RC3.
3.1-draft1 OB R/W API Team

This is the initial draft version for 3.1

Errata:

  • Typos and grammar fixes.
3.1-draft2 OB R/W API TeamNo Change
3.1-draft3 OB R/W API TeamDraft3 Changes:
  • Data Model updated with a typed field for Account/SchemeName field to reference in Namespaced Enumerations page.
3.1OB R/W API Team

Version 3.1 final release.

No changes from Version 3.1 RC1.

Endpoints

ResourceHTTP OperationEndpointMandatory ?ScopeGrant TypeMessage SigningIdempotency KeyRequest ObjectResponse Object
funds-confirmation-consentPOSTPOST /funds-confirmation-consentsMandatoryfundsconfirmationsClient CredentialsNoNoOBFundsConfirmationConsent1

OBFundsConfirmationConsentResponse1

funds-confirmation-consentGETGET /funds-confirmation-consents/{ConsentId}MandatoryfundsconfirmationsClient CredentialsNoNoNA

OBFundsConfirmationConsentResponse1

funds-confirmation-consentDELETEDELETE /funds-confirmation-consents/{ConsentId}MandatoryfundsconfirmationsClient CredentialsNoNoNANA

POST /funds-confirmation-consents

The API allows the CBPII to ask an ASPSP to create a new funds-confirmation-consent resource.

  • This endpoint allows the CBPII to propose a consent to be agreed between the ASPSP and PSU, to authorise the CBPII access to confirm funds are available.
  • The ASPSP creates the funds-confirmation-consent resource and responds with a unique ConsentId to refer to the resource.
  • Prior to calling the operation, the CBPII must have an access token issued by the ASPSP using a client credentials grant.

Funds Confirmation Consent Status

The PSU must authenticate with the ASPSP and agree the funds-confirmation-consent with the ASPSP, for the funds-confirmation-consent to be successfully setup.

The funds-confirmation-consent resource that is created successfully must have one of the following Status code-list enumerations:


StatusStatus Description
1AwaitingAuthorisationThe Funds Confirmation Consent is awaiting agreement.

After consent has been agreed the funds-confirmation-consent resource may have these following statuses.


StatusStatus Description
1RejectedThe Funds Confirmation Consent has been rejected.
2AuthorisedThe Funds Confirmation Consent has been successfully agreed.
3RevokedThe Funds Confirmation Consent has been revoked via the ASPSP interface.

Status Flow

This is the state diagram for the Status.

GET /funds-confirmation-consents/{ConsentId}

A CBPII may optionally retrieve a funds-confirmation-consent resource that they have created to check its status. 

Prior to calling the operation, the CBPII must have an access token issued by the ASPSP using a client credentials grant.

Funds Confirmation Consent Status

Once the PSU agrees the consent outlined in the funds-confirmation-consent resource, the Status of the funds-confirmation-consent resource will be updated with "Authorised".

The available Status code-list enumerations for the funds-confirmation-consent resource are:


StatusStatus Description
1RejectedThe Funds Confirmation Consent has been rejected.
2AwaitingAuthorisationThe Funds Confirmation Consent is awaiting agreement.
3AuthorisedThe Funds Confirmation Consent has been successfully agreed.
4RevokedThe Funds Confirmation Consent has been revoked via the ASPSP interface.

DELETE /funds-confirmation-consents/{ConsentId}

If the PSU revokes consent to confirm funds with the CBPII, the CBPII must delete the funds-confirmation-consent resource.

  • This is done by making a call to DELETE the funds-confirmation-consent resource.
  • Prior to calling the operation, the CBPII must have an access token issued by the ASPSP using a client credentials grant.

Data Model

This data dictionary section gives the detail on the payload content.

Funds Confirmation Consent - Request

The OBFundsConfirmationConsent1 object will be used for the following:

  • Request to POST /funds-confirmation-consents

UML Diagram

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodes
OBFundsConfirmationConsent1
OBFundsConfirmationConsent1
OBFundsConfirmationConsent1
Data1..1OBFundsConfirmationConsent1/Data
OBFundsConfirmationConsentData1
ExpirationDateTime0..1OBFundsConfirmationConsent1/Data/ExpirationDateTimeSpecified date and time the funds confirmation authorisation will expire.
 If this is not populated, the authorisation will be open ended.
ISODateTime
DebtorAccount1..1OBFundsConfirmationConsent1/Data/DebtorAccountUnambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied.

OBCashAccountDebtor4


SchemeName1..1OBFundsConfirmationConsent1/Data/DebtorAccount/SchemeNameName of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code


Identification1..1OBFundsConfirmationConsent1/Data/DebtorAccount/IdentificationIdentification assigned by an institution to identify an account. This identification is known by the account owner.Max256Text
Name0..1OBFundsConfirmationConsent1/Data/DebtorAccount/NameName of the account, as assigned by the account servicing institution.

Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.
Max70Text
SecondaryIdentification0..1OBFundsConfirmationConsent1/Data/DebtorAccount/SecondaryIdentificationThis is secondary identification of the account, as assigned by the account servicing institution.
This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Max34Text

Funds Confirmation Consent - Response

The OBFundsConfirmationConsentResponse1 object will be used for the following:

  • Response to POST /funds-confirmation-consents
  • Call to GET /funds-confirmation-consents/{ConsentId}

UML Diagram

Notes:

The OBFundsConfirmationConsentResponse1 object contains the same information as the OBFundsConfirmation1, but with additional fields:

  • ConsentId - to uniquely identify the funds-confirmation-consent resource.
  • Status.
  • StatusUpdateDateTime.
  • CreationDateTime.

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodes
OBFundsConfirmationConsentResponse1
OBFundsConfirmationConsentResponse1
OBFundsConfirmationConsentResponse1
Data1..1OBFundsConfirmationConsentResponse1/Data
OBFundsConfirmationConsentDataResponse1
ConsentId1..1OBFundsConfirmationConsentResponse1/Data/ConsentIdUnique identification as assigned to identify the funds confirmation consent resource.Max128Text
CreationDateTime1..1OBFundsConfirmationConsentResponse1/Data/CreationDateTimeDate and time at which the resource was created.ISODateTime
Status1..1OBFundsConfirmationConsentResponse1/Data/StatusSpecifies the status of consent resource in code form.OBExternalRequestStatus1CodeAuthorised
AwaitingAuthorisation
Rejected
Revoked
StatusUpdateDateTime1..1OBFundsConfirmationConsentResponse1/Data/StatusUpdateDateTimeDate and time at which the resource status was updated.ISODateTime
ExpirationDateTime0..1OBFundsConfirmationConsentResponse1/Data/ExpirationDateTimeSpecified date and time the funds confirmation authorisation will expire.
If this is not populated, the authorisation will be open ended.
ISODateTime
DebtorAccount1..1OBFundsConfirmationConsentResponse1/Data/DebtorAccountUnambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied.

OBCashAccountDebtor4


SchemeName1..1OBFundsConfirmationConsentResponse1/Data/DebtorAccount/SchemeNameName of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code


Identification1..1OBFundsConfirmationConsentResponse1/Data/DebtorAccount/IdentificationIdentification assigned by an institution to identify an account. This identification is known by the account owner.Max256Text
Name0..1OBFundsConfirmationConsentResponse1/Data/DebtorAccount/NameName of the account, as assigned by the account servicing institution.

Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.
Max70Text
SecondaryIdentification0..1OBFundsConfirmationConsentResponse1/Data/DebtorAccount/SecondaryIdentificationThis is secondary identification of the account, as assigned by the account servicing institution.
This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Max34Text

Data Payload - Enumerations

This section gives the definitions for enumerations used in the Confirmation of Funds APIs.

Code ClassName Definition 
OBExternalRequestStatus1CodeAuthorisedThe funds confirmation consent has been successfully agreed.
OBExternalRequestStatus1CodeAwaitingAuthorisationThe funds confirmation consent is awaiting agreement.
OBExternalRequestStatus1CodeRejectedThe funds confirmation consent has been rejected.
OBExternalRequestStatus1CodeRevokedThe funds confirmation consent has been revoked via the ASPSP interface.