For developers

API для партнерів.

REST API for partners. Single Bearer key, idempotent requests, JSON in/out — zero ceremony.

Відкрити Swagger Отримати ключ

BASE URL

https://api.theopenmoney.info/api/v1

Auth

Authorization: Bearer

Format

REST · JSON

Quickstart

Три кроки до першого замовлення.

Step 01

Отримайте ключ

Напишіть боту /api — він видасть ключ osk_… Зберігайте у секреті.

Step 02

Надішліть запит

POST /orders/stars з одержувачем і кількістю зірок.

Step 03

Заберіть результат

У відповіді — order_id, адреса оплати, memo та термін життя.

POST /orders/stars

curl -X POST https://api.theopenmoney.info/api/v1/orders/stars \
  -H "Authorization: Bearer $KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_username": "pandus",
    "quantity": 100,
    "payment_method": "ton_memo",
    "payment_currency": "TON",
    "client_reference": "invoice-42"
  }'

200 OK · JSON response

{
  "ok": true,
  "data": {
    "id": 10421,
    "status": "pending_payment",
    "order_type": "stars",
    "stars_amount": 100,
    "recipient_username": "pandus",
    "price_ton": 0.418,
    "payment_address": "UQBFJTkJ5hZdH7i6rWQTnm43zn6h2dPBV9lFZ2e98WvWABy_",
    "payment_memo": "STARS-a1b2c3",
    "expires_at": "2026-04-16T12:15:00Z",
    "created_at": "2026-04-16T12:00:00Z"
  }
}

Auth

Один заголовок.

Кожен запит авторизується заголовком Authorization: Bearer osk_… Один ключ відповідає одному партнеру і одній TON-адресі поповнення.

Не кладіть ключ у клієнтський код або у URL.
Rate limit працює на рівні ключа.
Скомпрометований ключ — відкличте і отримайте новий у боті.

HTTP request

GET /api/v1/balance HTTP/1.1
Host: api.theopenmoney.info
Authorization: Bearer osk_••••••••••••••••
Accept: application/json

Endpoints

Усі ендпоінти.

У Swagger

Orders

POST/orders/starsCreate a Stars order
POST/orders/premiumCreate a Premium order (3 / 6 / 12 months)
GET/orders/{id}Get order by ID
GET/ordersList orders
GET/orders/by-memo/{memo}Find order by payment_memo
GET/orders/by-reference/{ref}Find orders by your client_reference
GET/orders/stats/summaryAggregate stats
POST/orders/{id}/cancelCancel a pending_payment order

Pricing

GET/pricing/ton-rateCurrent TON/USD rate
GET/pricing/feeService fees and min/max limits
GET/pricing/estimate/starsEstimate Stars price in TON
GET/pricing/estimate/premiumEstimate Premium price in TON

Recipients

GET/recipients/starsCheck if a username can receive Stars
GET/recipients/premiumCheck if a username can receive Premium

Balance

GET/balancePartner balance and top-up address
GET/balance/transactionsBalance transactions history

Health

GET/healthService health probe

Examples

Рецепти на curl.

Створити замовлення на Stars

POST /orders/stars

curl -X POST https://api.theopenmoney.info/api/v1/orders/stars \
  -H "Authorization: Bearer $KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_username": "pandus",
    "quantity": 100,
    "payment_method": "ton_memo",
    "payment_currency": "TON",
    "client_reference": "invoice-42"
  }'

Перевірити статус замовлення

GET /orders/{id}

curl https://api.theopenmoney.info/api/v1/orders/10421 \
  -H "Authorization: Bearer $KEY"

Перевірити одержувача

GET /recipients/stars

curl "https://api.theopenmoney.info/api/v1/recipients/stars?username=pandus" \
  -H "Authorization: Bearer $KEY"

Порахувати ціну

GET /pricing/estimate/stars

curl "https://api.theopenmoney.info/api/v1/pricing/estimate/stars?quantity=100" \
  -H "Authorization: Bearer $KEY"

Reliability

Retry-safe by design.

Idempotency-Key

Передайте будь-який UUID у заголовку Idempotency-Key — повторний запит з тим же ключем поверне те ж замовлення, а не створить нове. Потрібно на випадок таймаутів і ретраїв.

Header

Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000

client_reference

Опціонально прив'яжіть свій ID (номер інвойсу, payment_id) при створенні замовлення. Потім шукайте: GET /orders/by-reference/{ref} поверне всі пов'язані замовлення.

Body field

{
  "client_reference": "invoice-42"
}

Єдиний формат.

Усі помилки — той самий JSON: ok=false, читаємий error_code і error_message.

Часті коди

401: Немає або невалідний Bearer-токен
404: Ресурс не знайдено (або не належить вашому ключу)
409: Конфлікт стану — наприклад, не можна скасувати оплачене замовлення
422: Невалідні параметри запиту
429: Перевищено rate limit

Error response

{
  "ok": false,
  "error_code": "VALIDATION_ERROR",
  "error_message": "quantity must be between 50 and 10000",
  "data": null
}

Готовіпочати?

Повна інтерактивна схема — у Swagger. Ключ — за одну команду в боті.

Swagger Отримати ключ