Skip to main content
GET
/
api
/
banking
/
recognized
Get a list of recognized transactions
curl --request GET \
  --url https://api.example.com/api/banking/recognized \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'
import requests

url = "https://api.example.com/api/banking/recognized"

headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>"
}

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

print(response.text)
const options = {
method: 'GET',
headers: {Authorization: '<authorization>', 'organization-id': '<organization-id>'}
};

fetch('https://api.example.com/api/banking/recognized', 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://api.example.com/api/banking/recognized",
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: <authorization>",
"organization-id: <organization-id>"
],
]);

$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://api.example.com/api/banking/recognized"

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

req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/banking/recognized")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/banking/recognized")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'

response = http.request(request)
puts response.read_body
{
  "pagination": {
    "total": 100,
    "page": 1,
    "pageSize": 10
  },
  "data": [
    {
      "uncategorizedTransactionId": 123,
      "referenceNo": "TRX-2024-001",
      "description": "Payment for invoice #123",
      "payee": "John Doe",
      "amount": 1500.75,
      "formattedAmount": "$1,500.75",
      "date": "2024-04-01",
      "formattedDate": "Apr 1, 2024",
      "assignedAccountId": 10,
      "assignedAccountName": "Bank Account",
      "assignedAccountCode": "1001",
      "assignedPayee": "Jane Smith",
      "assignedMemo": "Office supplies",
      "assignedCategory": "Office Expenses",
      "assignedCategoryFormatted": "Other Income",
      "withdrawal": 500,
      "deposit": 1000,
      "isDepositTransaction": true,
      "isWithdrawalTransaction": false,
      "formattedDepositAmount": "$1,000.00",
      "formattedWithdrawalAmount": "$500.00",
      "bankRuleId": "BR-001",
      "bankRuleName": "Salary Rule"
    }
  ]
}

Headers

Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Query Parameters

Response

200 - application/json

Returns a list of recognized transactions

pagination
object
required

Pagination metadata

data
object[]