PaymentOptions interface

Package:

botframework-schema

Warning

This API is now deprecated.

Bot Framework no longer supports payments

Provides information about the options desired for the payment request

Properties

requestPayerEmail	Indicates whether the user agent should collect and return the payer's email address as part of the payment request
requestPayerName	Indicates whether the user agent should collect and return the payer's name as part of the payment request
requestPayerPhone	Indicates whether the user agent should collect and return the payer's phone number as part of the payment request
requestShipping	Indicates whether the user agent should collect and return a shipping address as part of the payment request
shippingType	If requestShipping is set to true, then the shippingType field may be used to influence the way the user agent presents the user interface for gathering the shipping address

Property Details

requestPayerEmail

Indicates whether the user agent should collect and return the payer's email address as part of the payment request

requestPayerEmail: boolean

Property Value

boolean

requestPayerName

Indicates whether the user agent should collect and return the payer's name as part of the payment request

requestPayerName: boolean

Property Value

boolean

requestPayerPhone

Indicates whether the user agent should collect and return the payer's phone number as part of the payment request

requestPayerPhone: boolean

Property Value

boolean

requestShipping

Indicates whether the user agent should collect and return a shipping address as part of the payment request

requestShipping: boolean

Property Value

boolean

shippingType

If requestShipping is set to true, then the shippingType field may be used to influence the way the user agent presents the user interface for gathering the shipping address

shippingType: string

Property Value

string