MadelineProtoDocs/old_docs/API_docs_v75/methods/payments_getPaymentForm.md

67 lines
1.3 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2018-06-29 13:59:08 +02:00
title: payments.getPaymentForm
description: Get 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-06-29 13:59:08 +02:00
# Method: payments.getPaymentForm
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2018-06-29 13:59:08 +02:00
Get payment form
2018-04-01 13:19:25 +02:00
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-06-29 13:59:08 +02:00
|msg\_id|[int](../types/int.md) | Yes|Message ID|
2018-04-01 13:19:25 +02:00
2018-06-29 13:59:08 +02:00
### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md)
2018-04-01 13:19:25 +02:00
### Can bots use this method: **NO**
### MadelineProto Example:
```
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();
2018-06-29 13:59:08 +02:00
$payments_PaymentForm = $MadelineProto->payments->getPaymentForm(['msg_id' => int, ]);
2018-04-01 13:19:25 +02:00
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
2018-06-29 13:59:08 +02:00
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/payments.getPaymentForm`
2018-04-01 13:19:25 +02:00
Parameters:
2018-06-29 13:59:08 +02:00
msg_id - Json encoded int
2018-04-01 13:19:25 +02:00
Or, if you're into Lua:
```
2018-06-29 13:59:08 +02:00
payments_PaymentForm = payments.getPaymentForm({msg_id=int, })
2018-04-01 13:19:25 +02:00
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
2018-06-29 13:59:08 +02:00
|MESSAGE_ID_INVALID|The provided message id is invalid|
2018-04-01 13:19:25 +02:00