Link Search Menu Expand Document

Constructor: payments.paymentForm

Back to constructors index

Payment form

Attributes:

NameTypeRequiredDescription
can_save_credentialsBoolOptionalWhether the user can choose to save credentials.
password_missingBoolOptionalIndicates 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_idlongYesForm ID
bot_idlongYesBot ID
titlestringYesForm title
descriptionstringYesDescription
photoWebDocumentOptionalProduct photo
invoiceInvoiceYesInvoice
provider_idlongYesPayment provider ID.
urlstringYesPayment form URL
native_providerstringOptionalPayment provider name.
One of the following:
- stripe
native_paramsDataJSONOptionalContains 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_methodsArray of PaymentFormMethodOptionalAdditional payment methods
saved_infoPaymentRequestedInfoOptionalSaved server-side order information
saved_credentialsArray of PaymentSavedCredentialsOptionalContains information about saved card credentials
usersArray of UserYesUsers

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]];