payments.PaymentReceipt

class pyrogram.raw.types.payments.PaymentReceipt

Receipt

Constructor of PaymentReceipt.

Details:
  • Layer: 227

  • ID: 70C4FE03

Parameters:
  • date (int 32-bit) – Date of generation

  • bot_id (int 64-bit) – Bot ID

  • provider_id (int 64-bit) – Provider ID

  • title (str) – Title

  • description (str) – Description

  • invoice (Invoice) – Invoice

  • currency (str) – Three-letter ISO 4217 currency code

  • total_amount (int 64-bit) – Total amount in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).

  • credentials_title (str) – Payment credential name

  • users (List of User) – Users

  • photo (WebDocument, optional) – Photo

  • info (PaymentRequestedInfo, optional) – Info

  • shipping (ShippingOption, optional) – Selected shipping option

  • tip_amount (int 64-bit, optional) – Tipped amount

Functions:

This object can be returned by 1 function.

payments.GetPaymentReceipt

Get payment receipt

TL Schema

payments.paymentReceipt#70c4fe03
flags:#
date:int
bot_id:long
provider_id:long
title:string
description:string
photo:flags.2?WebDocument
invoice:Invoice
info:flags.0?PaymentRequestedInfo
shipping:flags.1?ShippingOption
tip_amount:flags.3?long
currency:string
total_amount:long
credentials_title:string
users:Vector<User>

= payments.PaymentReceipt

Parameter Tree

