List payments

GET

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

GET

/v3/payments

$ curl -G https://integrators.prod.api.tabsplatform.com/v3/payments \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d page=1 \
>      -d limit=50 \
>      --data-urlencode filter=receivedAt:gte:2023-01-01,status:eq:COMPLETED

200Retrieved

1 {
2   "payload": {
3     "data": [
4       {
5         "id": "a3f1c9d2-4b7e-4f9a-9c3d-2e5f7a8b9c01",
6         "invoiceId": "b7d9e8f3-2c4a-4d6b-8f1e-3a7c9d0e2b45",
7         "total": 150.75,
8         "stripeId": "pi_1GqIC8Lz0qyl6XeW3X9a2b7c",
9         "receivedAt": "2024-05-15T14:22:30.000Z",
10         "status": "COMPLETED",
11         "type": "STRIPE",
12         "reference": "PAY20240515XYZ",
13         "method": "CREDIT_CARD",
14         "externalIds": [
15           {
16             "type": "STRIPE",
17             "id": "pi_1GqIC8Lz0qyl6XeW3X9a2b7c"
18           }
19         ]
20       }
21     ],
22     "limit": 50,
23     "totalItems": 1250,
24     "currentPage": 1
25   },
26   "success": true,
27   "message": "Payments retrieved successfully",
28   "error": {
29     "code": 0,
30     "message": "",
31     "details": {}
32   }
33 }

Authentication

Authorizationstring

API Key authentication via header

Query parameters

pagedoubleRequiredDefaults to 1

Page Number

limitdoubleRequiredDefaults to 50

Number of items to return

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 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

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 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

errorobject

json element with any error messages or warnings