com.tgpaybot/merchant-api

Tools

• archiveSubscriptionPlan

  Stop new signups for a plan (live subscriptions keep renewing).

  shallow
• cancelSubscription

  Stop future charges for one subscription (paid time runs out).

  shallow
• connect

  Start token issuance WITHOUT the Mini App UI: creates a merchant-app request and returns a t.me approve link plus a poll_secret. Show the link to the human — they approve with one button in the @tgpaycryptobot bot — then call connect_status with the poll_secret. Use only when no API token is configured yet.

  shallow
• connect_status

  Poll a connect request. Returns pending | denied | expired, or — once approved — the app id and the API TOKEN (returned exactly once: save it to the project's .env immediately, never print it in logs). The token is SCOPED (read, invoices, subscriptions, webhooks) — it cannot move money out of the app; transfers/refunds/checks need the primary token the human holds in the Mini App. Poll every 3-5 seconds while pending.

  shallow
• createCheck

  Create a bearer payout link (moves money to a hold), or a named-list check: `recipients` reserves one seat per person with its own amount — only they can claim, unclaimed seats refund at `expires_in`.

  shallow
• createInvoice

  Create a one-off payment invoice; the payer opens result.mini_app_invoice_url. See the invoices doc.

  shallow
• createSubscriptionPlan

  Create an IMMUTABLE recurring-billing plan; send payers to result.mini_app_subscribe_url. See the subscriptions doc.

  shallow
• deleteCheck

  Delete an unclaimed check (refunds the hold).

  shallow
• deleteInvoice

  Delete an unpaid invoice.

  shallow
• get_docs

  Read a TgPay Merchant API integration doc. START HERE before integrating: topics quickstart, invoices, subscriptions, transfers-checks, webhooks, errors.

  shallow
• getBalance

  Merchant app balance per asset (available + onhold).

  shallow
• getChecks

  List checks.

  shallow
• getCurrencies

  Supported crypto assets (code/name/decimals) and fiats.

  shallow
• getExchangeRates

  Current asset↔fiat display rates.

  shallow
• getInvoices

  List invoices (newest first).

  shallow
• getMe

  Verify the token: app id, name, webhook config, token scopes.

  shallow
• getStats

  App volume/count stats for a period.

  shallow
• getSubscriptionPlans

  List subscription plans.

  shallow
• getSubscriptions

  List subscriptions (subscribers).

  shallow
• getTransfers

  List app→user transfers.

  shallow
• refundInvoice

  Refund a paid invoice (moves money app→payer; partial refunds accumulate up to the face amount).

  shallow
• transfer

  Pay a Telegram user from the app balance (instant, irreversible). Address by user_id (must have opened the bot) OR username (unknown → parked in escrow until they open the bot, auto-returned after 30 days). MONEY MOVES — double-check the recipient and amount; spend_id is the idempotency key.

  shallow
• transferBatch

  Batch of transfers; items succeed/fail independently. MONEY MOVES.

  shallow
• updateApp

  Update app name / webhook_url (https) / webhook_events opt-in list. Needs the 'webhooks' scope (the connect-issued token has it) or the primary token. See the webhooks doc for the event types and signature verification.

  shallow

Embed this server’s score

Tool count and median score across every tool in this server’s corpus — honest in a way a single cherry-picked tool’s badge wouldn’t be.

[![Vouch score](https://vouch.tools/api/servers/44955ceb-7c53-44dd-8795-75331fb49f2a/badge.svg)](https://vouch.tools/servers/44955ceb-7c53-44dd-8795-75331fb49f2a)