/
Funds Confirmation Consent v3.1

Funds Confirmation Consent v3.1

Nov 30, 2018

Version Control

Version

Date

Author

Comments

Version

Date

Author

Comments

3.0

Sep 7, 2018 

OB R/W API Team

This is the baseline version. No change from RC3.

3.1-draft1

Sep 12, 2018 

OB R/W API Team

This is the initial draft version for 3.1

Errata:

  • Typos and grammar fixes.

3.1-draft2

Oct 9, 2018 

OB R/W API Team

No Change

3.1-draft3

Oct 18, 2018 

OB R/W API Team

Draft3 Changes:

  • Data Model updated with a typed field for Account/SchemeName field to reference in Namespaced Enumerations page.

3.1

Nov 30, 2018

OB R/W API Team

Version 3.1 final release.

No changes from Version 3.1 RC1.

Endpoints

Resource

HTTP Operation

Endpoint

Mandatory ?

Scope

Grant Type

Message Signing

Idempotency Key

Request Object

Response Object

Resource

HTTP Operation

Endpoint

Mandatory ?

Scope

Grant Type

Message Signing

Idempotency Key

Request Object

Response Object

funds-confirmation-consent

POST

POST /funds-confirmation-consents

Mandatory

fundsconfirmations

Client Credentials

No

No

OBFundsConfirmationConsent1

OBFundsConfirmationConsentResponse1

funds-confirmation-consent

GET

GET /funds-confirmation-consents/{ConsentId}

Mandatory

fundsconfirmations

Client Credentials

No

No

NA

OBFundsConfirmationConsentResponse1

funds-confirmation-consent

DELETE

DELETE /funds-confirmation-consents/{ConsentId}

Mandatory

fundsconfirmations

Client Credentials

No

No

NA

NA

POST /funds-confirmation-consents

POST Funds Confirmation Consent
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:



Status

Status Description



Status

Status Description

1

AwaitingAuthorisation

The Funds Confirmation Consent is awaiting agreement.

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



Status

Status Description



Status

Status Description

1

Rejected

The Funds Confirmation Consent has been rejected.

2

Authorised

The Funds Confirmation Consent has been successfully agreed.

3

Revoked

The 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}

GET Funds Confirmation Consent
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:



Status

Status Description



Status

Status Description

1

Rejected

The Funds Confirmation Consent has been rejected.

2

AwaitingAuthorisation

The Funds Confirmation Consent is awaiting agreement.

3

Authorised

The Funds Confirmation Consent has been successfully agreed.

4

Revoked

The Funds Confirmation Consent has been revoked via the ASPSP interface.

DELETE /funds-confirmation-consents/{ConsentId}

DELETE Funds Confirmation Consent
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

Name

Occurrence

XPath

EnhancedDefinition

Class

Codes

Name

Occurrence

XPath

EnhancedDefinition

Class

Codes

OBFundsConfirmationConsent1



OBFundsConfirmationConsent1



OBFundsConfirmationConsent1



Data

1..1

OBFundsConfirmationConsent1/Data



OBFundsConfirmationConsentData1



ExpirationDateTime

0..1

OBFundsConfirmationConsent1/Data/ExpirationDateTime

Specified date and time the funds confirmation authorisation will expire.
 If this is not populated, the authorisation will be open ended.

ISODateTime



DebtorAccount

1..1

OBFundsConfirmationConsent1/Data/DebtorAccount

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

OBCashAccountDebtor4



SchemeName

1..1

OBFundsConfirmationConsent1/Data/DebtorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code



Identification

1..1

OBFundsConfirmationConsent1/Data/DebtorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBFundsConfirmationConsent1/Data/DebtorAccount/Name

Name 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



SecondaryIdentification

0..1

OBFundsConfirmationConsent1/Data/DebtorAccount/SecondaryIdentification

This 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

Name

Occurrence

XPath

EnhancedDefinition

Class

Codes

Name

Occurrence

XPath

EnhancedDefinition

Class

Codes

OBFundsConfirmationConsentResponse1



OBFundsConfirmationConsentResponse1



OBFundsConfirmationConsentResponse1



Data

1..1

OBFundsConfirmationConsentResponse1/Data



OBFundsConfirmationConsentDataResponse1



ConsentId

1..1

OBFundsConfirmationConsentResponse1/Data/ConsentId

Unique identification as assigned to identify the funds confirmation consent resource.

Max128Text



CreationDateTime

1..1

OBFundsConfirmationConsentResponse1/Data/CreationDateTime

Date and time at which the resource was created.

ISODateTime



Status

1..1

OBFundsConfirmationConsentResponse1/Data/Status

Specifies the status of consent resource in code form.

OBExternalRequestStatus1Code

Authorised
AwaitingAuthorisation
Rejected
Revoked

StatusUpdateDateTime

1..1

OBFundsConfirmationConsentResponse1/Data/StatusUpdateDateTime

Date and time at which the resource status was updated.

ISODateTime



ExpirationDateTime

0..1

OBFundsConfirmationConsentResponse1/Data/ExpirationDateTime

Specified date and time the funds confirmation authorisation will expire.
If this is not populated, the authorisation will be open ended.

ISODateTime



DebtorAccount

1..1

OBFundsConfirmationConsentResponse1/Data/DebtorAccount

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

OBCashAccountDebtor4



SchemeName

1..1

OBFundsConfirmationConsentResponse1/Data/DebtorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code



Identification

1..1

OBFundsConfirmationConsentResponse1/Data/DebtorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBFundsConfirmationConsentResponse1/Data/DebtorAccount/Name

Name 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



SecondaryIdentification

0..1

OBFundsConfirmationConsentResponse1/Data/DebtorAccount/SecondaryIdentification

This 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 Class

Code Class

© Open Banking Limited 2019 | https://www.openbanking.org.uk/open-licence | https://www.openbanking.org.uk