MadelineProto/docs/API_docs/methods/payments_getPaymentForm.md
Daniil Gentili d69a27867f Better docs
2017-08-28 12:44:50 +02:00

66 lines
1.3 KiB
Markdown

---
title: payments.getPaymentForm
description: payments.getPaymentForm parameters, return type and example
---
## Method: payments.getPaymentForm
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|msg\_id|[int](../types/int.md) | Yes|
### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|MESSAGE_ID_INVALID|The provided message id is invalid|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
$payments_PaymentForm = $MadelineProto->payments->getPaymentForm(['msg_id' => int, ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### 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, })
```