API reference
Every operation in contract 1.0.0-draft.10, generated from the pinned OpenAPI document.
Requests are strict: unknown request fields are rejected. Responses are extensible: ignore unknown response fields, enum values and event types. Money is exact, and each field names its unit: amount is cents, a _micros field micro-dollars, a _usd field the same figure as a dollar string (Money fields). Lists are paged with limit and cursor and answer with has_more and next_cursor.
An operation marked "Changes your balance" requires an Idempotency-Key, bound permanently to the operation it created.
Every example uses the sandbox host and synthetic values, checked against the contract. Environments sets out the host, keys and money of each environment. The language and HTTP client you choose in a code panel hold on every page.
The contract itself is one file, openapi.json: import it into an API client, or generate one from it.
Products
| Operation | What it does | Changes your balance |
|---|---|---|
| List productsGET /products | List products | No |
Recipients
| Operation | What it does | Changes your balance |
|---|---|---|
| Create recipient lookupPOST /recipient-lookups | Look up a Telegram recipient before quoting | No |
| Lookup recipientGET /recipients/lookup | Check a Telegram username before ordering (optional) | No |
Quotes
| Operation | What it does | Changes your balance |
|---|---|---|
| Create quotePOST /quotes | Verify a recipient and lock a price for up to 60 seconds | No |
Prices
| Operation | What it does | Changes your balance |
|---|---|---|
| List pricesGET /prices | The USD price book in effect, with indicative GRAM figures | No |
| Get ratesGET /rates | The GRAM/USD reference rate GRAM quotes are priced at, and display rates | No |
Orders
| Operation | What it does | Changes your balance |
|---|---|---|
| List ordersGET /orders | List orders | No |
| Create orderPOST /orders | Create an order (funds are reserved before the response) | Yes |
| Get orderGET /orders/{id} | Retrieve an order | No |
Balance
| Operation | What it does | Changes your balance |
|---|---|---|
| Get balanceGET /balance | Available, held and pending-funding balances | No |
| List balance transactionsGET /balance/transactions | Every movement on the balance | No |
Funding
| Operation | What it does | Changes your balance |
|---|---|---|
| List fundingsGET /fundings | Incoming transfers and their state | No |
| Get deposit addressGET /funding/deposit-address | Your organisation's Gram (GRAM) deposit address on the TON network | No |
| List gram depositsGET /funding/deposits | GRAM deposits to your address, and their state | No |
Statements
| Operation | What it does | Changes your balance |
|---|---|---|
| List statementsGET /statements | The workspace's statements, newest first | No |
| Create statementPOST /statements | Request an account statement for whole local days | No |
| Get statementGET /statements/{id} | One statement, its state and, once ready, its reconciled summary | No |
Limits
| Operation | What it does | Changes your balance |
|---|---|---|
| Get limitsGET /limits | The platform's limits, the workspace's own spending limits and what they have used | No |
Events
| Operation | What it does | Changes your balance |
|---|---|---|
| List eventsGET /events | Event log (30-day retention) | No |
| Get eventGET /events/{id} | Retrieve an event | No |
Webhooks
| Operation | What it does | Changes your balance |
|---|---|---|
| List webhook endpointsGET /webhook-endpoints | List webhook endpoints | No |
| Create webhook endpointPOST /webhook-endpoints | Create a webhook endpoint (the secret is returned once) | No |
| Get webhook endpointGET /webhook-endpoints/{id} | No | |
| Update webhook endpointPATCH /webhook-endpoints/{id} | No | |
| Delete webhook endpointDELETE /webhook-endpoints/{id} | No | |
| Rotate webhook secretPOST /webhook-endpoints/{id}/rotate-secret | Issue a new secret. Both secrets sign for 24 hours. | No |
| List webhook deliveriesGET /webhook-endpoints/{id}/deliveries | No | |
| Replay webhook deliveryPOST /webhook-deliveries/{id}/replay | Resend the same event (same webhook-id). Never creates a financial event. | No |
| Send webhook test eventPOST /webhook-endpoints/{id}/test | Send one test event of a type the endpoint subscribes to. It is marked and synthetic, and never a real order or funding. | No |
Account
| Operation | What it does | Changes your balance |
|---|---|---|
| Get accountGET /account | No |
Sandbox
| Operation | What it does | Changes your balance |
|---|---|---|
| Create sandbox gram depositPOST /sandbox/funding/deposits | Simulate a GRAM deposit to your address (sandbox host only; 404 in production) | Yes |
| Create sandbox depositPOST /sandbox/deposits | Simulate a GRAM deposit to your address (sandbox host only; 404 in production) | Yes |
| List sandbox test runsGET /sandbox/test-runs | The organisation's test runs, newest first (sandbox host only). Kept 30 days. | No |
| Create sandbox test runPOST /sandbox/test-runs | Run a simulated order through the integration steps (sandbox host only; 404 in production). Writes no order and moves no money. | No |
| Get sandbox test runGET /sandbox/test-runs/{id} | One test run (sandbox host only). The first read with a key passes the run's status_retrieval step. | No |
