MadelineProtoDocs/docs/API_docs/methods/payments_validateRequestedInfo.md

73 lines
1.7 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: payments.validateRequestedInfo
description: Validate requested payment info
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: payments.validateRequestedInfo
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Validate requested payment info
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|save|[Bool](../types/Bool.md) | Save payment info? | Optional|
|msg\_id|[int](../types/int.md) | The message ID | Yes|
|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | The requested payment info | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md)
### Can bots use this method: **NO**
### MadelineProto Example:
```php
2018-04-01 13:19:25 +02:00
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();
$payments_ValidatedRequestedInfo = $MadelineProto->payments->validateRequestedInfo(['save' => Bool, 'msg_id' => int, 'info' => PaymentRequestedInfo, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/payments.validateRequestedInfo`
Parameters:
save - Json encoded Bool
msg_id - Json encoded int
info - Json encoded PaymentRequestedInfo
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
payments_ValidatedRequestedInfo = payments.validateRequestedInfo({save=Bool, msg_id=int, info=PaymentRequestedInfo, })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|MESSAGE_ID_INVALID|The provided message id is invalid|