Главная страница

Магазин

Операции с магазином для внешних интеграций

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

get

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

Authorizations
Api-KeystringRequired

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

Responses
200

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

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

{
  "userId": 123,
  "link": "myshop",
  "callbackUrl": "https://example.com/webhook",
  "recurringAvailable": true,
  "onlyStars": false,
  "status": 1
}

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

get

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

Authorizations
Api-KeystringRequired

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

Responses
200

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

application/json
get
/shop/orders
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-13 15:04:05"
  }
]

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

post

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

Authorizations
Api-KeystringRequired

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

Body
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 редиректа при успешной оплате (опционально)

Example: https://shop.com/success
failUrlstring · uriOptional

URL редиректа при неудачной оплате (опционально)

Example: https://shop.com/fail
emailstring · emailOptional

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

Example: [email protected]
Responses
200

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

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

{
  "amount": 100000,
  "currency": "rub",
  "title": "Товар X",
  "description": "Подробное описание товара",
  "successUrl": "https://shop.com/success",
  "failUrl": "https://shop.com/fail",
  "email": "[email protected]"
}
{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "paymentUrl": "https://web.tribute.tg/shop/pay/550e8400-e29b-41d4-a716-446655440000"
}

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

get

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

Authorizations
Api-KeystringRequired

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

Path parameters
orderUuidstring · uuidRequired

UUID заказа

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

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

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

{
  "status": "paid"
}
PreviousТоварыNextВебхуки

Last updated