MadelineProto/old_docs/API_docs_v72/methods/payments_getPaymentForm.md

66 lines
1.2 KiB
Markdown
Raw Normal View History

2017-11-15 13:41:58 +01:00
---
title: payments.getPaymentForm
2018-03-23 16:23:49 +01:00
description: Get payment form
2017-11-15 13:41:58 +01:00
---
## Method: payments.getPaymentForm
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Get payment form
2017-11-15 13:41:58 +01:00
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-03-27 14:41:50 +02:00
|msg\_id|[int](../types/int.md) | Yes|Message ID|
2017-11-15 13:41:58 +01:00
### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md)
### Can bots use this method: **NO**
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
2017-11-15 13:41:58 +01:00
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2017-11-15 13:41:58 +01:00
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2017-11-15 13:41:58 +01:00
$payments_PaymentForm = $MadelineProto->payments->getPaymentForm(['msg_id' => int, ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-11-15 13:41:58 +01:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/payments.getPaymentForm`
Parameters:
msg_id - Json encoded int
Or, if you're into Lua:
```
payments_PaymentForm = payments.getPaymentForm({msg_id=int, })
```
2018-03-27 14:41:50 +02:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|MESSAGE_ID_INVALID|The provided message id is invalid|