MadelineProtoDocs/docs/API_docs/constructors/payments.paymentForm.md
2024-05-01 14:53:46 +02:00

3.2 KiB

title description nav_exclude image redirect_from
payments.paymentForm Payment form true https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png /API_docs/constructors/payments_paymentForm.html

Constructor: payments.paymentForm

Back to constructors index

Payment form

Attributes:

Name Type Required Description
can_save_credentials Bool Optional Whether the user can choose to save credentials.
password_missing Bool Optional Indicates that the user can save payment credentials, but only after setting up a 2FA password (currently the account doesn't have a 2FA password)
form_id long Yes Form ID
bot_id long Yes Bot ID
title string Yes Form title
description string Yes Description
photo WebDocument Optional Product photo
invoice Invoice Yes Invoice
provider_id long Yes Payment provider ID.
url string Yes Payment form URL
native_provider string Optional Payment provider name.
One of the following:
- stripe
native_params DataJSON Optional Contains information about the payment provider, if available, to support it natively without the need for opening the URL.
A JSON object that can contain the following fields:

- apple_pay_merchant_id: Apple Pay merchant ID
- google_pay_public_key: Google Pay public key
- need_country: True, if the user country must be provided,
- need_zip: True, if the user ZIP/postal code must be provided,
- need_cardholder_name: True, if the cardholder name must be provided
additional_methods Array of PaymentFormMethod Optional Additional payment methods
saved_info PaymentRequestedInfo Optional Saved server-side order information
saved_credentials Array of PaymentSavedCredentials Optional Contains information about saved card credentials
users Array of User Yes Users

Type: payments.PaymentForm

Example:

$payments_paymentForm = ['_' => 'payments.paymentForm', 'can_save_credentials' => Bool, 'password_missing' => Bool, 'form_id' => long, 'bot_id' => long, 'title' => 'string', 'description' => 'string', 'photo' => WebDocument, 'invoice' => Invoice, 'provider_id' => long, 'url' => 'string', 'native_provider' => 'string', 'native_params' => DataJSON, 'additional_methods' => [PaymentFormMethod, PaymentFormMethod], 'saved_info' => PaymentRequestedInfo, 'saved_credentials' => [PaymentSavedCredentials, PaymentSavedCredentials], 'users' => [User, User]];