Connection check
verified live · 28h ago
merchant-api
Accept crypto payments via the TgPay Merchant API — invoices, subscriptions, webhooks.
Tools
21
GitHub stars
—
Installs / wk
—
Licence
—
Transport
streamable-http
Last checked
28h ago
Tools & capabilities
21 toolsRead from the running server on 28h ago.
archiveSubscriptionPlan
plan_id*
Stop new signups for a plan (live subscriptions keep renewing). Stop new signups for a plan (live subscriptions keep renewing).
cancelSubscription
can modify data
subscription_id*
Stop future charges for one subscription (paid time runs out). Stop future charges for one subscription (paid time runs out).
connect
app_name*
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… 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.
connect_status
poll_secret*
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, nev… 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.
createInvoice
fiatassetamountpayloadswap_toexpires_in
+9
Create a one-off payment invoice; the payer opens result.mini_app_invoice_url. See the invoices doc. Create a one-off payment invoice; the payer opens result.mini_app_invoice_url. See the invoices doc.
createSubscriptionPlan
name*asset*amount*period_days*
Create an IMMUTABLE recurring-billing plan; send payers to result.mini_app_subscribe_url. See the subscriptions doc. Create an IMMUTABLE recurring-billing plan; send payers to result.mini_app_subscribe_url. See the subscriptions doc.
deleteCheck
can modify data
check_id*
Delete an unclaimed check (refunds the hold). Delete an unclaimed check (refunds the hold).
deleteInvoice
can modify data
invoice_id*
Delete an unpaid invoice. Delete an unpaid invoice.
getBalance
read-only
Merchant app balance per asset (available + onhold). Merchant app balance per asset (available + onhold).
getChecks
read-only
assetcountoffsetstatuscheck_ids
List checks. List checks.
getCurrencies
read-only
Supported crypto assets (code/name/decimals) and fiats. Supported crypto assets (code/name/decimals) and fiats.
get_docs
read-only
topic*
Read a TgPay Merchant API integration doc. START HERE before integrating: topics quickstart, invoices, subscriptions, transfers-checks, webhooks, errors. Read a TgPay Merchant API integration doc. START HERE before integrating: topics quickstart, invoices, subscriptions, transfers-checks, webhooks, errors.
getExchangeRates
read-only
Current asset↔fiat display rates. Current asset↔fiat display rates.
getInvoices
read-only
fiatassetcountoffsetstatusinvoice_ids
List invoices (newest first). List invoices (newest first).
getMe
read-only
Verify the token: app id, name, webhook config, token scopes. Verify the token: app id, name, webhook config, token scopes.
getStats
read-only
end_atstart_at
App volume/count stats for a period. App volume/count stats for a period.
getSubscriptionPlans
read-only
List subscription plans. List subscription plans.
getSubscriptions
read-only
statusplan_iduser_id
List subscriptions (subscribers). List subscriptions (subscribers).
getTransfers
read-only
assetcountoffsetspend_idtransfer_ids
List app→user transfers. List app→user transfers.
refundInvoice
can modify data
amountspend_id*invoice_id*
Refund a paid invoice (moves money app→payer; partial refunds accumulate up to the face amount). Refund a paid invoice (moves money app→payer; partial refunds accumulate up to the face amount).
updateApp
namewebhook_urlwebhook_events