List payments

GET

https://integrators.prod.api.tabsplatform.com/v3.1/payments

GET

/v3.1/payments

curl https://integrators.prod.api.tabsplatform.com/v3.1/payments \
     -H "Authorization: <apiKey>"

200Retrieved

{
  "payload": {
    "data": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
        "total": 99.99,
        "receivedAt": "2023-01-01T00:00:00.000Z",
        "status": "COMPLETED",
        "type": "MANUAL",
        "reference": "REF123456",
        "method": "CREDIT_CARD",
        "externalIds": [
          {
            "type": "QUICKBOOKS",
            "id": "pi_1234567890"
          }
        ]
      }
    ],
    "limit": 1.1,
    "totalItems": 1.1,
    "currentPage": 1.1
  },
  "success": true,
  "message": "string",
  "error": {
    "code": 1.1,
    "message": "string",
    "errorCode": "string",
    "details": {}
  }
}

Authentication

Authorizationstring

API Key authentication via header

Query parameters

pagedoubleOptionalDefaults to 1

Page number. Defaults to 1.

limitdoubleOptionalDefaults to 50

Rows per page. Defaults to 50.

filterstringOptional

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

Fields: receivedAt (datetime): eq, neq, gt, gte, lt, lte status (string): eq, neq, like, nlike, in, nin, isnull, isnotnull type (string): eq, neq, like, nlike, in, nin, isnull, isnotnull (one of: MANUAL, STRIPE, TABS_PAY, RECONCILIATION, REFUND, CREDIT_MEMO_FROM_ERP) invoiceId (uuid): eq, neq, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull

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

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

Response

Get all Payments 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

errorobjectOptional

json element with any error messages or warnings