2017-06-30 15:36:33 +02:00
|
|
|
---
|
|
|
|
title: payments.sendPaymentForm
|
|
|
|
description: payments.sendPaymentForm parameters, return type and example
|
|
|
|
---
|
|
|
|
## Method: payments.sendPaymentForm
|
|
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
|
|
|
|
|
|
### Parameters:
|
|
|
|
|
|
|
|
| Name | Type | Required |
|
2017-08-20 11:05:56 +02:00
|
|
|
|----------|---------------|----------|
|
2017-06-30 15:36:33 +02:00
|
|
|
|msg\_id|[int](../types/int.md) | Yes|
|
|
|
|
|requested\_info\_id|[string](../types/string.md) | Optional|
|
|
|
|
|shipping\_option\_id|[string](../types/string.md) | Optional|
|
|
|
|
|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|
|
|
|
|
|
|
|
|
|
|
|
|
### 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|
|
|
|
|
|
|
|
|
|
2017-06-30 15:36:33 +02:00
|
|
|
### Example:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
$MadelineProto = new \danog\MadelineProto\API();
|
2017-12-11 12:12:38 +01:00
|
|
|
$MadelineProto->session = 'mySession.madeline';
|
2017-06-30 15:36:33 +02:00
|
|
|
if (isset($number)) { // Login as a user
|
2017-12-11 12:12:38 +01:00
|
|
|
$MadelineProto->phone_login($number);
|
|
|
|
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
|
2017-06-30 15:36:33 +02:00
|
|
|
$MadelineProto->complete_phone_login($code);
|
|
|
|
}
|
|
|
|
|
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, ]);
|
2017-06-30 15:36:33 +02:00
|
|
|
```
|
|
|
|
|
2017-07-24 01:32:29 +02:00
|
|
|
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
|
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
|
|
|
|
2017-06-30 15:36:33 +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, })
|
2017-06-30 15:36:33 +02:00
|
|
|
```
|
|
|
|
|