List payments

GET /v1/payments - payments for a period, for reconciliation and reporting

GET/api/v1/payments?from=&to=&status=

Overview

Returns a page of your shop's payments: the items are regular payment objects, plus total (the count matching the filter), page, and pageSize. The main use case is reconciliation with your accounting system and reporting.

The same URL with the orderId parameter works as before: it returns a single payment rather than a list, so existing integrations do not need any changes.

Query parameters

from

string (ISO 8601), optional

Start of the period by payment creation date (createdAt), inclusive. Time is UTC: "2026-07-01T00:00:00Z".

string (ISO 8601), optional

End of the period by createdAt, inclusive. from later than to returns a 400 error.

status

string, optional

Filter by statuses, comma-separated: for example SUCCESS,REFUNDED. Values come from the status reference.

page

integer, optional

Page number, from 1 to 10,000 (default 1).

limit

integer, optional

Page size, from 1 to 100 (default 20).

Reconciling without discrepancies

the period filters by createdAt, not by payment time: a payment created on the 31st and paid on the 1st falls into the day it was created. Check the paidAt field for the payment moment;
set period boundaries in ISO 8601 with "Z" or a timezone offset: for Moscow-time reporting, "2026-07-01T00:00:00+03:00" works - no need to convert to UTC by hand;
within a page, payments go from oldest to newest, and pages are stable: new payments are appended to the end and do not shift the ones already read;
non-final statuses (CREATED, PENDING) at the time of export may later become final, SUCCESS may turn into REFUNDED, and EXPIRED and FAILED may turn into SUCCESS on late payment. Reconcile closed periods and re-read them when investigating discrepancies.

curl "https://tabpay.org/api/v1/payments?from=2026-07-29T00:00:00Z&to=2026-07-30T00:00:00Z" \
  -H "X-Api-Key: tp_your_key"

Response 200

{
  "items": [
    {
      "id": "6b9d2c88-4b1a-4f0e-9c37-1f2ab34cd561",
      "orderId": "order-1001",
      "status": "SUCCESS",
      "amountKopecks": 19900,
      "commissionKopecks": 1393,
      "description": "Monthly subscription",
      "method": "SBP",
      "telegramId": null,
      "metadata": null,
      "successUrl": null,
      "failUrl": null,
      "payUrl": "https://tabpay.org/pay/6b9d2c88-4b1a-4f0e-9c37-1f2ab34cd561",
      "isTest": false,
      "paidAt": "2026-07-29T10:24:05.000Z",
      "createdAt": "2026-07-29T10:20:30.000Z"
    }
  ],
  "total": 154,
  "page": 1,
  "pageSize": 20
}