PaymentResponse interface

Package:

botframework-schema

Warning

This API is now deprecated.

Bot Framework no longer supports payments

A PaymentResponse is returned when a user has selected a payment method and approved a payment request

Properties

details	A JSON-serializable object that provides a payment method specific message used by the merchant to process the transaction and determine successful fund transfer
methodName	The payment method identifier for the payment method that the user selected to fulfil the transaction
payerEmail	If the requestPayerEmail flag was set to true in the PaymentOptions passed to the PaymentRequest constructor, then payerEmail will be the email address chosen by the user
payerPhone	If the requestPayerPhone flag was set to true in the PaymentOptions passed to the PaymentRequest constructor, then payerPhone will be the phone number chosen by the user
shippingAddress	If the requestShipping flag was set to true in the PaymentOptions passed to the PaymentRequest constructor, then shippingAddress will be the full and final shipping address chosen by the user
shippingOption	If the requestShipping flag was set to true in the PaymentOptions passed to the PaymentRequest constructor, then shippingOption will be the id attribute of the selected shipping option

Property Details

details

A JSON-serializable object that provides a payment method specific message used by the merchant to process the transaction and determine successful fund transfer

details: any

Property Value

any

methodName

The payment method identifier for the payment method that the user selected to fulfil the transaction

methodName: string

Property Value

string

payerEmail

If the requestPayerEmail flag was set to true in the PaymentOptions passed to the PaymentRequest constructor, then payerEmail will be the email address chosen by the user

payerEmail: string

Property Value

string

payerPhone

If the requestPayerPhone flag was set to true in the PaymentOptions passed to the PaymentRequest constructor, then payerPhone will be the phone number chosen by the user

payerPhone: string

Property Value

string

shippingAddress

If the requestShipping flag was set to true in the PaymentOptions passed to the PaymentRequest constructor, then shippingAddress will be the full and final shipping address chosen by the user

shippingAddress: PaymentAddress

Property Value

PaymentAddress

shippingOption

If the requestShipping flag was set to true in the PaymentOptions passed to the PaymentRequest constructor, then shippingOption will be the id attribute of the selected shipping option

shippingOption: string

Property Value

string