@muxel/crypto-pay-api-sdk

SDK for working with Crypto Bot

Installation

pip install crypto-pay-api-sdk

Explanation

First, you need to create your application and get an API token. Open @CryptoBot or @CryptoTestnetBot (for testnet), end a command /pay to create a new app and get API Token.

All queries to the Crypto Pay API must be sent over HTTPS

Examples

Support for all methods official API

from crypto_pay_api_sdk import cryptopay

Crypto = cryptopay.Crypto("TOKEN", testnet = True) #default testnet = False

print(Crypto.getMe())
print(Crypto.createInvoice("TON", "0.4", params={"description": "Test Invoice",
                                                 "expires_in": 300
                                                 }))

Methods

API

• getMe
• createInvoice
• transfer
• getInvoices
• getBalance
• getExchangeRates
• getCurrencies

getMe

A simple method for testing your app's authentication token. Requires no parameters. Returns basic information about the app.

Crypto.getMe()

createInvoice

Use this method to create a new invoice. Returns object of created invoice.

• asset (string) Currency code. Supported assets: BTC, TON, ETH (only testnet), USDT, USDC, BUSD.

• amount (string) Amount of the invoice in float. For example: 125.50

• description (string) Optional. Description of the invoice. Up to 1024 symbols.

• hidden_message (string) Optional. The message will show when the user pays your invoice.

• paid_btn_name (string) default - callback Optional. Paid button name. This button will be shown when your invoice was paid. Supported names:

  • viewItem - View Item
  • openChannel - Open Channel
  • openBot - Open Bot
  • callback - Return

• paid_btn_url (string) Optional but requried when you use paid_btn_name. Paid button URL. You can set any payment success link (for example link on your bot). Start with https or http.

• payload (string, up to 4kb) Optional. Some data. User ID, payment id, or any data you want to attach to the invoice.

• allow_comments (boolean) Optional. Allow adding comments when paying an invoice. Default is true.

• allow_anonymous (boolean) Optional. Allow pay invoice as anonymous. Default is true.

• expires_in (number) Optional. You can set the expiration date of the invoice in seconds. Use this period: 1-2678400 seconds.

Crypto.createInvoice("BTC", 1,
                    params = {
                        description: 'kitten',
                        paid_btn_name: viewItem,
                        paid_btn_url: 'http://placekitten.com/150'
                    })

transfer

Use this method to send coins from your app to the user. Returns object of completed transfer.

• user_id (number) Telegram User ID. The user needs to have an account in our bot (send /start if no).
• asset (string) Currency code. Supported assets: BTC, TON, ETH (only testnet), USDT, USDC, BUSD.
• amount (string) Amount of the transfer in float. For example: 125.50
• spend_id (string) It is used to make your request idempotent. It's guaranteed that only one of the transfers with the same spend_id will be accepted by Crypto Pay API. This parameter is useful when the transfer should be retried (i.e. request timeout/connection reset/500 HTTP status/etc). You can use a withdrawal id or something. Up to 64 symbols.
• comment (string) Optional. The comment of the invoice. The comment will show in the notification about the transfer. Up to 1024 symbols.

Crypto.transfer(121011054, 'ETH',
                0.1, 'ZG9uYXRl',
                params = {
                    comment: 'donate'
                })

getInvoices

Use this method to get invoices of your app. On success, the returns array of invoices.

• asset (string) Optional. Currency code. Supported assets: BTC, TON, ETH (only testnet), USDT, USDC, BUSD. Default: all assets.
• invoice_ids (string) Optional. Invoice IDs separated by comma.
• status (string) Optional. Status of invoices. Available statusses: active or paid. Default: all statusses.
• offset (number) Optional. Offset needed to return a specific subset of invoices. Default 0.
• count (number) Optional. Number of invoices to return. Default 100, max 1000.

Crypto.getInvoices(assets = "TON", count = 1)

getBalance

Use this method to get balance of your app. Returns array of assets.

Crypto.getBalance()

getExchangeRates

Use this method to get exchange rates of supported currencies. Returns array of currencies.

Crypto.getExchangeRates()

getCurrencies

Use this method to supported currencies. Returns array of currencies.

Crypto.getCurrencies()

License

MIT