2017-07-23 17:44:01 +02:00
|
|
|
---
|
|
|
|
title: payments.sendPaymentForm
|
2018-03-23 16:23:49 +01:00
|
|
|
description: Bots only: send payment form
|
2017-07-23 17:44:01 +02:00
|
|
|
---
|
|
|
|
## Method: payments.sendPaymentForm
|
|
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
|
|
|
2018-03-23 16:23:49 +01:00
|
|
|
Bots only: send payment form
|
|
|
|
|
2017-07-23 17:44:01 +02:00
|
|
|
### 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|
|
2017-07-23 17:44:01 +02:00
|
|
|
|
|
|
|
|
|
|
|
### 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:
|
2017-07-23 17:44:01 +02:00
|
|
|
|
|
|
|
|
|
|
|
```
|
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
|
|
|
if (!file_exists('madeline.php')) {
|
|
|
|
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
2017-07-23 17:44:01 +02:00
|
|
|
}
|
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
|
|
|
include 'madeline.php';
|
|
|
|
|
2018-03-23 17:48:12 +01:00
|
|
|
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
|
|
|
$MadelineProto->start();
|
2017-07-23 17:44:01 +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 17:44:01 +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 17:44:01 +02:00
|
|
|
requested_info_id - Json encoded string
|
2017-08-20 19:09:52 +02:00
|
|
|
|
2017-07-23 17:44:01 +02:00
|
|
|
shipping_option_id - Json encoded string
|
2017-08-20 19:09:52 +02:00
|
|
|
|
2017-07-23 17:44:01 +02:00
|
|
|
credentials - Json encoded InputPaymentCredentials
|
|
|
|
|
|
|
|
|
|
|
|
|
2017-08-20 19:09:52 +02:00
|
|
|
|
2017-07-23 17:44:01 +02:00
|
|
|
Or, if you're into Lua:
|
|
|
|
|
|
|
|
```
|
|
|
|
payments_PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, })
|
|
|
|
```
|
|
|
|
|