MadelineProto/docs/API_docs/methods/payments_sendPaymentForm.md
2017-12-11 12:12:38 +01:00

73 lines
1.9 KiB
Markdown

---
title: payments.sendPaymentForm
description: payments.sendPaymentForm parameters, return type and example
---
## Method: payments.sendPaymentForm
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|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)
### 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();
$MadelineProto->session = 'mySession.madeline';
if (isset($number)) { // Login as a user
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
$MadelineProto->complete_phone_login($code);
}
$payments_PaymentResult = $MadelineProto->payments->sendPaymentForm(['msg_id' => int, 'requested_info_id' => 'string', 'shipping_option_id' => 'string', 'credentials' => InputPaymentCredentials, ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/payments.sendPaymentForm`
Parameters:
msg_id - Json encoded int
requested_info_id - Json encoded string
shipping_option_id - Json encoded string
credentials - Json encoded InputPaymentCredentials
Or, if you're into Lua:
```
payments_PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, })
```