Telethon/methods/payments/get_payment_form.html
2024-09-23 18:48:46 +02:00

31 lines
3.3 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetPaymentFormRequest</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
<script>
document.getElementById("style").href = "../../css/docs."
+ (localStorage.getItem("theme") || "light")
+ ".css";
</script>
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
rel="stylesheet">
</head>
<body>
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Payments</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_payment_form.html">GetPaymentFormRequest</a></li></ul><h1>GetPaymentFormRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
payments.getPaymentForm#37148dbb flags:# invoice:<a href="../../types/input_invoice.html">InputInvoice</a> theme_params:flags.0?<a href="../../types/data_json.html">DataJSON</a> = <a href="../../types/payments/payment_form.html">payments.PaymentForm</a></pre><button onclick="cp('from telethon.tl.functions.payments import GetPaymentFormRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/payments/payment_form.html">payments.PaymentForm</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/payments/payment_form.html">PaymentForm</a></td><td><a href="../../constructors/payments/payment_form_stars.html">PaymentFormStars</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>invoice</b></td><td style="text-align:center"><a href="../../types/input_invoice.html">InputInvoice</a></td><td></td></tr><tr><td><b>theme_params</b></td><td style="text-align:center"><a href="../../types/data_json.html">DataJSON</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can cause 1 known error:</p><table><tr><td><code>MessageIdInvalidError</code></td><td>The specified message ID is invalid or you can't do that operation on such message.</td></tr></table><p>You can import these from <code>telethon.errors</code>.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
<strong>from</strong> telethon <strong>import</strong> functions, types
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
result = client(functions.payments.GetPaymentFormRequest(
invoice=types.InputInvoiceMessage(
peer=<em>'username'</em>,
msg_id=42
),
theme_params=types.DataJSON(
data=<em>'some string here'</em>
)
))
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>