# Funds Confirmation Consent - v3.1.7
- Overview
- Endpoints
- Data Model
- Usage Examples
# Overview
The Funds Confirmation Consent resource is used by an CBPII to register an intent to confirm funds.
This resource description should be read in conjunction with a compatible Confirmation of Funds API Profile.
# Endpoints
| 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
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 | |
|---|---|---|
| 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 | |
|---|---|---|
| 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}
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.
ASPSP may mask the Identification field partially in the GET response.
ASPSPs may return masked PAN as per their online system e.g. 5555 **** **** 4444, **** **** **** 4444 etc.
# 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 | |
|---|---|---|
| 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}
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 as soon as is practically possible.
- 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 | Pattern |
|---|---|---|---|---|---|---|
| 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 | 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. Note, the account name is not the product name or the nickname of the account. | Max350Text | ||
| 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 | Pattern |
|---|---|---|---|---|---|---|
| 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 | 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. Note, the account name is not the product name or the nickname of the account. | Max350Text | ||
| 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 | Name | Definition |
|---|---|---|
| OBExternalRequestStatus1Code | Authorised | The funds confirmation consent has been successfully agreed. |
| OBExternalRequestStatus1Code | AwaitingAuthorisation | The funds confirmation consent is awaiting agreement. |
| OBExternalRequestStatus1Code | Rejected | The funds confirmation consent has been rejected. |
| OBExternalRequestStatus1Code | Revoked | The funds confirmation consent has been revoked via the ASPSP interface. |
# Usage Examples
# POST - Funds Confirmation Consent
# Example with all permitted fields
# Request
Post Funds Confirmation Consent
POST /funds-confirmation-consents HTTP/1.1
Content-Type: application/json
Authorization: Bearer 1t1satruthun1v3rs4lly
Accept: application/json; charset=utf-8
x-fapi-auth-date: Mon, 13 Nov 2017 19:49:37 GMT
x-fapi-customer-ip-address: 92.11.92.11
x-fapi-interaction-id: hook5i13-ntIg-4th3-rP41-3ro535touch3
{
"Data": {
"DebtorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "GB76LOYD30949301273801",
"SecondaryIdentification": "Roll 56988"
},
"ExpirationDateTime": "2017-05-02T00:00:00+00:00"
}
}
# Response
Post Funds Confirmation Consent Response
HTTP/1.1 201 Created
Content-Type: application/json
x-fapi-interaction-id: hook5i13-ntIg-4th3-rP41-3ro535touch3
{
"Data": {
"ConsentId": "88379",
"CreationDateTime": "2017-05-02T00:00:00+00:00",
"Status": "AwaitingAuthorisation",
"StatusUpdateDateTime": "2017-05-02T00:00:00+00:00",
"ExpirationDateTime": "2017-05-02T00:00:00+00:00",
"DebtorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "GB76LOYD30949301273801",
"SecondaryIdentification": "Roll 56988"
}
},
"Links": {
"Self": "https://api.alphabank.com/open-banking/v3.1/cbpii/funds-confirmation-consents/88379"
},
"Meta": {}
}
# GET - Funds Confirmation Consent
# Example with all permitted fields
# Request
GET Funds Confirmation Consent Request
GET /funds-confirmation-consents/88379 HTTP/1.1
Authorization: Bearer Jhingapulaav
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
# Response
GET Funds Confirmation Consent Response
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"ConsentId": "88379",
"CreationDateTime": "2017-05-02T00:00:00+00:00",
"Status": "AwaitingAuthorisation",
"StatusUpdateDateTime": "2017-05-02T00:00:00+00:00",
"ExpirationDateTime": "2017-05-02T00:00:00+00:00",
"DebtorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "GB76LOYD30949301273801",
"SecondaryIdentification": "Roll 56988"
}
},
"Links": {
"Self": "https://api.alphabank.com/open-banking/v3.1/cbpii/funds-confirmation-consents/88379"
},
"Meta": {}
}
# Example with PAN as Account Identification
# Request
GET Funds Confirmation Consent Request
GET /funds-confirmation-consents/88999 HTTP/1.1
Authorization: Bearer a27393fd-12af-4aba-908d-faf042b2a7d9
x-fapi-interaction-id: 80e03097-b808-4557-b5f4-aa820c772e3c
Accept: application/json
# Response
GET Funds Confirmation Consent Response
HTTP/1.1 200 OK
x-fapi-interaction-id: 80e03097-b808-4557-b5f4-aa820c772e3c
Content-Type: application/json
{
"Data": {
"ConsentId": "88999",
"CreationDateTime": "2017-05-02T00:00:00+00:00",
"Status": "AwaitingAuthorisation",
"StatusUpdateDateTime": "2017-05-02T00:00:00+00:00",
"ExpirationDateTime": "2017-05-02T00:00:00+00:00",
"DebtorAccount": {
"SchemeName": "UK.OBIE.PAN",
"Identification": "4444********1111"
}
},
"Links": {
"Self": "https://api.alphabank.com/open-banking/v3.1/cbpii/funds-confirmation-consents/88999"
},
"Meta": {}
}
# DELETE - Funds Confirmation Consent
# Example with all permitted fields
# Request
DELETE Funds Confirmation Consent Request
DELETE /funds-confirmation-consents/88379 HTTP/1.1
Authorization: Bearer Sarsonkasaag
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
# Response
DELETE Funds Confirmation Consent Response
HTTP/1.1 204 No Content
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d