Skip to content

Commit 1e31714

Browse files
Add payment type documentation
1 parent 5844ea1 commit 1e31714

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

types.go

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1642,7 +1642,7 @@ type Invoice struct {
16421642
// Currency three-letter ISO 4217 currency code
16431643
// (see https://core.telegram.org/bots/payments#supported-currencies)
16441644
Currency string `json:"currency"`
1645-
// TotalAmount otal price in the smallest units of the currency (integer, not float/double).
1645+
// TotalAmount total price in the smallest units of the currency (integer, not float/double).
16461646
// For example, for a price of US$ 1.45 pass amount = 145.
16471647
// See the exp parameter in currencies.json
16481648
// (https://core.telegram.org/bots/payments/currencies.json),
@@ -1672,7 +1672,7 @@ type ShippingAddress struct {
16721672
State string `json:"state"`
16731673
// City city
16741674
City string `json:"city"`
1675-
// StreetLine1 fFirst line for the address
1675+
// StreetLine1 first line for the address
16761676
StreetLine1 string `json:"street_line1"`
16771677
// StreetLine2 second line for the address
16781678
StreetLine2 string `json:"street_line2"`
@@ -1712,13 +1712,30 @@ type ShippingOption struct {
17121712

17131713
// SuccessfulPayment contains basic information about a successful payment.
17141714
type SuccessfulPayment struct {
1715-
Currency string `json:"currency"`
1716-
TotalAmount int `json:"total_amount"`
1717-
InvoicePayload string `json:"invoice_payload"`
1718-
ShippingOptionID string `json:"shipping_option_id,omitempty"`
1719-
OrderInfo *OrderInfo `json:"order_info,omitempty"`
1720-
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
1721-
ProviderPaymentChargeID string `json:"provider_payment_charge_id"`
1715+
// Currency three-letter ISO 4217 currency code
1716+
// (see https://core.telegram.org/bots/payments#supported-currencies)
1717+
Currency string `json:"currency"`
1718+
// TotalAmount total price in the smallest units of the currency (integer, not float/double).
1719+
// For example, for a price of US$ 1.45 pass amount = 145.
1720+
// See the exp parameter in currencies.json,
1721+
// (https://core.telegram.org/bots/payments/currencies.json)
1722+
// it shows the number of digits past the decimal point
1723+
// for each currency (2 for the majority of currencies).
1724+
TotalAmount int `json:"total_amount"`
1725+
// InvoicePayload bot specified invoice payload
1726+
InvoicePayload string `json:"invoice_payload"`
1727+
// ShippingOptionID identifier of the shipping option chosen by the user
1728+
//
1729+
// optional
1730+
ShippingOptionID string `json:"shipping_option_id,omitempty"`
1731+
// OrderInfo order info provided by the user
1732+
//
1733+
// optional
1734+
OrderInfo *OrderInfo `json:"order_info,omitempty"`
1735+
// TelegramPaymentChargeID telegram payment identifier
1736+
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
1737+
// ProviderPaymentChargeID provider payment identifier
1738+
ProviderPaymentChargeID string `json:"provider_payment_charge_id"`
17221739
}
17231740

17241741
// ShippingQuery contains information about an incoming shipping query.

0 commit comments

Comments
 (0)