AISP

As the name suggests, AISP transactions are a core part of Felloh—they represent individual transaction lines in your bank account. These transactions can reflect money either coming into or going out of your accounts. On this page, we’ll explore the various AISP transaction endpoints you can use to manage transactions programmatically.

For more information on how to connect your bank account, check out our guide on linking your bank accounts.

AISP Transaction Model

The AISP transaction model contains all the information about a specific transaction in your bank account, such as the transaction amount, date, description, and the associated account details. It also includes metadata about the transaction type (e.g., credit or debit).

Properties

Name
id
Type
uuid
Description
The unique identifier of the transaction.
Name
amount
Type
number
Description
The amount of the transaction.
Name
currency
Type
string
Description
The currency of the transaction. See the currency documentation.
Name
booking
Type
object
Description
The booking model that the transaction is linked to.
Name
created_at
Type
datetime
Description
The datetime at which the transaction model was created within our systems.
Name
description
Type
string
Description
The description or reference attached to the transaction.
Name
disbursal
Type
object
Description
If the source of the transaction was a disbursal from Felloh, this contains a disbursement model.
Name
is_credit
Type
boolean
Description
Indicates whether the transaction is a credit to the bank account.
Name
is_debit
Type
boolean
Description
Indicates whether the transaction is a debit from the bank account.
Name
posting_date
Type
datetime
Description
The date the transaction was posted to the bank account.
Name
type
Type
string
Description
The type of transaction.
Name
counterparty_name
Type
string
Description
The inferred name of the counterparty for the transaction.
Name
account
Type
object
Description
The AISP account model that the transaction is linked to.

{
    "id": "c2f57815-dd9b-459a-b680-df9f949c0089",
    "amount": 576312,
    "currency": "GBX",
    "created_at": "2024-03-14T17:44:54.457Z",
    "booking": null,
    "description": "Holiday Payment",
    "disbursal": null,
    "is_credit": true,
    "is_debit": false,
    "posting_date": "2024-03-13T00:00:00.000Z",
    "type": "Digital Banking Payment",
    "counterparty_name": "Tom Jones",
    "account": {
        "id": "e460134c-d2ec-49d3-99b4-a4c10e790056",
        "iban": "GB96BARC20032667732163",
        "account_number": "67732163",
        "sort_code": "200326",
        "name": "Barclays main account"
    }
}

AISP Account Model

The AISP Account Model contains all the essential information about a specific bank account, such as the account's IBAN, account number, sort code, and currency. It also includes metadata like the account's current balance, creation timestamp, and any associated nicknames or descriptions, providing a comprehensive view of the account's details for seamless financial management and integration.

Properties

Name
id
Type
uuid
Description
The unique identifier of the entry.
Name
iban
Type
string
Description
The account IBAN.
Name
name
Type
string
Description
The name of the bank account (provided by the banking provider).
Name
nickname
Type
string
Description
The nickname of the bank account.
Name
created_at
Type
datetime
Description
The datetime at which the account model was created within our systems.
Name
account_number
Type
string
Description
The account number on the bank account.
Name
sort_code
Type
string
Description
The name of the bank account.
Name
balance
Type
number
Description
The current balance of the account.
Name
currency
Type
string
Description
The currency of the balance on the account. See the currency documentation.

{
  {
    "id": "e460134c-d2ec-49d3-99b4-a4c10e790056",
    "iban": "GB96BARC20032667732163",
    "name": "Barclays main account",
    "created_at": "2024-03-14T15:37:59.218Z",
    "account_number": "67732163",
    "sort_code": "200326",
    "balance": 9270133,
    "nickname": null,
    "currency": "GBX"
  }
}

GET/aisp/accounts

Fetch All Accounts

This endpoint retrieves all bank accounts associated with the organization.

Parameters

Name
organisationrequired
Type
string
Description
The organization ID for which you want to fetch bank accounts. You can find the organization that you have access to by using the List all organisations method.

Returns

An array of AISP Account Models

Request

GET

/aisp/accounts

import axios from 'axios';

const response = await axios.get('https://api.felloh.com/aisp/accounts', {
  params: { organisation: 'X9876' },
  headers: { 'Content-Type': 'application/json', 'Authorization': `Bearer <YOUR TOKEN HERE>` }
});

Response

