List Bank Transactions (Business-scoped)

curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-transactions/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-transactions/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-transactions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-transactions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-transactions/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-transactions/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "date": "2024-03-28",
      "amount": 450000,
      "display_amount": "£4,500.00",
      "signed_amount": 450000,
      "direction": "credit",
      "currency": "GBP",
      "counterparty_name": "The Red Lion Pub Ltd",
      "merchant_name": "The Red Lion Pub Ltd",
      "description": "Payment for Invoice INV-0042",
      "categorization_status": "categorized",
      "transaction_type": "fps",
      "subcategory": {
        "id": "cat-001",
        "code": "INCOME_SALES",
        "name": "Sales Revenue",
        "category": {
          "id": "parent-001",
          "code": "INCOME",
          "name": "Income"
        }
      },
      "business_id": "7d70c3cc-4g88-8f04-cccc-cgg69180406e",
      "business_name": "Premium Breweries Ltd",
      "account_id": "acc-1000",
      "account_code": "1000",
      "account_name": "Bank - Barclays Current",
      "bank_account_connection_id": "9f90c3cc-6i00-0h16-eeee-eii81402618g",
      "bank_account_name": "Barclays Business Current Account",
      "bank_account_mask": "1234",
      "bank_account_currency": "GBP",
      "is_reconciled": true,
      "reconciled_at": "2024-03-28T10:15:00Z",
      "reconciled_amount_cents": 450000,
      "remaining_amount_cents": 0,
      "reconciliations": null,
      "created_at": "2024-03-28T10:05:00Z"
    }
  ]
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

Bank Transactions

List Bank Transactions (Business-scoped)

Retrieve a paginated list of bank transactions for a specific business with advanced filtering options.

Authentication:

Requires business-scoped Bearer token (ScopedBusinessTokenAuthentication)
Token business_id must match the business_id in the path

Default Behavior:

Returns bank transactions for the business in the URL path
Uses summary serializer for list view (lighter payload)

Filtering Options:

Account Filters:

account_id: Filter by mapped account ID
bank_account_connection_id: Filter by bank account connection

Date Filters:

date_from: Transactions from this date (ISO 8601 format)
date_to: Transactions to this date (ISO 8601 format)

Transaction Filters:

direction: Filter by direction (credit/debit)
categorization_status: Filter by categorization status (supports multiple values)
transaction_type: Filter by transaction type (one of: fps, bacs, chaps, direct_debit, standing_order, sepa_credit, sepa_debit, sepa_instant, card_payment, atm_withdrawal, bank_transfer, fee, interest, other)
source: Filter by transaction source
currency: Filter by currency (GBP, EUR, USD)

Amount Filters:

amount_min: Minimum transaction amount in cents
amount_max: Maximum transaction amount in cents

Status Filters:

is_reconciled: Filter by reconciliation status
needs_categorization: Filter transactions needing categorization
is_categorized: Filter categorized transactions
has_parent: Filter split transactions
has_children: Filter transactions with splits

Search:

search: Search across description, counterparty, merchant, and reference

Ordering:

ordering: Order by any field (prefix with ’-’ for descending)
Default: -date, -created_at (newest first)

Examples:

Get credit transactions: ?direction=credit
Get pending categorization: ?categorization_status=pending
Get multiple statuses: ?categorization_status=pending&categorization_status=manual_review
Get transactions for date range: ?date_from=2025-01-01&date_to=2025-01-31
Search transactions: ?search=amazon
Filter by amount: ?amount_min=10000&amount_max=100000 (amounts in cents)

GET

platform

businesses

{business_id}

bank-transactions

List Bank Transactions (Business-scoped)

curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-transactions/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-transactions/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-transactions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-transactions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-transactions/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-transactions/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "date": "2024-03-28",
      "amount": 450000,
      "display_amount": "£4,500.00",
      "signed_amount": 450000,
      "direction": "credit",
      "currency": "GBP",
      "counterparty_name": "The Red Lion Pub Ltd",
      "merchant_name": "The Red Lion Pub Ltd",
      "description": "Payment for Invoice INV-0042",
      "categorization_status": "categorized",
      "transaction_type": "fps",
      "subcategory": {
        "id": "cat-001",
        "code": "INCOME_SALES",
        "name": "Sales Revenue",
        "category": {
          "id": "parent-001",
          "code": "INCOME",
          "name": "Income"
        }
      },
      "business_id": "7d70c3cc-4g88-8f04-cccc-cgg69180406e",
      "business_name": "Premium Breweries Ltd",
      "account_id": "acc-1000",
      "account_code": "1000",
      "account_name": "Bank - Barclays Current",
      "bank_account_connection_id": "9f90c3cc-6i00-0h16-eeee-eii81402618g",
      "bank_account_name": "Barclays Business Current Account",
      "bank_account_mask": "1234",
      "bank_account_currency": "GBP",
      "is_reconciled": true,
      "reconciled_at": "2024-03-28T10:15:00Z",
      "reconciled_amount_cents": 450000,
      "remaining_amount_cents": 0,
      "reconciliations": null,
      "created_at": "2024-03-28T10:05:00Z"
    }
  ]
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

Business-scoped JWT token. Token payload includes business_id to automatically scope requests. Format: Bearer <your-jwt-token>

Use this for: Business-specific operations where the business context is embedded in the token.

Path Parameters

business_id

string

required

Business ID (UUID format) in path

Query Parameters

account_id

string

Filter by mapped account ID (UUID format)

amount_max

integer

Filter by maximum amount in cents

amount_min

integer

Filter by minimum amount in cents

approval_status

enum<string>[]

Filter by approval status (supports multiple values: ?approval_status=pending_approval&approval_status=ai_approved)

pending_approval - Pending Approval
ai_approved - AI Approved
approved - Approved

Available options:

ai_approved,

approved,

pending_approval

bank_account_connection_id

string

Filter by bank account connection ID (UUID format)

business_id

string<uuid>

Filter by business ID

categorization_status

enum<string>

Filter by categorization status (supports multiple values)

Available options:

approved,

categorized,

manual_review,

pending

category_code

string

Filter by category code

category_id

string<uuid>

Filter by category ID

currency

enum<string>

Filter by currency

Available options:

EUR,

GBP,

USD

date_from

string

Filter transactions from this date (ISO 8601 format)

date_to

string

Filter transactions to this date (ISO 8601 format)

direction

enum<string>

Filter by transaction direction

Available options:

credit,

debit

has_children

boolean

Filter transactions that have child splits

has_parent

boolean

Filter transactions that are split from parent

is_categorized

boolean

Filter transactions that are categorized

is_reconciled

boolean

Filter by reconciliation status

needs_categorization

boolean

Filter transactions that need categorization

ordering

string

Order by field (prefix with - for descending)

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

string

Search in description, counterparty, merchant, and reference

source

enum<string>

Filter by transaction source

Available options:

api,

csv_import,

manual,

open_banking,

plaid

subcategory_code

string

Filter by subcategory code

subcategory_id

string<uuid>

Filter by subcategory ID

transaction_type

enum<string>

Filter by transaction type

Available options:

atm_withdrawal,

bacs,

bank_transfer,

card_payment,

chaps,

direct_debit,

fee,

fps,

interest,

other,

sepa_credit,

sepa_debit,

sepa_instant,

standing_order

Response

count

integer

required

Total number of items

Example:

123

page_info

object

required

Show child attributes

Example:

{
  "total_count": 123,
  "current_page": 1,
  "total_pages": 7,
  "page_size": 20
}

results

object[]

required

Show child attributes

Managing Businesses

Importing Business Activity

Financial Reports

List Bank Transactions (Business-scoped)

Authorizations

Path Parameters

Query Parameters

Response