Search customer transactions.

Finds the most relevant transactions matching the user_input text.

An initial free text search will then suggest suggested_searches which use structured data e.g. category_l1 or merchant_name.

At most one of the following query parameters can be used per request, if multiple are set the endpoint will return a Bad Request response (if none are set, transactions will be returned with no filtering to facilitate showing an initial transaction list to the user):

  • user_input
  • merchant_name
  • category_l1
  • category_l2
  • description
  • tag

This endpoint also provides a link to view an AI-generated insight about the current search. Please wait for the allotted insight.url_delay before following this link to avoid unnecessary polling before the insight has been generated.

Language
Credentials
OAuth2