List transactions

GET

https://integrators.prod.api.tabsplatform.com/v16/transactions

GET

/v16/transactions

$ curl https://integrators.prod.api.tabsplatform.com/v16/transactions \
>      -H "Authorization: <apiKey>"

200Retrieved

1 {
2   "payload": {
3     "data": [
4       {
5         "id": "123e4567-e89b-12d3-a456-426614174000",
6         "amount": 9999,
7         "transactionTime": "2026-06-29T00:00:00.000Z",
8         "description": "ACME CORP ACH CREDIT",
9         "secondaryDescription": "ACME CORP",
10         "status": "OPEN",
11         "remainingBalance": 3999,
12         "appliedAmount": 6000,
13         "externalIds": [
14           {
15             "type": "PLAID",
16             "id": "plaid-txn-abc123"
17           }
18         ],
19         "account": {
20           "id": "123e4567-e89b-12d3-a456-426614174000",
21           "name": "Operating Account",
22           "mask": "1234",
23           "institution": "ins_56",
24           "type": "PLAID",
25           "category": "BANK"
26         },
27         "appliedTo": [
28           {
29             "paymentId": "123e4567-e89b-12d3-a456-426614174000",
30             "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
31             "amountApplied": 6000,
32             "receivedAt": "2026-06-29T00:00:00.000Z"
33           }
34         ],
35         "createdAt": "2026-06-29T00:05:00.000Z"
36       }
37     ],
38     "limit": 1.1,
39     "cursor": "string"
40   },
41   "success": true,
42   "message": "string",
43   "error": {
44     "code": 1.1,
45     "message": "string",
46     "details": {}
47   }
48 }

Returns all merchant transactions page-by-page via an opaque cursor. Sort is fixed (transactionTime desc, id asc).

Authentication

Authorizationstring

API Key authentication via header

Query parameters

cursorstringOptional

Opaque cursor from a previous response. Omit for the first page.

limitdoubleOptionalDefaults to 50

Page size (default 50, max 100)

sortDirenumOptionalDefaults to desc

Sort direction

Allowed values:

sortstringOptional

Field to sort by

filterstringOptional

Format: field:rule:value — comma-separated for multiple filters.

Fields: transactionTime (datetime): eq, neq, gt, gte, lt, lte status (string): eq, neq, in, nin accountId (uuid): eq, neq, in, nin, isnull, isnotnull hasRemainingBalance (boolean): eq, neq externalId (string): eq, neq, like, nlike, in, nin, isnull, isnotnull

Date-only values (YYYY-MM-DD) match the full UTC day.

Example: filter=transactionTime:gte:2026-01-01

“status” accepts OPEN, CLOSED, EXCLUDED. “externalId” matches the bank (e.g. Plaid) transaction id. “hasRemainingBalance” accepts true/false and reflects whether the transaction still has funds to apply (neq inverts the boolean).

Format: field:rule:value — comma-separated for multiple filters. Fields: transactionTime (datetime): eq, neq, gt, gte, lt, lte status (string): eq, neq, in, nin accountId (uuid): eq, neq, in, nin, isnull, isnotnull hasRemainingBalance (boolean): eq, neq externalId (string): eq, neq, like, nlike, in, nin, isnull, isnotnull Date-only values (YYYY-MM-DD) match the full UTC day. Example: filter=transactionTime:gte:2026-01-01 "status" accepts OPEN, CLOSED, EXCLUDED. "externalId" matches the bank (e.g. Plaid) transaction id. "hasRemainingBalance" accepts true/false and reflects whether the transaction still has funds to apply (neq inverts the boolean).

Response

Get all transactions by filter

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject

json element with any error messages or warnings