POST /transactions/search — fragment-payments-api

Transactions

Searches transactions.

post/transactions/search

Request body

Example request

{
  "filter": {
    "account": {
      "any": [
        {
          "id": "ext_account_YWJjMTIz",
          "external_id": "acct_external_123"
        }
      ]
    },
    "tags": {
      "any": [
        {
          "key": "department",
          "value": "eng*"
        }
      ],
      "all": [
        {
          "key": "department",
          "value": "engineering"
        }
      ]
    },
    "reconciliation_status": "unreconciled"
  },
  "page_info": {
    "limit": 20
  }
}

Response

Success

Example response

{
  "data": [
    {
      "id": "txn_dHhuX2ZyYWdfMDAx",
      "external_id": "bank_txn_123",
      "account": {
        "id": "ext_account_YWJjMTIz",
        "external_id": "acct_external_123"
      },
      "posted": "2024-01-13T00:00:00Z",
      "currency": "USD",
      "amount": "-1000",
      "allocations": [
        {
          "invoice_id": "inv_abc123",
          "amount": "1000",
          "type": "invoice_payin",
          "user": {
            "id": "user_abc123",
            "external_id": "user_ext_001"
          }
        }
      ],
      "tags": [
        {
          "key": "department",
          "value": "engineering"
        }
      ],
      "unallocated_amount": "-1000",
      "created": "2024-01-13T00:00:00Z",
      "modified": "2024-01-13T00:00:00Z",
      "version": 1
    }
  ],
  "data_v2": {
    "transactions": [
      {
        "id": "txn_dHhuX2ZyYWdfMDAx",
        "external_id": "bank_txn_123",
        "account": {
          "id": "ext_account_YWJjMTIz",
          "external_id": "acct_external_123"
        },
        "posted": "2024-01-13T00:00:00Z",
        "currency": "USD",
        "amount": "-1000",
        "allocations": [
          {
            "invoice_id": "inv_abc123",
            "amount": "1000",
            "type": "invoice_payin",
            "user": {
              "id": "user_abc123",
              "external_id": "user_ext_001"
            }
          }
        ],
        "tags": [
          {
            "key": "department",
            "value": "engineering"
          }
        ],
        "unallocated_amount": "-1000",
        "created": "2024-01-13T00:00:00Z",
        "modified": "2024-01-13T00:00:00Z",
        "version": 1
      }
    ]
  }
}

Changes

Changed in 5 of the 38 revisions of this API.122

Jun 19, 202641ca2c6860121See the full diff
- ○
  added the new optional request property filter/reconciliation_status
  new-optional-request-property
Apr 14, 20268472a9bd15ea118See the full diff
- ▲
  the data/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ○
  added the new optional request property filter/tags
  new-optional-request-property
- ○
  added the new optional request property page_info
  new-optional-request-property
- ○
  the request property filter/account became optional
  request-property-became-optional
- ○
  added the optional property data/items/modified to the response with the 200 status
  response-optional-property-added
- ○
  removed Transaction subschema #2 from the data/items/ response property allOf list for the response status 200
  response-property-all-of-removed
- ○
  response property data deprecated
  response-property-deprecated
- ○
  added the required property data/items/account to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/allocations to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/amount to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/created to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/currency to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/external_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/posted to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/tags to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/unallocated_amount to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/version to the response with the 200 status
  response-required-property-added
- ○
  added the required property data_v2 to the response with the 200 status
  response-required-property-added
This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 27, 20261ac1d5e34a8f1See the full diff
- ○
  added UpdateAllocationDiffEntry to the data/items/allOf[subschema #2]/diff/items/ response property anyOf list for the response status 200
  response-property-any-of-added
Mar 18, 2026249df29a7dfe1See the full diff
- ○
  added the required property data/items/allOf[Transaction]/tags to the response with the 200 status
  response-required-property-added
Mar 12, 2026930de445f98d1See the full diff
- ○
  endpoint added
  endpoint-added

Full history