Skip to main content

Available and held

GET /api/v1/balance returns decimal-string balances and the key’s environment. available is spendable company credit; held is reserved for unfinished operations. Creating an operation moves its total into reserve. Confirmed completion captures the reserve; a confirmed failure/refund releases it. Do not treat held funds as spendable or infer a refund from a provider timeout. Company balances and card balances are separate accounts.

Sandbox funding

POST /api/v1/sandbox/funding requires cards:write, an Idempotency-Key, and an amount from 0.01 to 1000000.00. It only credits test funds. Live keys are rejected.

Live USDT TON deposits

When live funding is enabled and your company is approved for funding, call POST /api/v1/funding/address using a live key with balance:read. The response identifies the deposit address, network TON, and asset USDT. Live deposits are not yet generally available. Do not send funds until Plane confirms activation for your company and the endpoint returns your assigned address. Send only the indicated asset on the indicated network; a documentation example is never a deposit address. Credits follow confirmed incoming transfers. Amounts smaller than one cent accumulate before becoming spendable credit. Use balance polling or balance.credited events to confirm credit. This endpoint does not initiate withdrawals or exchange funds.