Account access consents

The API specification for "account-access-consents" provided by Algbra's Open Banking API allows Third Party Providers (TPPs) to request and manage access to their customers' account information.

This API supports the creation, retrieval, and revocation of account access consents for customers of participating financial institutions. TPPs can use this API to request access to account information such as balance and transaction history, with the customer's explicit consent.

The API specification includes details on the endpoints, request and response formats, and authentication methods supported by the API.

Create Account Access Consents

POSThttps://secure.tell.systems/algbra/open-banking/v3.1/aisp/account-access-consents

Authorization

TPPOAuth2Security

Header parameters

Body

application/json; charset=utf-8

Default

Data*OBReadData1 (object)

Risk*OBRisk2 (object)

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.

Response

201400401403404405406415429500

Account Access Consents Created

Headers

Body

application/json; charset=utf-8

Data*object

Risk*OBRisk2 (object)

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.

Links*Links (object)

Links relevant to the payload

Meta*MetaData

Meta Data relevant to the payload

Request

JavaScriptCurlPython

const response = await fetch('https://secure.tell.systems/algbra/open-banking/v3.1/aisp/account-access-consents', {
    method: 'POST',
    headers: {
      "x-fapi-financial-id": "ea01566d-f21d-49af-9d0c-b74fbe36911f",
      "Content-Type": "application/json; charset=utf-8"
    },
    body: JSON.stringify({
      "Data": {
        "Permissions": [
          "ReadAccountsBasic"
        ]
      },
      "Risk": {}
    }),
});
const data = await response.json();

Response

201400500

{
  "Data": {
    "ConsentId": "text",
    "CreationDateTime": "2024-11-21T10:07:21.614Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2024-11-21T10:07:21.614Z",
    "Permissions": [
      "ReadAccountsBasic"
    ],
    "ExpirationDateTime": "2024-11-21T10:07:21.614Z",
    "TransactionFromDateTime": "2024-11-21T10:07:21.614Z",
    "TransactionToDateTime": "2024-11-21T10:07:21.614Z"
  },
  "Risk": {},
  "Links": {
    "Self": "https://example.com",
    "First": "https://example.com",
    "Prev": "https://example.com",
    "Next": "https://example.com",
    "Last": "https://example.com"
  },
  "Meta": {
    "FirstAvailableDateTime": "2024-11-21T10:07:21.614Z",
    "LastAvailableDateTime": "2024-11-21T10:07:21.614Z"
  }
}

Get Account Access Consents

GEThttps://secure.tell.systems/algbra/open-banking/v3.1/aisp/account-access-consents/{ConsentId}

Authorization

TPPOAuth2Security

Path parameters

ConsentId*string

ConsentId

Header parameters

Response

200400401403404405406429500

Account Access Consents Read

Headers

Body

application/json; charset=utf-8

Data*object

Risk*OBRisk2 (object)

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.

Links*Links (object)

Links relevant to the payload

Meta*MetaData

Meta Data relevant to the payload

Request

JavaScriptCurlPython

const response = await fetch('https://secure.tell.systems/algbra/open-banking/v3.1/aisp/account-access-consents/{ConsentId}', {
    method: 'GET',
    headers: {
      "x-fapi-financial-id": "ea01566d-f21d-49af-9d0c-b74fbe36911f"
    },
});
const data = await response.json();

Response

200400500

{
  "Data": {
    "ConsentId": "text",
    "CreationDateTime": "2024-11-21T10:07:21.614Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2024-11-21T10:07:21.614Z",
    "Permissions": [
      "ReadAccountsBasic"
    ],
    "ExpirationDateTime": "2024-11-21T10:07:21.614Z",
    "TransactionFromDateTime": "2024-11-21T10:07:21.614Z",
    "TransactionToDateTime": "2024-11-21T10:07:21.614Z"
  },
  "Risk": {},
  "Links": {
    "Self": "https://example.com",
    "First": "https://example.com",
    "Prev": "https://example.com",
    "Next": "https://example.com",
    "Last": "https://example.com"
  },
  "Meta": {
    "FirstAvailableDateTime": "2024-11-21T10:07:21.614Z",
    "LastAvailableDateTime": "2024-11-21T10:07:21.614Z"
  }
}

Delete Account Access Consents

DELETEhttps://secure.tell.systems/algbra/open-banking/v3.1/aisp/account-access-consents/{ConsentId}

Authorization

TPPOAuth2Security

Path parameters

ConsentId*string

ConsentId

Header parameters

Response

204400401403404405406429500

Account Access Consents Deleted

Headers

Request

JavaScriptCurlPython

const response = await fetch('https://secure.tell.systems/algbra/open-banking/v3.1/aisp/account-access-consents/{ConsentId}', {
    method: 'DELETE',
    headers: {
      "x-fapi-financial-id": "ea01566d-f21d-49af-9d0c-b74fbe36911f"
    },
});
const data = await response.json();

Response

400500

{
  "Code": "text",
  "Id": "text",
  "Message": "text",
  "Errors": [
    {
      "ErrorCode": "text",
      "Message": "text",
      "Path": "text",
      "Url": "text"
    }
  ]
}