Get site proxy order

One order by its id. Public: anybody with the id sees what any visitor of the domain could learn — never the manage secret or the API key. Status and reason, the web proof and its last check, the domain's record, the owner bound by the first payment, the paid period, traffic and — while the order takes a payment — the TON Connect messages.

Field	Type	Notes
`id`	string	the order id (10 characters)
`periods`	integer	periods the pay messages are built for; `0` = 1, at most `Offer.max_periods`

curl -X POST https://app.apiton.org/v2.SiteProxy/Get -H 'Content-Type: application/json' \
  -d '{"id":"7k3qx9zd2m","periods":3}'

pay is there only while the order takes a payment (ready_to_pay, review, paid_pending_record, active, grace, suspended, and expired within 30 days) and apiton has a receiving wallet. Send pay.messages as they are, in one TON Connect sendTransaction:

Message `kind`	What it is
`payment`	to `pay.pay_address` (`UQ…`): `periods` × the price, with the order's comment `px-…`
`record`	to the domain's item (`EQ…`, bounceable): `change_dns_record` that points the `site` record at the customer node, `record_attach_nano` (0.05 GRAM); there while the record does not point at the node yet

pay.first: true — the payment must come from the wallet that owns the domain now (for an expired order: the same owner as before); a renewal (first absent) may come from any wallet. A payment below the price (2 % tolerance) buys nothing; the rest of a payment above a whole number of periods is not refunded. Without TON Connect, pay.ton_link (ton://transfer/…, for a QR code) and pay.tonkeeper_link carry the payment alone: set the record on dns.ton.org then.

A paid order also has owner (the wallet bound by the first payment; state on_sale or changed when the domain left it) and usage (body bytes and requests of the last 30 days, quota_bytes, over_quota: visitors get 509 while it is true).

Errors: failed_precondition (400) — an id that is not 10 letters and digits · invalid_argument (400) — periods above Offer.max_periods · not_found (404) — no such order · unavailable (503).

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "order": {
        "id": "7k3qx9zd2m",
        "domain": "shop.ton",
        "host": "shop.example.com",
        "status": "ready_to_pay",
        "created_at": "2026-11-05T12:00:00Z",
        "web_proof": {
            "token": "00112233445566778899aabbccddeeff",
            "value": "apiton-verify=00112233445566778899aabbccddeeff",
            "file_url": "https://shop.example.com/.well-known/apiton-verify.txt",
            "txt_name": "_apiton-verify.shop.example.com",
            "method": "file",
            "verified_at": "2026-11-05T12:03:00Z",
            "checked_at": "2026-11-05T12:03:00Z",
            "next_verify_at": "2026-11-05T12:03:30Z"
        },
        "record": {
            "kind": "adnl",
            "address": "9c1e…",
            "checked_at": "2026-11-05T12:03:00Z"
        },
        "pay": {
            "periods": 3,
            "amount_nano": "3000000000",
            "first": true,
            "messages": [
                {
                    "kind": "payment",
                    "address": "UQ…",
                    "amount_nano": "3000000000",
                    "payload_b64": "te6cck…",
                    "comment": "px-7K3QX9ZD"
                },
                {
                    "kind": "record",
                    "address": "EQ…",
                    "amount_nano": "50000000",
                    "payload_b64": "te6cck…"
                }
            ],
            "comment": "px-7K3QX9ZD",
            "pay_address": "UQ…",
            "ton_link": "ton://transfer/UQ…?amount=3000000000&text=px-7K3QX9ZD",
            "tonkeeper_link": "https://app.tonkeeper.com/transfer/UQ…?amount=3000000000&text=px-7K3QX9ZD"
        },
        "ton_url": "http://shop.ton/",
        "kind": "domain"
    }
}

🔴500Server Error