Skip to main content
POST
/
v6
/
payments
/
query
Query payments
curl --request POST \
  --url https://sandbox.tight.com/v6/payments/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cursor": "<string>",
  "limit": 123,
  "sort": {
    "orderBy": "DISPLAY_NAME",
    "direction": "ASC"
  },
  "filter": {
    "displayName": {
      "equal": "<string>",
      "notEqual": "<string>",
      "greaterThan": "<string>",
      "greaterThanEqual": "<string>",
      "lessThan": "<string>",
      "lessThanEqual": "<string>",
      "contain": "<string>"
    },
    "status": {
      "in": [
        "ACTIVE"
      ],
      "notIn": [
        "ACTIVE"
      ],
      "equal": "ACTIVE",
      "notEqual": "ACTIVE",
      "greaterThan": "ACTIVE",
      "greaterThanEqual": "ACTIVE",
      "lessThan": "ACTIVE",
      "lessThanEqual": "ACTIVE"
    }
  }
}
'
{
  "result": "SUCCESS",
  "data": [
    {
      "id": "pmt_158998869",
      "type": "EXPENSE",
      "date": "2025-06-26",
      "amount": 273479,
      "displayName": "Gusto",
      "description": "WITHDRAWAL ACH GUSTO TAXID: 4001",
      "notes": "June Payroll",
      "status": "ACTIVE",
      "reviewStatus": "RECONCILED",
      "apiName": "PLAID",
      "apiSourceId": "QeXqN7XJT50dwE4S19ZgVv4nnhLvjX7",
      "bankAccount": {
        "id": "bka_7542850",
        "name": "Business Checking **1687",
        "displayName": "Business Checking **1687"
      },
      "classSegments": [
        {
          "id": "cls_593051",
          "label": {
            "id": "cll_4521",
            "name": "Region",
            "requiredness": "NOT_REQUIRED"
          },
          "name": "Mid-Atlantic",
          "child": {
            "id": "cls_593052",
            "label": {
              "id": "cll_4521",
              "name": "Region",
              "requiredness": "NOT_REQUIRED"
            },
            "name": "Washington DC",
            "child": "<unknown>"
          }
        }
      ],
      "customer": {
        "id": "cus_4852707",
        "name": "Abigail Adams",
        "email": "abigail@tight.com"
      },
      "vendor": {
        "id": "vnd_28868401",
        "name": "Gusto"
      },
      "category": {
        "id": "ctg_58932890",
        "name": "Wages",
        "iconUrl": "https://cdn.sandbox.tight.com/icons/expenseCategories/payroll.svg"
      },
      "glAccount": {
        "id": "gla_38560327",
        "name": "Officer(s) Salaries and Wages",
        "accountNo": "60210",
        "type": "EXPENSE",
        "iconUrl": "https://cdn.sandbox.tight.com/icons/glAccountTypes/expense.png"
      },
      "reconciliationMatch": {
        "id": "<string>",
        "apiSourceId": "<string>",
        "amount": 123,
        "date": "2023-12-25",
        "description": "<string>",
        "apiName": "BOX",
        "apiInstitutionId": "<string>"
      },
      "children": [
        {
          "id": "itm_349412",
          "type": "EXPENSE",
          "amount": -134051,
          "displayName": "Gusto",
          "description": "WITHDRAWAL ACH GUSTO TAXID: 4001",
          "apiItemId": "<string>",
          "classSegments": [
            {
              "id": "cls_593051",
              "label": {
                "id": "cll_4521",
                "name": "Region",
                "requiredness": "NOT_REQUIRED"
              },
              "name": "Mid-Atlantic",
              "child": {
                "id": "cls_593052",
                "label": {
                  "id": "cll_4521",
                  "name": "Region",
                  "requiredness": "NOT_REQUIRED"
                },
                "name": "Washington DC",
                "child": "<unknown>"
              }
            }
          ],
          "customer": {
            "id": "cus_4852707",
            "name": "Abigail Adams",
            "email": "abigail@tight.com"
          },
          "vendor": {
            "id": "vnd_28868401",
            "name": "Gusto"
          },
          "category": {
            "id": "ctg_58932890",
            "name": "Wages",
            "iconUrl": "https://cdn.sandbox.tight.com/icons/expenseCategories/payroll.svg"
          },
          "glAccount": {
            "id": "gla_38560327",
            "name": "Officer(s) Salaries and Wages",
            "accountNo": "60210",
            "type": "EXPENSE",
            "iconUrl": "https://cdn.sandbox.tight.com/icons/glAccountTypes/expense.png"
          },
          "reconciliationMatch": {
            "id": "<string>",
            "apiSourceId": "<string>",
            "amount": 123,
            "date": "2023-12-25",
            "description": "<string>",
            "apiName": "BOX",
            "apiInstitutionId": "<string>"
          }
        }
      ],
      "customData": {
        "internal_key": "some_internal_key",
        "some_other_field": 23434
      }
    }
  ],
  "cursor": {
    "after": "<string>",
    "before": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, see Authentication for more detail.

Body

application/json
cursor
string | null

Cursor from the previous paginated response

limit
integer<int32>

Page size, i.e. number of items to return per page

Required range: x <= 250
sort
object

Sort order for the items in the response.

filter
object

Filter for items in the response.

Response

Success

result
enum<string>

The result of the action performed.

Available options:
SUCCESS,
FAILURE
data
object[]

The data generated by the action performed.

cursor
object

Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.