MadelineProtoDocs/old_docs/API_docs_v105/methods/payments.getPaymentForm.md

52 lines
1.2 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: payments.getPaymentForm
2019-12-27 17:48:04 +01:00
description: Get a payment form
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: payments.getPaymentForm
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Get a payment form
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|msg\_id|[int](../types/int.md) | Message ID of payment form | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md)
### Can bots use this method: **NO**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$payments_PaymentForm = $MadelineProto->payments->getPaymentForm(['msg_id' => int, ]);
```
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
payments_PaymentForm = payments.getPaymentForm({msg_id=int, })
```
2019-09-02 17:41:28 +02:00
### Errors
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|MESSAGE_ID_INVALID|The provided message id is invalid|
2018-04-01 13:19:25 +02:00