{
  "data": [
    {
      "id": "e460134c-d2ec-49d3-99b4-a4c10e790056",
      "iban": "GB96BARC20032667732163",
      "name": "Barclays main account",
      "created_at": "2024-03-14T15:37:59.218Z",
      "account_number": "67732163",
      "sort_code": "200326",
      "balance": 9270133,
      "nickname": null,
      "currency": "GBX"
    }
  ],
  "errors": {},
  "meta": {
    "code": 200,
    "reason": "OK",
    "message": "The request was successful",
    "request_id": "cdd40f5c-9d82-44c2-92e3-b5d2cad364f6",
    "count": 1
  }
}

POST/aisp/transactions

Fetch Transactions

This endpoint allows you to fetch all transactions from your bank accounts.

Parameters

Name
organisationrequired
Type
string
Description
The organization ID that owns the bank account.
Name
skip
Type
integer
Description
Pagination offset.
Name
take
Type
integer
Description
The number of transactions to return.
Name
date_from
Type
date
Description
The starting date to fetch transactions, in ISO 8601 format.
Name
date_to
Type
date
Description
The ending date to fetch transactions, in ISO 8601 format.
Name
type
Type
string
Description
Filter transactions by type, can be 'credit' or 'debit'.
Name
account_iban
Type
string
Description
Filter transactions by a specific AISP account IBAN.

Returns

An array of AISP Transaction Models

Request

POST

/aisp/transactions

import axios from 'axios';

const response = await axios.post(
  'https://api.felloh.com/aisp/transactions', 
  {
    organisation: 'X9876',
    account_iban: 'GB96BARC20032667732163',
    skip: 0,
    take: 20
  },
  {
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer <YOUR TOKEN HERE>`
    }
  }
);

Response

{
  "data": [
    {
      "id": "c2f57815-dd9b-459a-b680-df9f949c0089",
      "amount": 576312,
      "currency": "GBX",
      "created_at": "2024-03-14T17:44:54.457Z",
      "booking": null,
      "description": "Holiday Payment",
      "disbursal": null,
      "is_credit": true,
      "is_debit": false,
      "posting_date": "2024-03-13T00:00:00.000Z",
      "type": "Digital Banking Payment",
      "counterparty_name": "Tom Jones",
      "account": {
          "iban": "GB96BARC20032667732163",
          "account_number": "67732163",
          "sort_code": "200326",
          "name": "Barclays main account"
      }
    }
  ],
  "errors": {},
  "meta": {
    "code": 200,
    "reason": "OK",
    "message": "The request was successful",
    "request_id": "cdd40f5c-9d82-44c2-92e3-b5d2cad364f6",
    "count": 1
  }
}

GET/aisp/statistics

Fetch Accounts Statistics

This endpoint displays statistics about the accounts for an organization.

Parameters

Name
organisationrequired
Type
string
Description
The organization ID you want to fetch statistics for. You can confirm the organizations you have access to by using the List all organisations method.

Returns

Name
accounts
Type
object
Description
An object containing details of AISP accounts linked to your Felloh account
Name
accounts.count
Type
integer
Description
Number of accounts linked to your Felloh Account
Name
accounts.last_sync
Type
datetime
Description
When account information was last synchronised between your bank and Felloh
Name
accounts.items
Type
array
Description
An array of AISP Account Models linked to your Felloh account

Request

GET

/aisp/statistics

import axios from 'axios';

const response = await axios.get('https://api.felloh.com/aisp/statistics', {
  params: {
    organisation: 'X9876'
  },
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer <YOUR TOKEN HERE>`
  }
});

Response

{
  "data": {
    "accounts": {
      "count": 1,
      "last_sync": "2023-01-24T16:12:21.306Z",
      "items": [
        {
          "id": "e460134c-d2ec-49d3-99b4-a4c10e790056",
          "iban": "GB96BARC20032667732163",
          "name": "Barclays main account",
          "created_at": "2024-03-14T15:37:59.218Z",
          "account_number": "67732163",
          "sort_code": "200326",
          "balance": 9270133,
          "nickname": null,
          "currency": "GBX"
        }
      ]
    }
  },
  "errors": {},
  "meta": {
    "code": 200,
    "reason": "OK",
    "message": "The request was successful",
    "request_id": "cdd40f5c-9d82-44c2-92e3-b5d2cad364f6"
  }
}