Telegram.Bot.API.Payments

Methods

sendInvoice

data SendInvoiceRequest

Constructors

SendInvoiceRequest

Fields

• sendInvoiceRequestChatId :: ChatId

  Unique identifier for the target chat or username of the target channel (in the format @channelusername).

• sendInvoiceRequestMessageThreadId :: Maybe MessageThreadId

  Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

• sendInvoiceRequestTitle :: Text

  Product name, 1-32 characters.

• sendInvoiceRequestDescription :: Text

  Product description, 1-255 characters.

• sendInvoiceRequestPayload :: Text

  Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

• sendInvoiceRequestProviderToken :: Text

  Payments provider token, obtained via Botfather.

• sendInvoiceRequestCurrency :: Text

  Three-letter ISO 4217 currency code, see more on currencies.

• sendInvoiceRequestPrices :: [LabeledPrice]

  Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).

• sendInvoiceRequestMaxTipAmount :: Maybe Integer

  The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0.

• sendInvoiceRequestSuggestedTipAmounts :: Maybe [Integer]

  A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.

• sendInvoiceRequestStartParameter :: Maybe Text

  Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter.

• sendInvoiceRequestProviderData :: Maybe Text

  A JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.

• sendInvoiceRequestPhotoUrl :: Maybe Text

  URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.

• sendInvoiceRequestPhotoSize :: Maybe Int

  Photo size.

• sendInvoiceRequestPhotoWidth :: Maybe Int

  Photo width.

• sendInvoiceRequestPhotoHeight :: Maybe Int

  Photo height.

• sendInvoiceRequestNeedName :: Maybe Bool

  Pass True, if you require the user's full name to complete the order.

• sendInvoiceRequestNeedPhoneNumber :: Maybe Bool

  Pass True, if you require the user's phone number to complete the order.

• sendInvoiceRequestNeedEmail :: Maybe Bool

  Pass True, if you require the user's email address to complete the order.

• sendInvoiceRequestNeedShippingAddress :: Maybe Bool

  Pass True, if you require the user's shipping address to complete the order.

• sendInvoiceRequestSendPhoneNumberToProvider :: Maybe Bool

  Pass True, if you require the user's phone number to complete the order.

• sendInvoiceRequestSendEmailToProvider :: Maybe Bool

  Pass True, if user's email address should be sent to provider.

• sendInvoiceRequestIsFlexible :: Maybe Bool

  Pass True, if the final price depends on the shipping method.

• sendInvoiceRequestDisableNotification :: Maybe Bool

  Sends the message silently. Users will receive a notification with no sound.

• sendInvoiceRequestProtectContent :: Maybe Bool

  Protects the contents of the sent message from forwarding and saving.

• sendInvoiceRequestReplyToMessageId :: Maybe MessageId

  If the message is a reply, ID of the original message.

• sendInvoiceRequestAllowSendingWithoutReply :: Maybe Bool

  Pass True, if the message should be sent even if the specified replied-to message is not found.

• sendInvoiceRequestReplyMarkup :: Maybe InlineKeyboardMarkup

  A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.

Instances

Show SendInvoiceRequest

Defined in Telegram.Bot.API.Payments

Methods

showsPrec :: Int -> SendInvoiceRequest -> ShowS

show :: SendInvoiceRequest -> String

showList :: [SendInvoiceRequest] -> ShowS

Generic SendInvoiceRequest

Defined in Telegram.Bot.API.Payments

Associated Types

type Rep SendInvoiceRequest :: Type -> Type

Methods

from :: SendInvoiceRequest -> Rep SendInvoiceRequest x

to :: Rep SendInvoiceRequest x -> SendInvoiceRequest

FromJSON SendInvoiceRequest

Defined in Telegram.Bot.API.Payments

Methods

parseJSON :: Value -> Parser SendInvoiceRequest

parseJSONList :: Value -> Parser [SendInvoiceRequest]

ToJSON SendInvoiceRequest

Defined in Telegram.Bot.API.Payments

Methods

toJSON :: SendInvoiceRequest -> Value

toEncoding :: SendInvoiceRequest -> Encoding

toJSONList :: [SendInvoiceRequest] -> Value

toEncodingList :: [SendInvoiceRequest] -> Encoding

