Acquirer Settlement

This object represents settlement (batch) data from one (or more) merchant acquirers.

Batch Model

Properties

Name
id
Type
string
Description
Unique identifier for the batch.
Name
bank_reference
Type
string
Description
Unique reference for the batch attatched to the transaction in bank.
Name
amount
Type
integer
Description
The value of the batch
Name
currency
Type
string
Description
The currency of the batch | see currency documentation.
Name
payment_provider.id
Type
string
Description
Unique identifier for the payment provider that the batch was fo
Name
payment_provider.name
Type
string
Description
The name of the payment provider
Name
payment_provider.payment_method
Type
string
Description
The payment method used for the payment provider
Name
adjustments
Type
array
Description
An array of adjustments linked to the batch
Name
adjustments[].id
Type
string
Description
Unique identifier of the adjustment
Name
adjustments[].amount
Type
integer
Description
Unique identifier of the adjustment
Name
adjustments[].currency
Type
string
Description
The currency of the adjustment | see currency documentation.
Name
adjustments[].description
Type
string
Description
Description of what the adjustment was for
Name
adjustments[].created_at
Type
datetime
Description
The datetime at which the adjustment was created within our systems.
Name
adjustments[].updated_at
Type
datetime
Description
The datetime at which the adjustment was last updated within our systems.
Name
transaction_settlements
Type
array
Description
An array of transactions linked to the batch
Name
transaction_settlements[].transaction
Type
object
Description
An object containing compact versions of the transaction models linked to the batch.
Name
transaction_settlements[].found_in_felloh_managed_trust
Type
array
Description
Whether the transaction has been settled to the felloh managed trust (only applicable if using the felloh managed trust).
Name
transaction_settlements[].found_in_customer_account
Type
array
Description
Whether the transaction has been settled to your bank account (only applicable if using AISP Open Banking connection).
Name
transaction_settlements[].created_at
Type
datetime
Description
The datetime at which the transaction was created within our systems.
Name
transaction_settlements[].updated_at
Type
datetime
Description
The datetime at which the transaction was last updated within our systems.

{
    "id": "11c66ec2-3c3d-4d00-ad10-18ba107918b4",
    "bank_reference": "5142077333333",
    "amount": 54000,
    "posting_date": "2025-04-12",
    "currency": "GBX",
    "payment_provider": {
        "id": "62d41710-c70e-484b-a750-17bc42d10209",
        "name": "TOTAL_PROCESSING",
        "payment_method": "CARD"
    },
    "adjustments": [
        {
            "id": "6a9731ff-8b97-4dba-9f45-9382bafc4d57",
            "amount": -6000,
            "currency": "GBX",
            "description": "Chargeback - Purchase",
            "created_at": "2025-04-14T14:00:32.244Z",
            "updated_at": "2025-04-14T14:00:32.244Z"
        }
    ],
    "transaction_settlements": [
        {
            "transaction": {
                "id": "659ee1eb-1b87-4cdb-a6ad-94291a31d001",
                "amount": 60000,
                "booking": {
                    "id": "068ebfa9-4be1-402a-a650-69751e37e559",
                    "gross_amount": 127600,
                    "currency": "GBX",
                    "email": "karren@felloh.com",
                    "customer_name": "Karren Bicknell",
                    "booking_reference": "TEST101",
                    "departure_date": "2025-06-19",
                    "return_date": "2025-06-26",
                    "created_at": "2025-04-12T13:59:42.974Z",
                    "updated_at": "2025-04-12T22:38:30.032Z",
                    "deleted_at": null,
                    "is_temporary": false,
                    "atol_receipt_number": null
                },
                "status": {
                    "id": "COMPLETE"
                },
                "method": {
                    "id": "MOTO_IN_PERSON",
                },
                "type": {
                    "id": "CARD",
                },
                "provider_reference": "asdkoscjmcidsamskcmkm123mkm2ekmca",
                "currency": "GBX",
                "provider_metadata": null,
                "completed_at": "2025-04-12T14:01:13.000Z",
                "message": "Transaction succeeded",
                "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36",
                "ip_address": "14.140.184.250",
                "fingerprint": "2430317359",
                "created_at": "2025-04-12T14:01:14.487Z",
                "updated_at": "2025-04-12T14:01:16.138Z",
                "assigned_at": "2025-04-12T14:01:14.461Z"
            },
            "amount": 60000,
            "currency": "GBX",
            "created_at": "2025-04-14T13:33:05.543Z",
            "updated_at": "2025-04-14T13:33:05.543Z"
        }
    ],
    "found_in_felloh_managed_trust": true,
    "found_in_customer_account": false,
    "created_at": "2025-04-14T13:33:05.095Z",
    "updated_at": "2025-04-14T13:33:05.095Z"
}

