Documentation sections

Documentation/API

Get a payment

GET by payment id or your own order number

GET/api/v1/payments/{id}
GET/api/v1/payments?orderId={orderId}

Overview

Returns the payment object in the same format as the create response. Look up a payment by the TabPay identifier from the id field or by your own order number orderId.

A payment that belongs to another shop or does not exist returns the same 404: payments are visible only to the shop that created them. The path id is the UUID from the create response; any other format returns a 400. To look up by your own order number, use the orderId parameter.

When to use

  • the create-payment response never arrived - check by orderId whether the payment exists before creating it again;
  • a webhook was not delivered (your server was unreachable for the whole retry window: 7 attempts over about 33 hours) - verify the status;
  • manual reconciliation when investigating a disputed payment.

To receive results on a regular basis, use webhooks instead of polling in a loop - it is faster and does not run into rate limits.

curl https://tabpay.org/api/v1/payments/6b9d2c88-4b1a-4f0e-9c37-1f2ab34cd561 \
  -H "X-Api-Key: tp_your_key"
Response 200
{
  "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-11T10:24:05.000Z",
  "createdAt": "2026-07-11T10:20:30.000Z"
}