latestOpenAPI 3.0.12026-07-26222700728.0 KB

e9f0790a89af

Payments

Query payments

Query payments for the authenticated user

post/v6/payments/query

Request body

cursorstring nullable

Cursor from the previous paginated response

limitinteger

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

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": [
    {
      "id": "ptxn_158998869",
      "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",
        "displayName": "Business Checking *1687"
      },
      "dimensionValues": [
        {
          "id": "dv_593051",
          "dimension": {
            "id": "dim_4521",
            "name": "Region",
            "requiredness": "NOT_REQUIRED"
          },
          "name": "Mid-Atlantic",
          "child": {
            "id": "dv_593052",
            "dimension": {
              "id": "dim_4521",
              "name": "Region",
              "requiredness": "NOT_REQUIRED"
            },
            "name": "Washington DC"
          }
        }
      ],
      "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",
        "displayName": "#60210 Officer(s) Salaries and Wages"
      },
      "bankTransaction": {
        "bankAccount": {
          "id": "bka_7542850",
          "name": "Business Checking",
          "displayName": "Business Checking *1687"
        }
      },
      "children": [
        {
          "id": "itm_349412",
          "amount": -134051,
          "displayName": "Gusto",
          "description": "WITHDRAWAL ACH GUSTO TAXID: 4001",
          "dimensionValues": [
            {
              "id": "dv_593051",
              "dimension": {
                "id": "dim_4521",
                "name": "Region",
                "requiredness": "NOT_REQUIRED"
              },
              "name": "Mid-Atlantic",
              "child": {
                "id": "dv_593052",
                "dimension": {
                  "id": "dim_4521",
                  "name": "Region",
                  "requiredness": "NOT_REQUIRED"
                },
                "name": "Washington DC"
              }
            }
          ],
          "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",
            "displayName": "#60210 Officer(s) Salaries and Wages"
          },
          "invoice": {
            "lineItems": [
              {
                "id": "ili_123456",
                "amount": 5001
              }
            ]
          },
          "bill": {
            "lineItems": [
              {
                "id": "bli_123456",
                "amount": 5001
              }
            ]
          }
        }
      ],
      "customData": {
        "internal_key": "some_internal_key",
        "some_other_field": 23434
      }
    }
  ]
}