PaymentReceipt
├── date → int
├── bot_id → long
├── provider_id → long
├── title → string
├── description → string
├── photo → WebDocument (optional)
│ ├── WebDocument
│ │ ├── url → string
│ │ ├── access_hash → long
│ │ ├── size → int
│ │ ├── mime_type → string
│ │ └── attributes → Vector < DocumentAttribute >
│ │ ├── DocumentAttributeImageSize
│ │ │ ├── w → int
│ │ │ └── h → int
│ │ ├── DocumentAttributeAnimated
│ │ ├── DocumentAttributeSticker
│ │ │ ├── mask → true (optional)
│ │ │ ├── alt → string
│ │ │ ├── stickerset → InputStickerSet
│ │ │ │ ├── InputStickerSetEmpty
│ │ │ │ ├── InputStickerSetID
│ │ │ │ ├── InputStickerSetShortName
│ │ │ │ ├── InputStickerSetAnimatedEmoji
│ │ │ │ ├── InputStickerSetDice
│ │ │ │ ├── InputStickerSetAnimatedEmojiAnimations
│ │ │ │ ├── InputStickerSetPremiumGifts
│ │ │ │ ├── InputStickerSetEmojiGenericAnimations
│ │ │ │ ├── InputStickerSetEmojiDefaultStatuses
│ │ │ │ ├── InputStickerSetEmojiDefaultTopicIcons
│ │ │ │ └── InputStickerSetTonGifts
│ │ │ └── mask_coords → MaskCoords (optional)
│ │ │ └── MaskCoords
│ │ ├── DocumentAttributeVideo
│ │ │ ├── round_message → true (optional)
│ │ │ ├── supports_streaming → true (optional)
│ │ │ ├── nosound → true (optional)
│ │ │ ├── duration → double
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ ├── preload_prefix_size → int (optional)
│ │ │ ├── video_start_ts → double (optional)
│ │ │ └── video_codec → string (optional)
│ │ ├── DocumentAttributeAudio
│ │ │ ├── voice → true (optional)
│ │ │ ├── duration → int
│ │ │ ├── title → string (optional)
│ │ │ ├── performer → string (optional)
│ │ │ └── waveform → bytes (optional)
│ │ ├── DocumentAttributeFilename
│ │ │ └── file_name → string
│ │ ├── free → true (optional)
│ │ ├── text_color → true (optional)
│ │ ├── alt → string
│ │ └── stickerset → InputStickerSet
│ │ ├── InputStickerSetEmpty
│ │ ├── InputStickerSetID
│ │ ├── InputStickerSetShortName
│ │ ├── InputStickerSetDice
│ │ ├── InputStickerSetPremiumGifts
│ │ └── InputStickerSetTonGifts
│ └── WebDocumentNoProxy
│ ├── url → string
│ ├── size → int
│ ├── mime_type → string
│ └── attributes → Vector < DocumentAttribute >
│ │ ├── w → int
│ │ └── h → int
│ │ ├── mask → true (optional)
│ │ ├── alt → string
│ │ ├── stickerset → InputStickerSet
│ │ │ ├── InputStickerSetEmpty
│ │ │ ├── InputStickerSetID
│ │ │ ├── InputStickerSetShortName
│ │ │ ├── InputStickerSetAnimatedEmoji
│ │ │ ├── InputStickerSetDice
│ │ │ ├── InputStickerSetPremiumGifts
│ │ │ └── InputStickerSetTonGifts
│ │ └── mask_coords → MaskCoords (optional)
│ │ └── MaskCoords
│ │ ├── round_message → true (optional)
│ │ ├── supports_streaming → true (optional)
│ │ ├── nosound → true (optional)
│ │ ├── duration → double
│ │ ├── w → int
│ │ ├── h → int
│ │ ├── preload_prefix_size → int (optional)
│ │ ├── video_start_ts → double (optional)
│ │ └── video_codec → string (optional)
│ │ ├── voice → true (optional)
│ │ ├── duration → int
│ │ ├── title → string (optional)
│ │ ├── performer → string (optional)
│ │ └── waveform → bytes (optional)
│ │ └── file_name → string
│ ├── free → true (optional)
│ ├── text_color → true (optional)
│ ├── alt → string
│ └── stickerset → InputStickerSet
│ ├── InputStickerSetEmpty
│ ├── InputStickerSetID
│ ├── InputStickerSetDice
├── invoice → Invoice
│ └── Invoice
│ ├── test → true (optional)
│ ├── name_requested → true (optional)
│ ├── phone_requested → true (optional)
│ ├── email_requested → true (optional)
│ ├── shipping_address_requested → true (optional)
│ ├── flexible → true (optional)
│ ├── phone_to_provider → true (optional)
│ ├── email_to_provider → true (optional)
│ ├── recurring → true (optional)
│ ├── currency → string
│ ├── prices → Vector < LabeledPrice >
│ │ └── LabeledPrice
│ │ ├── label → string
│ │ └── amount → long
│ ├── max_tip_amount → long (optional)
│ ├── suggested_tip_amounts → Vector < long > (optional)
│ ├── terms_url → string (optional)
│ └── subscription_period → int (optional)
├── info → PaymentRequestedInfo (optional)
│ └── PaymentRequestedInfo
│ ├── name → string (optional)
│ ├── phone → string (optional)
│ ├── email → string (optional)
│ └── shipping_address → PostAddress (optional)
│ └── PostAddress
│ ├── street_line1 → string
│ ├── street_line2 → string
│ ├── city → string
│ ├── state → string
│ ├── country_iso2 → string
│ └── post_code → string
├── shipping → ShippingOption (optional)
│ └── ShippingOption
│ ├── id → string
│ ├── title → string
│ └── prices → Vector < LabeledPrice >
│ └── LabeledPrice
│ ├── label → string
│ └── amount → long
├── tip_amount → long (optional)
├── currency → string
├── total_amount → long
├── credentials_title → string
└── users → Vector < User >
├── UserEmpty
│ └── id → long
└── User
├── is_self → true (optional)
├── contact → true (optional)
├── mutual_contact → true (optional)
├── deleted → true (optional)
├── bot → true (optional)
├── bot_chat_history → true (optional)
├── bot_nochats → true (optional)
├── verified → true (optional)
├── restricted → true (optional)
├── min → true (optional)
├── bot_inline_geo → true (optional)
├── support → true (optional)
├── scam → true (optional)
├── apply_min_photo → true (optional)
├── fake → true (optional)
├── bot_attach_menu → true (optional)
├── premium → true (optional)
├── attach_menu_enabled → true (optional)
├── bot_can_edit → true (optional)
├── close_friend → true (optional)
├── stories_hidden → true (optional)
├── stories_unavailable → true (optional)
├── contact_require_premium → true (optional)
├── bot_business → true (optional)
├── bot_has_main_app → true (optional)
├── bot_forum_view → true (optional)
├── bot_forum_can_manage_topics → true (optional)
├── bot_can_manage_bots → true (optional)
├── bot_guestchat → true (optional)
├── bot_guard → true (optional)
├── id → long
├── access_hash → long (optional)
├── first_name → string (optional)
├── last_name → string (optional)
├── username → string (optional)
├── phone → string (optional)
├── photo → UserProfilePhoto (optional)
│ ├── UserProfilePhotoEmpty
│ └── UserProfilePhoto
│ ├── has_video → true (optional)
│ ├── personal → true (optional)
│ ├── photo_id → long
│ ├── stripped_thumb → bytes (optional)
│ └── dc_id → int
├── status → UserStatus (optional)
│ ├── UserStatusEmpty
│ ├── UserStatusOnline
│ │ └── expires → int
│ ├── UserStatusOffline
│ │ └── was_online → int
│ ├── UserStatusRecently
│ │ └── by_me → true (optional)
│ ├── UserStatusLastWeek
│ │ └── by_me → true (optional)
│ └── UserStatusLastMonth
│ └── by_me → true (optional)
├── bot_info_version → int (optional)
├── restriction_reason → Vector < RestrictionReason > (optional)
│ └── RestrictionReason
│ ├── platform → string
│ ├── reason → string
│ └── text → string
├── bot_inline_placeholder → string (optional)
├── lang_code → string (optional)
├── emoji_status → EmojiStatus (optional)
│ ├── EmojiStatusEmpty
│ ├── EmojiStatus
│ │ ├── document_id → long
│ │ └── until → int (optional)
│ │ ├── collectible_id → long
│ │ ├── document_id → long
│ │ ├── title → string
│ │ ├── slug → string
│ │ ├── pattern_document_id → long
│ │ ├── center_color → int
│ │ ├── edge_color → int
│ │ ├── pattern_color → int
│ │ ├── text_color → int
│ │ └── until → int (optional)
│ ├── collectible_id → long
│ └── until → int (optional)
├── usernames → Vector < Username > (optional)
│ └── Username
│ ├── editable → true (optional)
│ ├── active → true (optional)
│ └── username → string
├── stories_max_id → RecentStory (optional)
│ └── RecentStory
│ ├── live → true (optional)
│ └── max_id → int (optional)
├── color → PeerColor (optional)
│ ├── PeerColor
│ │ ├── color → int (optional)
│ │ └── background_emoji_id → long (optional)
│ ├── PeerColorCollectible
│ │ ├── collectible_id → long
│ │ ├── gift_emoji_id → long
│ │ ├── background_emoji_id → long
│ │ ├── accent_color → int
│ │ ├── colors → Vector < int >
│ │ ├── dark_accent_color → int (optional)
│ │ └── dark_colors → Vector < int > (optional)
│ └── collectible_id → long
├── profile_color → PeerColor (optional)
│ ├── PeerColor
│ │ ├── color → int (optional)
│ │ └── background_emoji_id → long (optional)
│ ├── PeerColorCollectible
│ │ ├── collectible_id → long
│ │ ├── gift_emoji_id → long
│ │ ├── background_emoji_id → long
│ │ ├── accent_color → int
│ │ ├── colors → Vector < int >
│ │ ├── dark_accent_color → int (optional)
│ │ └── dark_colors → Vector < int > (optional)
│ └── collectible_id → long
├── bot_active_users → int (optional)
├── bot_verification_icon → long (optional)
└── send_paid_messages_stars → long (optional)

Example

PaymentReceipt(
    date=0,
    bot_id=0,
    provider_id=0,
    title="text",
    description="text",
    invoice=Invoice(
        currency="text",
        prices=[
                LabeledPrice(
                    label="text",
                    amount=0
                )
            ]
    ),
    currency="text",
    total_amount=0,
    credentials_title="text",
    users=[
            UserEmpty(id=0)
        ],
)