mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-29 12:04:51 +00:00
54 lines
1.8 KiB
Python
54 lines
1.8 KiB
Python
# Pyrofork - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2022-present Mayuri-Chan <https://github.com/Mayuri-Chan>
|
|
#
|
|
# This file is part of Pyrofork.
|
|
#
|
|
# Pyrofork is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser General Public License as published
|
|
# by the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Pyrofork is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser General Public License
|
|
# along with Pyrofork. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from typing import Union
|
|
|
|
import pyrogram
|
|
from pyrogram import raw
|
|
|
|
class RefundStarPayment:
|
|
async def refund_star_payment(
|
|
self: "pyrogram.Client",
|
|
user_id: Union[int, str],
|
|
telegram_payment_charge_id: str
|
|
) -> bool:
|
|
"""Refund the star to the user.
|
|
|
|
Parameters:
|
|
user_id (``int`` | ``str``):
|
|
The user id to refund the stars.
|
|
|
|
telegram_payment_charge_id (``str``):
|
|
The charge id to refund the stars.
|
|
|
|
Returns:
|
|
`bool`: On success, a True is returned.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
await app.refund_star_payment(user_id, telegram_payment_charge_id)
|
|
"""
|
|
await self.invoke(
|
|
raw.functions.payments.RefundStarsCharge(
|
|
user_id=await self.resolve_peer(user_id),
|
|
charge_id=telegram_payment_charge_id
|
|
)
|
|
)
|
|
|
|
return True
|