v1

latestOpenAPI 3.0.0Apache 2.02026-07-244385400.4 KB

Transactions

List Transactions for a Customer

Returns a list of transactions for a customer. The list is sorted by data source, with transactions from bank statements listed first, followed by transactions from open banking data. Within each of the data sources, the transactions are ordered by creation date, with the most recently created transactions appearing first. Most query parameters should be passed only once for filtering. However, there are two exceptions:

category: This parameter can be passed multiple times to filter transactions by category.
data_source: This parameter can also be passed multiple times to filter transactions by data source.

Please refer to the individual parameter descriptions for more details on usage.

get/customers/{customer_id}/transactions

Path parameters

customer_idstring uuid required

The Inscribe customer id.

Query parameters

sizeinteger required

Set the number of transactions to be returned by request.

cursorstring uuid

Send a cursor to retrieve the next set of transactions, starting after the cursor. If no cursor is sent, the first set of transactions will be returned.

transaction_idsstring

Filter transactions to include only those with the specified transaction IDs. To filter by multiple transaction IDs, separate each ID with a comma (,). For example, transaction_ids=uuid1,uuid2.

document_idsstring

Filter transactions to include only those from the specified document IDs. To filter by multiple document IDs, separate each ID with a comma (,). For example, document_ids=uuid1,uuid2. No transactions from open banking data will be returned unless you explicitly request them using the open_banking_data_ids parameter.

document_pagesstring

Filter transactions to include only those that exist on specific pages of documents. To filter by multiple pages, separate each page number with a comma (,). For examples, document_pages=1,2. No transactions from open banking data will be returned unless you explicitly request them using the open_banking_data_ids parameter.

open_banking_data_idsstring

Filter transactions to include only those from the specified open banking data uploads. To filter by multiple open banking data uploads, separate each ID with a comma (,). For example, open_banking_data_ids=uuid1,uuid2. No transactions from documents will be returned unless you explicitly request them using the document_ids parameter.

searchstring

Filter transactions where the description or merchant contains the specified search term.

sort_by'amount' | 'category' | 'date' | 'merchant'

Specify the field by which transactions should be sorted.

sort_direction'asc' | 'desc'

Choose between 'ascending' or 'descending' to define the sorting order.

start_datestring date

Filter transactions to include only those with a date greater than or equal to the specified start date.

end_datestring date

Filter transactions to include only those with a date less than the specified end date.

min_amountinteger

Filter transactions to include only those with an amount greater than or equal to the specified minimum amount.

max_amountinteger

Filter transactions to include only those with an amount less than the specified maximum amount.

data_source'BANK_STATEMENT' | 'OPEN_BANKING'

Set a data source by which to filter transactions. Only transactions in this data source will be returned. If no data source is set, all transactions will be returned.

Set a category by which to filter transactions. Only transactions in this category will be returned. If no category is set, all transactions will be returned.

include_unreconciled_documentsboolean

Unreconciled bank statements are statements where the difference between the parsed opening and closing balances is not explained by the sum of the parsed transaction amounts. Statements are typically unreconciled if the uploaded document has poor quality or is missing some of its original pages. It can also happen when the parsing models fail to parse and extract all relevant data. If this parameter is set to False, unreconciled bank statements will be excluded from the credit insights. This parameter defaults to True, keeping all documents included.

Response

Returns back a list of Transaction objects.

Example response

{
  "data": [
    {
      "id": "0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
      "date": "2022-07-25",
      "description": "Deposit",
      "amount": 860000,
      "currency_code": "USD",
      "category": "REVENUE",
      "method": "BANK_TRANSFER",
      "vendor": "Smith & Sons",
      "merchant": "Smith & Sons",
      "data_source": "BANK_STATEMENT",
      "guid": "123e4567-e89b-12d3-a456-426614174001"
    },
    {
      "id": "3efae611-b3eb-5b84-9ed1-a3e93ad4bf6c",
      "date": "2022-07-28",
      "description": "NSF fee on account",
      "amount": -3500,
      "currency_code": "USD",
      "category": "NSF",
      "method": "BANK_TRANSFER",
      "vendor": null,
      "merchant": null,
      "data_source": "BANK_STATEMENT",
      "guid": "123e4567-e89b-12d3-a456-426614174002"
    },
    {
      "id": "4efae611-b3eb-5b84-9ed1-a3e93ad4bf6c",
      "date": "2022-07-30",
      "description": "Chase ATM withdrawal from account",
      "amount": -50000,
      "currency_code": "USD",
      "category": "WITHDRAWAL",
      "method": "CASH",
      "vendor": "CHASE",
      "merchant": "CHASE",
      "data_source": "BANK_STATEMENT",
      "guid": "123e4567-e89b-12d3-a456-426614174003"
    }
  ],
  "pagination": {
    "cursor": "9361c7fb-934b-4cac-8e07-4897e590ab94"
  },
  "metadata": {
    "customer_contains_low_trust_score_documents": false,
    "included_data_sources": {
      "documents": [
        {
          "document_id": "e959ed48-a9e4-44f3-a6f8-b9dddd21f27c"
        }
      ],
      "open_banking": []
    },
    "excluded_data_sources": {
      "documents": [
        {
          "document_id": "1ae90a8e-8126-41aa-9b01-1d80e2e0817d",
          "exclusion_reason": "UNRECONCILED_BANK_ACCOUNT"
        }
      ],
      "open_banking": []
    },
    "query_parameters": {}
  }
}