SuccessfulPayment Interface

{
  "id": 2804,
  "name": "SuccessfulPayment",
  "variant": "declaration",
  "kind": 256,
  "flags": {},
  "children": [
    {
      "id": 2805,
      "name": "currency",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Three-letter ISO 4217 currency code, or \"XTR\" for payments in Telegram Stars"
          }
        ],
        "blockTags": [
          {
            "tag": "@see",
            "content": [
              {
                "kind": "inline-tag",
                "tag": "@link",
                "text": "https://core.telegram.org/bots/payments#supported-currencies",
                "target": "https://core.telegram.org/bots/payments#supported-currencies"
              }
            ]
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 2260,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 2088,
        "name": "Currency",
        "package": "tgkit"
      }
    },
    {
      "id": 2807,
      "name": "invoicePayload",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Bot specified invoice payload"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 2269,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 2809,
      "name": "orderInfo",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Order information provided by the user"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 2273,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 2812,
        "name": "OrderInfo",
        "package": "tgkit"
      }
    },
    {
      "id": 2811,
      "name": "providerPaymentChargeId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Provider payment identifier"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 2277,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 2808,
      "name": "shippingOptionId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Identifier of the shipping option chosen by the user"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 2271,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 2810,
      "name": "telegramPaymentChargeId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Telegram payment identifier"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 2275,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 2806,
      "name": "totalAmount",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Total price in the *smallest units* of the currency (integer, **not** float/double).\nFor example, for a price of "
          },
          {
            "kind": "code",
            "text": "`US$ 1.45`"
          },
          {
            "kind": "text",
            "text": " pass "
          },
          {
            "kind": "code",
            "text": "`totalAmount: 145`"
          },
          {
            "kind": "text",
            "text": ".\nSee the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json),\nit shows the number of digits past the decimal point for each currency (2 for the majority of currencies)."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 2267,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    }
  ],
  "groups": [
    {
      "title": "Properties",
      "children": [
        2805,
        2807,
        2809,
        2811,
        2808,
        2810,
        2806
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/types.ts",
      "line": 2255,
      "character": 17
    }
  ]
}