Funds Confirmation Consent - v3.1.3

1. Overview
2. Endpoints
   1. POST /funds-confirmation-consents
      1. Funds Confirmation Consent Status
      2. Status Flow
   2. GET /funds-confirmation-consents/{ConsentId}
      1. Funds Confirmation Consent Status
   3. DELETE /funds-confirmation-consents/{ConsentId}
3. Data Model
   1. Funds Confirmation Consent - Request
      1. UML Diagram
      2. Data Dictionary
   2. Funds Confirmation Consent - Response
      1. UML Diagram
      2. Data Dictionary
   3. Data Payload - Enumerations
4. Usage Examples
   1. POST - Funds Confirmation Consent
      1. Example with all permitted fields
         1. Request
         2. Response
   2. GET - Funds Confirmation Consent
      1. Example with all permitted fields
         1. Request
         2. Response
   3. DELETE - Funds Confirmation Consent
      1. Example with all permitted fields
         1. Request
         2. Response

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

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:

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

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:

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

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

Data Payload - Enumerations

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

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": {}
}

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