CRMchat APIBeta
Telegram APIPayments

payments.getStarsTransactionsByID

POST
/workspaces/{workspaceId}/telegram-accounts/{accountId}/call/payments.getStarsTransactionsByID

Obtain info about Telegram Star transactions » using specific transaction IDs.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

workspaceId*string

Workspace ID

accountId*string

Telegram account ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

params*

Obtain info about Telegram Star transactions » using specific transaction IDs.

Response Body

application/json

application/json

curl -X POST "https://example.com/workspaces/string/telegram-accounts/string/call/payments.getStarsTransactionsByID" \  -H "Content-Type: application/json" \  -d '{    "params": {      "peer": {        "_": "inputPeerEmpty"      },      "id": [        {          "_": "inputStarsTransaction",          "id": "string"        }      ]    }  }'
{  "result": {    "_": "payments.starsStatus",    "balance": {      "_": "starsAmount",      "amount": "string",      "nanos": 0    },    "subscriptions": [      {        "_": "starsSubscription",        "canceled": true,        "canRefulfill": true,        "missingBalance": true,        "botCanceled": true,        "id": "string",        "peer": {          "_": "peerUser",          "userId": 0        },        "untilDate": 0,        "pricing": {          "_": "starsSubscriptionPricing",          "period": 0,          "amount": "string"        },        "chatInviteHash": "string",        "title": "string",        "photo": {          "_": "webDocument",          "url": "string",          "accessHash": "string",          "size": 0,          "mimeType": "string",          "attributes": [            {              "_": "documentAttributeImageSize",              "w": 0,              "h": 0            }          ]        },        "invoiceSlug": "string"      }    ],    "subscriptionsNextOffset": "string",    "subscriptionsMissingBalance": "string",    "history": [      {        "_": "starsTransaction",        "refund": true,        "pending": true,        "failed": true,        "gift": true,        "reaction": true,        "stargiftUpgrade": true,        "businessTransfer": true,        "stargiftResale": true,        "postsSearch": true,        "stargiftPrepaidUpgrade": true,        "stargiftDropOriginalDetails": true,        "phonegroupMessage": true,        "stargiftAuctionBid": true,        "offer": true,        "id": "string",        "amount": {          "_": "starsAmount",          "amount": "string",          "nanos": 0        },        "date": 0,        "peer": {          "_": "starsTransactionPeerUnsupported"        },        "title": "string",        "description": "string",        "photo": {          "_": "webDocument",          "url": "string",          "accessHash": "string",          "size": 0,          "mimeType": "string",          "attributes": [            {              "_": "documentAttributeImageSize",              "w": 0,              "h": 0            }          ]        },        "transactionDate": 0,        "transactionUrl": "string",        "botPayload": "string",        "msgId": 0,        "extendedMedia": [          {            "_": "messageMediaEmpty"          }        ],        "subscriptionPeriod": 0,        "giveawayPostId": 0,        "stargift": {          "_": "starGift",          "limited": true,          "soldOut": true,          "birthday": true,          "requirePremium": true,          "limitedPerUser": true,          "peerColorAvailable": true,          "auction": true,          "id": "string",          "sticker": {            "_": "documentEmpty",            "id": "string"          },          "stars": "string",          "availabilityRemains": 0,          "availabilityTotal": 0,          "availabilityResale": "string",          "convertStars": "string",          "firstSaleDate": 0,          "lastSaleDate": 0,          "upgradeStars": "string",          "resellMinStars": "string",          "title": "string",          "releasedBy": {            "_": "peerUser",            "userId": 0          },          "perUserTotal": 0,          "perUserRemains": 0,          "lockedUntilDate": 0,          "auctionSlug": "string",          "giftsPerRound": 0,          "auctionStartDate": 0,          "upgradeVariants": 0,          "background": {            "_": "starGiftBackground",            "centerColor": 0,            "edgeColor": 0,            "textColor": 0          }        },        "floodskipNumber": 0,        "starrefCommissionPermille": 0,        "starrefPeer": {          "_": "peerUser",          "userId": 0        },        "starrefAmount": {          "_": "starsAmount",          "amount": "string",          "nanos": 0        },        "paidMessages": 0,        "premiumGiftMonths": 0,        "adsProceedsFromDate": 0,        "adsProceedsToDate": 0      }    ],    "nextOffset": "string",    "chats": [      {        "_": "chatEmpty",        "id": 0      }    ],    "users": [      {        "_": "userEmpty",        "id": 0      }    ]  }}