refundStarPayment
Refunds a Telegram Stars payment.
Returns: On success, returns True.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
user_id | Integer | Yes | User ID |
telegram_payment_charge_id | String | Yes | Telegram payment ID |
Example request
curl
curl -s -X POST "https://api.telegram.org/bot$TOKEN/refundStarPayment" \
-H "Content-Type: application/json" \
-d '{"user_id":123456789,"telegram_payment_charge_id":"CHARGE_ID"}'
Python
import requests
TOKEN = "123456789:AAEexampleTokenReplaceWithYours"
resp = requests.post(
f"https://api.telegram.org/bot{TOKEN}/refundStarPayment",
json={
"user_id": 123456789,
"telegram_payment_charge_id": "CHARGE_ID"
},
timeout=30,
)
print(resp.json())
JavaScript
const TOKEN = "123456789:AAEexampleTokenReplaceWithYours";
const res = await fetch(`https://api.telegram.org/bot${TOKEN}/refundStarPayment`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
"user_id": 123456789,
"telegram_payment_charge_id": "CHARGE_ID"
}),
});
console.log(await res.json());
Step-by-step guide: How to Create a Telegram Bot: Step by Step with BotFather and Python
Related methods
sendInvoiceSends an invoice for payment.createInvoiceLinkCreates a payment link.sendGiftSends a gift to a user or chat.getMyStarBalanceReturns the bot's Telegram Stars balance.getStarTransactionsReturns bot's Telegram Stars transactions.editUserStarSubscriptionCancels or renews a Telegram Stars subscription.giftPremiumSubscriptionGifts a Telegram Premium subscription.answerShippingQueryAnswers a shipping query.answerPreCheckoutQueryAnswers a pre-checkout query.getAvailableGiftsReturns available gifts the bot can send.getUserGiftsReturns user's gifts.getChatGiftsReturns chat's gifts.