Skip to content

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

OperationWhat it doesChanges your balance
List productsGET /productsList productsNo

Recipients

OperationWhat it doesChanges your balance
Create recipient lookupPOST /recipient-lookupsLook up a Telegram recipient before quotingNo
Lookup recipientGET /recipients/lookupCheck a Telegram username before ordering (optional)No

Quotes

OperationWhat it doesChanges your balance
Create quotePOST /quotesVerify a recipient and lock a price for up to 60 secondsNo

Prices

OperationWhat it doesChanges your balance
List pricesGET /pricesThe USD price book in effect, with indicative GRAM figuresNo
Get ratesGET /ratesThe GRAM/USD reference rate GRAM quotes are priced at, and display ratesNo

Orders

OperationWhat it doesChanges your balance
List ordersGET /ordersList ordersNo
Create orderPOST /ordersCreate an order (funds are reserved before the response)Yes
Get orderGET /orders/{id}Retrieve an orderNo

Balance

OperationWhat it doesChanges your balance
Get balanceGET /balanceAvailable, held and pending-funding balancesNo
List balance transactionsGET /balance/transactionsEvery movement on the balanceNo

Funding

OperationWhat it doesChanges your balance
List fundingsGET /fundingsIncoming transfers and their stateNo
Get deposit addressGET /funding/deposit-addressYour organisation's Gram (GRAM) deposit address on the TON networkNo
List gram depositsGET /funding/depositsGRAM deposits to your address, and their stateNo

Statements

OperationWhat it doesChanges your balance
List statementsGET /statementsThe workspace's statements, newest firstNo
Create statementPOST /statementsRequest an account statement for whole local daysNo
Get statementGET /statements/{id}One statement, its state and, once ready, its reconciled summaryNo

Limits

OperationWhat it doesChanges your balance
Get limitsGET /limitsThe platform's limits, the workspace's own spending limits and what they have usedNo

Events

OperationWhat it doesChanges your balance
List eventsGET /eventsEvent log (30-day retention)No
Get eventGET /events/{id}Retrieve an eventNo

Webhooks

OperationWhat it doesChanges your balance
List webhook endpointsGET /webhook-endpointsList webhook endpointsNo
Create webhook endpointPOST /webhook-endpointsCreate 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-secretIssue a new secret. Both secrets sign for 24 hours.No
List webhook deliveriesGET /webhook-endpoints/{id}/deliveriesNo
Replay webhook deliveryPOST /webhook-deliveries/{id}/replayResend the same event (same webhook-id). Never creates a financial event.No
Send webhook test eventPOST /webhook-endpoints/{id}/testSend one test event of a type the endpoint subscribes to. It is marked and synthetic, and never a real order or funding.No

Account

OperationWhat it doesChanges your balance
Get accountGET /accountNo

Sandbox

OperationWhat it doesChanges your balance
Create sandbox gram depositPOST /sandbox/funding/depositsSimulate a GRAM deposit to your address (sandbox host only; 404 in production)Yes
Create sandbox depositPOST /sandbox/depositsSimulate a GRAM deposit to your address (sandbox host only; 404 in production)Yes
List sandbox test runsGET /sandbox/test-runsThe organisation's test runs, newest first (sandbox host only). Kept 30 days.No
Create sandbox test runPOST /sandbox/test-runsRun 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