Main page

Shop

Shop operations for external integrations

Get Shop

get

Returns shop information for the authenticated user

Authorizations
Api-KeystringRequired

API key for authentication.

Responses
200

Successful response

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 Shop Orders

get

Returns a list of shop orders sorted by ID descending (newest first)

Authorizations
Api-KeystringRequired

API key for authentication.

Responses
200

Successful response

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": "Product X",
    "description": "Detailed product 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"
  }
]

Create Shop Order

post

Creates a new shop order and returns a payment URL for the customer.

Authorizations
Api-KeystringRequired

API key for authentication.

Body
amountinteger · int64Required

Order amount in smallest currency units (cents for EUR, kopecks for RUB)

Example: 100000
currencystring · enumRequired

Currency code (lowercase)

Example: rubPossible values:
titlestringRequired

Order title (required, max 100 UTF-16 characters)

Example: Product X
descriptionstringRequired

Order description (required, max 300 UTF-16 characters)

Example: Detailed product description
successUrlstring · uriOptional

Redirect URL on successful payment (optional)

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

Redirect URL on failed payment (optional)

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

Customer email (optional, validated if provided)

Example: [email protected]
Responses
200

Order created successfully

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: 204

{
  "amount": 100000,
  "currency": "rub",
  "title": "Product X",
  "description": "Detailed product 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 Shop Order Status

get

Returns the current status of a specific shop order by its UUID. Only accessible by the shop owner.

Authorizations
Api-KeystringRequired

API key for authentication.

Path parameters
orderUuidstring · uuidRequired

Order UUID

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

Successful response

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"
}
PreviousProductsNextWebhooks

Last updated