payments

List payments v3

Includes the deprecated stripeId field; /v3.1/payments returns the same records without it.

get/v3/payments

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3/payments
  • Auth: API key in header Authorization

Query parameters

pagenumber double required

Page Number

limitnumber double required

Number of items to return

filterstring

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

payloadV3PaymentsGetResponsesContentApplicationJsonSchemaPayload required

Response payload, will be empty when success is false

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Changes

No recorded changes to this operation across all 1 revision of this API.