POST/bank/batch

Fetch All

This endpoint retrieves all batches. Batches are sorted by most recent date.

Parameters

Name
organisationrequired
Type
string
Description
The organisation ID that you want to fetch batches for. You can find the organisation that you have access to by using the List all organisations method.
Name
skip
Type
integer
Description
See the pagination section for details.
Name
take
Type
integer
Description
See the pagination section for details.

Returns

An array of Batches

Request

POST

/bank/batch

import axios from 'axios';

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

Response

{
  "data": [
    {
        "id": "01128bc3-c98c-422c-8360-84f4d21c3f52",
        "bank_reference": "43434343",
        "amount": 3496896,
        "posting_date": "2025-04-16",
        "currency": "GBX",
        "payment_provider": {
            "id": "62d41710-c70e-484b-a750-17bc42d10209",
            "name": "TOTAL_PROCESSING"
        },
        "adjustment_count": 1,
        "transaction_count": 37
    }
  ],
  "errors": {},
  "meta": {
    "code": 200,
    "reason": "OK",
    "message": "The request was successful",
    "request_id": "cdd40f5c-9d82-44c2-92e3-b5d2cad364f6",
    "count": 1
  }
}

POST/bank/batch/:batch_id

Fetch One

This endpoint allows you to retrieve a single batch by its ID.

Path Parameters

Name
batch_id
Type
uuid
Description
The btach ID you wish to retrieve.

Returns

Returns a batch model

Request

POST

/bank/batch/:batch_id

import axios from 'axios';

const batchID = '919c9dba-0102-11ed-b939-0242ac120002';

const response = await axios.post(
  `https://api.felloh.com/bank/batch/:batch_id`,
  {
    headers: { 'Content-Type': 'application/json', 'Authorization': `Bearer <YOUR TOKEN HERE>` }
  }
);

Response

{
  "data": {
    "id": "11c66ec2-3c3d-4d00-ad10-18ba107918b4",
    "bank_reference": "5142077333333",
    "amount": 54000,
    "posting_date": "2025-04-12",
    "currency": "GBX",
    "payment_provider": {
        "id": "62d41710-c70e-484b-a750-17bc42d10209",
        "name": "TOTAL_PROCESSING",
        "payment_method": "CARD"
    },
    "adjustments": [
        {
            "id": "6a9731ff-8b97-4dba-9f45-9382bafc4d57",
            "amount": -6000,
            "currency": "GBX",
            "description": "Chargeback - Purchase",
            "created_at": "2025-04-14T14:00:32.244Z",
            "updated_at": "2025-04-14T14:00:32.244Z"
        }
    ],
    "transaction_settlements": [
        {
            "transaction": {
                "id": "659ee1eb-1b87-4cdb-a6ad-94291a31d001",
                "amount": 60000,
                "booking": {
                    "id": "068ebfa9-4be1-402a-a650-69751e37e559",
                    "gross_amount": 127600,
                    "currency": "GBX",
                    "email": "karren@felloh.com",
                    "customer_name": "Karren Bicknell",
                    "booking_reference": "TEST101",
                    "departure_date": "2025-06-19",
                    "return_date": "2025-06-26",
                    "created_at": "2025-04-12T13:59:42.974Z",
                    "updated_at": "2025-04-12T22:38:30.032Z",
                    "deleted_at": null,
                    "is_temporary": false,
                    "atol_receipt_number": null
                },
                "status": {
                    "id": "COMPLETE"
                },
                "method": {
                    "id": "MOTO_IN_PERSON",
                },
                "type": {
                    "id": "CARD",
                },
                "provider_reference": "asdkoscjmcidsamskcmkm123mkm2ekmca",
                "currency": "GBX",
                "provider_metadata": null,
                "completed_at": "2025-04-12T14:01:13.000Z",
                "message": "Transaction succeeded",
                "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36",
                "ip_address": "14.140.184.250",
                "fingerprint": "2430317359",
                "created_at": "2025-04-12T14:01:14.487Z",
                "updated_at": "2025-04-12T14:01:16.138Z",
                "assigned_at": "2025-04-12T14:01:14.461Z"
            },
            "amount": 60000,
            "currency": "GBX",
            "created_at": "2025-04-14T13:33:05.543Z",
            "updated_at": "2025-04-14T13:33:05.543Z"
        }
    ],
    "found_in_felloh_managed_trust": true,
    "found_in_customer_account": false,
    "created_at": "2025-04-14T13:33:05.095Z",
    "updated_at": "2025-04-14T13:33:05.095Z"
  },
  "errors": {},
  "meta": {
    "code": 200,
    "reason": "OK",
    "message": "The request was successful",
    "request_id": "cdd40f5c-9d82-44c2-92e3-b5d2cad364f6"
  }
}