For developers

API para parceiros.

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

Abrir Swagger Obter chave

BASE URL

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

Auth

Authorization: Bearer

Format

REST · JSON

Quickstart

Três passos até o primeiro pedido.

Step 01

Obtenha a chave

Mande /api ao bot — ele devolve uma chave osk_… Mantenha em segredo.

Step 02

Envie a requisição

POST /orders/stars com destinatário e quantidade.

Step 03

Pegue o resultado

A resposta tem order_id, endereço de pagamento, memo e TTL.

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

Um header.

Toda requisição se autentica via header Authorization: Bearer osk_… Uma chave = um parceiro e um endereço TON de recarga.

Nunca coloque a chave em código cliente ou URLs.
O rate limit é por chave.
Comprometida? Revogue e peça uma nova no bot.

HTTP request

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

Endpoints

Todos os endpoints.

No 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

Receitas curl.

Criar pedido de 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"
  }'

Consultar status

GET /orders/{id}

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

Verificar destinatário

GET /recipients/stars

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

Calcular preço

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

Passe qualquer UUID no header Idempotency-Key — um retry com a mesma chave devolve o mesmo pedido em vez de criar outro. Essencial para timeouts e retries.

Header

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

client_reference

Anexe opcionalmente seu próprio ID (número de fatura, payment_id) ao criar o pedido. Depois: GET /orders/by-reference/{ref} devolve todos os pedidos vinculados.

Body field

{
  "client_reference": "invoice-42"
}

Formato único.

Todos os erros têm o mesmo JSON: ok=false, error_code legível e error_message.

Códigos comuns

401: Bearer token ausente ou inválido
404: Recurso não encontrado (ou não pertence à sua chave)
409: Conflito de estado — ex.: não dá para cancelar pedido pago
422: Parâmetros de requisição inválidos
429: Rate limit excedido

Error response

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

Pronto paracomeçar?

O esquema interativo completo está no Swagger. A chave — a um comando do bot.

Swagger Obter chave