type Rep SendInvoiceRequest

Defined in Telegram.Bot.API.Payments

type Rep SendInvoiceRequest = D1 ('MetaData "SendInvoiceRequest" "Telegram.Bot.API.Payments" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "SendInvoiceRequest" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "sendInvoiceRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChatId) :*: (S1 ('MetaSel ('Just "sendInvoiceRequestMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageThreadId)) :*: S1 ('MetaSel ('Just "sendInvoiceRequestTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "sendInvoiceRequestDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "sendInvoiceRequestPayload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "sendInvoiceRequestProviderToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "sendInvoiceRequestCurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "sendInvoiceRequestPrices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [LabeledPrice]) :*: (S1 ('MetaSel ('Just "sendInvoiceRequestMaxTipAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "sendInvoiceRequestSuggestedTipAmounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Integer])))) :*: ((S1 ('MetaSel ('Just "sendInvoiceRequestStartParameter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sendInvoiceRequestProviderData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sendInvoiceRequestPhotoUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sendInvoiceRequestPhotoSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))))) :*: (((S1 ('MetaSel ('Just "sendInvoiceRequestPhotoWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "sendInvoiceRequestPhotoHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "sendInvoiceRequestNeedName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "sendInvoiceRequestNeedPhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendInvoiceRequestNeedEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "sendInvoiceRequestNeedShippingAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendInvoiceRequestSendPhoneNumberToProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "sendInvoiceRequestSendEmailToProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "sendInvoiceRequestIsFlexible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendInvoiceRequestDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "sendInvoiceRequestProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendInvoiceRequestReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :*: (S1 ('MetaSel ('Just "sendInvoiceRequestAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendInvoiceRequestReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup))))))))

type SendInvoice = "sendInvoice" :> (ReqBody '[JSON] SendInvoiceRequest :> Post '[JSON] (Response Message))

sendInvoice :: SendInvoiceRequest -> ClientM (Response Message)

Use this method to send invoices. On success, the sent Message is returned.

createInvoiceLink

data CreateInvoiceLinkRequest

Constructors

CreateInvoiceLinkRequest

Fields

• createInvoiceLinkRequestTitle :: Text

  Product name, 1-32 characters.

• createInvoiceLinkRequestDescription :: Text

  Product description, 1-255 characters.

• createInvoiceLinkRequestPayload :: Text

  Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

• createInvoiceLinkRequestProviderToken :: Text

  Payment provider token, obtained via BotFather.

• createInvoiceLinkRequestCurrency :: Text

  Three-letter ISO 4217 currency code, see more on currencies.

• createInvoiceLinkRequestPrices :: [LabeledPrice]

  Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).

• createInvoiceLinkRequestMaxTipAmount :: Maybe Integer

  The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0.

• createInvoiceLinkRequestSuggestedTipAmounts :: Maybe [Integer]

  A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.

• createInvoiceLinkRequestProviderData :: Maybe Text

  JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.

• createInvoiceLinkRequestPhotoUrl :: Maybe Text

  URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.

• createInvoiceLinkRequestPhotoSize :: Maybe Int

  Photo size in bytes.

• createInvoiceLinkRequestPhotoWidth :: Maybe Int

  Photo width.

• createInvoiceLinkRequestPhotoHeight :: Maybe Int

  Photo height

• createInvoiceLinkRequestNeedName :: Maybe Bool

  Pass True if you require the user's full name to complete the order.

• createInvoiceLinkRequestNeedPhoneNumber :: Maybe Bool

  Pass True if you require the user's phone number to complete the order.

• createInvoiceLinkRequestNeedEmail :: Maybe Bool

  Pass True if you require the user's email address to complete the order.

• createInvoiceLinkRequestNeedShippingAddress :: Maybe Bool

  Pass True if you require the user's shipping address to complete the order.

• createInvoiceLinkRequestSendPhoneNumberToProvider :: Maybe Bool

  Pass True if the user's phone number should be sent to the provider.

• createInvoiceLinkRequestSendEmailToProvider :: Maybe Bool

  Pass True if the user's email address should be sent to the provider.

• createInvoiceLinkRequestIsFlexible :: Maybe Bool

  Pass True if the final price depends on the shipping method.

Instances

Show CreateInvoiceLinkRequest

Defined in Telegram.Bot.API.Payments

Methods

showsPrec :: Int -> CreateInvoiceLinkRequest -> ShowS

show :: CreateInvoiceLinkRequest -> String

showList :: [CreateInvoiceLinkRequest] -> ShowS

Generic CreateInvoiceLinkRequest

Defined in Telegram.Bot.API.Payments

Associated Types

type Rep CreateInvoiceLinkRequest :: Type -> Type

Methods

from :: CreateInvoiceLinkRequest -> Rep CreateInvoiceLinkRequest x

to :: Rep CreateInvoiceLinkRequest x -> CreateInvoiceLinkRequest

FromJSON CreateInvoiceLinkRequest

Defined in Telegram.Bot.API.Payments

Methods

parseJSON :: Value -> Parser CreateInvoiceLinkRequest

parseJSONList :: Value -> Parser [CreateInvoiceLinkRequest]

ToJSON CreateInvoiceLinkRequest

Defined in Telegram.Bot.API.Payments

Methods

toJSON :: CreateInvoiceLinkRequest -> Value

toEncoding :: CreateInvoiceLinkRequest -> Encoding

toJSONList :: [CreateInvoiceLinkRequest] -> Value

toEncodingList :: [CreateInvoiceLinkRequest] -> Encoding

type Rep CreateInvoiceLinkRequest

Defined in Telegram.Bot.API.Payments

type Rep CreateInvoiceLinkRequest = D1 ('MetaData "CreateInvoiceLinkRequest" "Telegram.Bot.API.Payments" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "CreateInvoiceLinkRequest" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "createInvoiceLinkRequestTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "createInvoiceLinkRequestDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "createInvoiceLinkRequestPayload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "createInvoiceLinkRequestProviderToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "createInvoiceLinkRequestCurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "createInvoiceLinkRequestPrices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [LabeledPrice]) :*: S1 ('MetaSel ('Just "createInvoiceLinkRequestMaxTipAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "createInvoiceLinkRequestSuggestedTipAmounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Integer])) :*: (S1 ('MetaSel ('Just "createInvoiceLinkRequestProviderData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createInvoiceLinkRequestPhotoUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "createInvoiceLinkRequestPhotoSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "createInvoiceLinkRequestPhotoWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "createInvoiceLinkRequestPhotoHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "createInvoiceLinkRequestNeedName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "createInvoiceLinkRequestNeedPhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "createInvoiceLinkRequestNeedEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "createInvoiceLinkRequestNeedShippingAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "createInvoiceLinkRequestSendPhoneNumberToProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "createInvoiceLinkRequestSendEmailToProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "createInvoiceLinkRequestIsFlexible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))))

type CreateInvoiceLink = "createInvoiceLink" :> (ReqBody '[JSON] CreateInvoiceLinkRequest :> Post '[JSON] (Response Text))

createInvoiceLink :: CreateInvoiceLinkRequest -> ClientM (Response Text)

Use this method to create a link for an invoice. Returns the created invoice link as Text on success.

answerShippingQuery

data AnswerShippingQueryRequest

Constructors

AnswerShippingQueryRequest

Fields

• answerShippingQueryRequestShippingQueryId :: Text

  Unique identifier for the query to be answered.

• answerShippingQueryRequestOk :: Bool

  Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible).

• answerShippingQueryRequestShippingOptions :: Maybe [ShippingOption]

  Required if ok is True. A JSON-serialized array of available shipping options.

• answerShippingQueryRequestErrorMessage :: Maybe Text

  Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.

Instances

Show AnswerShippingQueryRequest

Defined in Telegram.Bot.API.Payments

Methods

showsPrec :: Int -> AnswerShippingQueryRequest -> ShowS

show :: AnswerShippingQueryRequest -> String

showList :: [AnswerShippingQueryRequest] -> ShowS

Generic AnswerShippingQueryRequest

Defined in Telegram.Bot.API.Payments

Associated Types

type Rep AnswerShippingQueryRequest :: Type -> Type

Methods

from :: AnswerShippingQueryRequest -> Rep AnswerShippingQueryRequest x

to :: Rep AnswerShippingQueryRequest x -> AnswerShippingQueryRequest

FromJSON AnswerShippingQueryRequest

Defined in Telegram.Bot.API.Payments

Methods

parseJSON :: Value -> Parser AnswerShippingQueryRequest

parseJSONList :: Value -> Parser [AnswerShippingQueryRequest]

ToJSON AnswerShippingQueryRequest

Defined in Telegram.Bot.API.Payments

Methods

toJSON :: AnswerShippingQueryRequest -> Value

toEncoding :: AnswerShippingQueryRequest -> Encoding

toJSONList :: [AnswerShippingQueryRequest] -> Value

toEncodingList :: [AnswerShippingQueryRequest] -> Encoding

type Rep AnswerShippingQueryRequest

Defined in Telegram.Bot.API.Payments

type Rep AnswerShippingQueryRequest = D1 ('MetaData "AnswerShippingQueryRequest" "Telegram.Bot.API.Payments" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "AnswerShippingQueryRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "answerShippingQueryRequestShippingQueryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "answerShippingQueryRequestOk") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "answerShippingQueryRequestShippingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [ShippingOption])) :*: S1 ('MetaSel ('Just "answerShippingQueryRequestErrorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

type AnswerShippingQuery = "answerShippingQuery" :> (ReqBody '[JSON] AnswerShippingQueryRequest :> Post '[JSON] (Response Bool))

answerShippingQuery :: AnswerShippingQueryRequest -> ClientM (Response Bool)

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

answerPreCheckoutQuery

data AnswerPreCheckoutQueryRequest

Constructors

AnswerPreCheckoutQueryRequest

Fields

• answerPreCheckoutQueryRequestPreCheckoutQueryId :: Text

  Unique identifier for the query to be answered.

• answerPreCheckoutQueryRequestOk :: Bool

  Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.

• answerPreCheckoutQueryRequestErrorMessage :: Maybe Text

  Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.

Instances

Show AnswerPreCheckoutQueryRequest

Defined in Telegram.Bot.API.Payments

Methods

showsPrec :: Int -> AnswerPreCheckoutQueryRequest -> ShowS

show :: AnswerPreCheckoutQueryRequest -> String

showList :: [AnswerPreCheckoutQueryRequest] -> ShowS

Generic AnswerPreCheckoutQueryRequest

Defined in Telegram.Bot.API.Payments

Associated Types

type Rep AnswerPreCheckoutQueryRequest :: Type -> Type

Methods

from :: AnswerPreCheckoutQueryRequest -> Rep AnswerPreCheckoutQueryRequest x

to :: Rep AnswerPreCheckoutQueryRequest x -> AnswerPreCheckoutQueryRequest

FromJSON AnswerPreCheckoutQueryRequest

Defined in Telegram.Bot.API.Payments

Methods

parseJSON :: Value -> Parser AnswerPreCheckoutQueryRequest

parseJSONList :: Value -> Parser [AnswerPreCheckoutQueryRequest]

ToJSON AnswerPreCheckoutQueryRequest

Defined in Telegram.Bot.API.Payments

Methods

toJSON :: AnswerPreCheckoutQueryRequest -> Value

toEncoding :: AnswerPreCheckoutQueryRequest -> Encoding

toJSONList :: [AnswerPreCheckoutQueryRequest] -> Value

toEncodingList :: [AnswerPreCheckoutQueryRequest] -> Encoding

type Rep AnswerPreCheckoutQueryRequest

Defined in Telegram.Bot.API.Payments

type Rep AnswerPreCheckoutQueryRequest = D1 ('MetaData "AnswerPreCheckoutQueryRequest" "Telegram.Bot.API.Payments" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "AnswerPreCheckoutQueryRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "answerPreCheckoutQueryRequestPreCheckoutQueryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "answerPreCheckoutQueryRequestOk") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "answerPreCheckoutQueryRequestErrorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

type AnswerPreCheckoutQuery = "answerPreCheckoutQuery" :> (ReqBody '[JSON] AnswerPreCheckoutQueryRequest :> Post '[JSON] (Response Bool))

answerPreCheckoutQuery :: AnswerPreCheckoutQueryRequest -> ClientM (Response Bool)

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.