MadelineProto/docs/API_docs/methods/payments_sendPaymentForm.md

75 lines
1.9 KiB
Markdown
Raw Normal View History

---
title: payments.sendPaymentForm
2018-03-23 16:23:49 +01:00
description: Bots only: send payment form
---
## Method: payments.sendPaymentForm
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Bots only: send payment form
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID|
|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info|
|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID|
|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials|
### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|MESSAGE_ID_INVALID|The provided message id is invalid|
2018-03-20 19:57:36 +01:00
### 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();
2017-07-23 16:33:46 +02:00
$payments_PaymentResult = $MadelineProto->payments->sendPaymentForm(['msg_id' => int, 'requested_info_id' => 'string', 'shipping_option_id' => 'string', 'credentials' => InputPaymentCredentials, ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/payments.sendPaymentForm`
Parameters:
msg_id - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
requested_info_id - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
shipping_option_id - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
credentials - Json encoded InputPaymentCredentials
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
payments_PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, })
```