Methods

Методы для управления заказами и подписками

Получить магазин

get

Возвращает информацию о магазине для аутентифицированного пользователя

Authorizations

ApiKeyAuth

Api-KeystringRequired

API ключ для аутентификации.

Responses

200

Успешный ответ

application/json

401

Неавторизован (неверный API ключ)

application/json

404

Магазин не найден

application/json

get

/shop

HTTPcURLJavaScriptPython

GET /api/v1/shop HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "userId": 123,
  "name": "Мой магазин",
  "link": "myshop",
  "callbackUrl": "https://example.com/webhook",
  "recurrent": true,
  "onlyStars": false,
  "status": 1
}

Получить заказы магазина

get

Возвращает список заказов магазина, отсортированных по убыванию ID (сначала новые)

Authorizations

ApiKeyAuth

Api-KeystringRequired

API ключ для аутентификации.

Responses

200

Успешный ответ

application/json

401

Неавторизован (неверный API ключ)

application/json

404

Магазин не найден

application/json

get

/shop/orders

HTTPcURLJavaScriptPython

GET /api/v1/shop/orders HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

[
  {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "amount": 100000,
    "currency": "rub",
    "title": "Товар X",
    "description": "Подробное описание товара",
    "status": "paid",
    "email": "[email protected]",
    "successUrl": "https://shop.com/success",
    "failUrl": "https://shop.com/fail",
    "paymentUrl": "https://web.tribute.tg/shop/pay/550e8400-e29b-41d4-a716-446655440000",
    "createdAt": "2025-11-13T15:04:05Z",
    "comment": "Особые пожелания",
    "period": "onetime",
    "memberStatus": "active",
    "memberExpiresAt": "2025-12-13T15:04:05Z"
  }
]

Создать заказ в магазине

post

Создает новый заказ в магазине и возвращает ссылку для оплаты клиенту. Поддерживает разовые и рекуррентные платежи.

Authorizations

ApiKeyAuth

Api-KeystringRequired

API ключ для аутентификации.

Body

application/json

amountinteger · int64Required

Сумма заказа в минимальных единицах валюты (центы для EUR, копейки для RUB)

Example: 100000

currencystring · enumRequired

Код валюты (в нижнем регистре)

Example: rubPossible values:

titlestringRequired

Название заказа (обязательно, макс 100 символов UTF-16)

Example: Товар X

descriptionstringRequired

Описание заказа (обязательно, макс 300 символов UTF-16)

Example: Подробное описание товара

successUrlstring · uriOptional

URL редиректа при успешной оплате (опционально, должен быть валидным URL)

Example: https://shop.com/success

failUrlstring · uriOptional

URL редиректа при неудачной оплате (опционально, должен быть валидным URL)

Example: https://shop.com/fail

emailstring · emailOptional

Email клиента (опционально, валидируется если указан)

Example: [email protected]

savePaymentMethodbooleanOptional

Сохранить платежный метод для рекуррентных списаний (требуется shop.recurrent = true)

Example: false

commentstringOptional

Комментарий к заказу (опционально)

Example: Особые пожелания

periodstring · enumOptional

Период оплаты. По умолчанию "onetime". Рекуррентные периоды требуют shop.recurrent = true

Default: onetimeExample: monthlyPossible values:

Responses

200

Заказ успешно создан

application/json

400

Некорректный запрос

application/json

401

Неавторизован (неверный API ключ)

application/json

404

Магазин не найден

application/json

post

/shop/orders

HTTPcURLJavaScriptPython

POST /api/v1/shop/orders HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 316

{
  "amount": 100000,
  "currency": "rub",
  "title": "Товар X",
  "description": "Подробное описание товара",
  "successUrl": "https://shop.com/success",
  "failUrl": "https://shop.com/fail",
  "email": "[email protected]",
  "savePaymentMethod": false,
  "comment": "Особые пожелания",
  "period": "monthly"
}

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "paymentUrl": "https://web.tribute.tg/shop/pay/550e8400-e29b-41d4-a716-446655440000"
}

Получить статус заказа

get

Возвращает текущий статус конкретного заказа магазина по его UUID. Доступно только владельцу магазина.

Authorizations

ApiKeyAuth

Api-KeystringRequired

API ключ для аутентификации.

Path parameters

orderUuidstring · uuidRequired

UUID заказа

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Успешный ответ

application/json

401

Неавторизован (неверный API ключ)

application/json

403

Запрещено (заказ принадлежит другому магазину)

application/json

404

Заказ или магазин не найден

application/json

get

/shop/orders/{orderUuid}/status

HTTPcURLJavaScriptPython

GET /api/v1/shop/orders/{orderUuid}/status HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "status": "paid"
}

Отменить рекуррентный заказ

post

Отменяет рекуррентную подписку на заказ магазина. Доступно только владельцу магазина или авторизованным менеджерам.

Authorizations

ApiKeyAuth

Api-KeystringRequired

API ключ для аутентификации.

Path parameters

orderUuidstring · uuidRequired

UUID заказа

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Заказ успешно отменен

application/json

400

Некорректный запрос

application/json

401

Неавторизован (неверный API ключ)

application/json

403

Запрещено (доступ запрещен)

application/json

404

Заказ, магазин или рекуррентная подписка не найдены

application/json

post

/shop/orders/{orderUuid}/cancel

HTTPcURLJavaScriptPython

POST /api/v1/shop/orders/{orderUuid}/cancel HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "recurring order cancelled"
}