Payment object

Response field reference

The payment object is returned when you create or retrieve a payment. All amounts are integers in kopecks, all dates are ISO 8601 strings in UTC.

Fields

string (UUID)

Payment identifier in TabPay. Use it in status requests; the same value is sent in the webhook.

orderId

string

Your order number from the create request.

status

string

Payment status - see the status reference.

amountKopecks

integer

Payment amount in kopecks - the value you passed at creation. If the fee is (partly) shifted to the customer in the shop settings, the customer is charged more; that charged amount is not returned in the object.

commissionKopecks

integer

TabPay fee in kopecks, based on your shop's rate.

description

string | null

Payment description.

method

string | null

SBP or CARD; null until the method is fixed: it was not passed at creation and the customer has not picked one on the payment page.

telegramId

string | null

Customer's Telegram ID from the create request; null if it was not passed. Metadata for bots.

metadata

object | null

Your arbitrary data from the create request (echoed back), or null.

successUrl

string | null

Payment-level redirect URL after a successful payment; if null, the shop's URL is used.

failUrl

string | null

Payment-level redirect URL after a failed payment; if null, the shop's URL is used.

payUrl

string

Link to the payment page - send the customer here.

isTest

boolean

Test payment of a sandbox shop: the outcome is chosen on the payment page, no money moves, the webhook is sent with test: true. See the Test mode section.

paidAt

string | null

Time of the successful payment in ISO 8601 format; null until the payment is paid.

createdAt

string

Payment creation time in ISO 8601 format.

Payment object

{
  "id": "6b9d2c88-4b1a-4f0e-9c37-1f2ab34cd561",
  "orderId": "order-1001",
  "status": "SUCCESS",
  "amountKopecks": 19900,
  "commissionKopecks": 1393,
  "description": "Monthly subscription",
  "method": "SBP",
  "telegramId": "987654321",
  "metadata": { "productId": 42, "tariff": "month" },
  "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"
}

For status values and allowed transitions, see Payment statuses.