crypto-pay-api-v2

2.0.0 • Public • Published

CryptoPay

@foile/crypto-pay-api

Crypto Pay is a payment system based on @CryptoBot, which allows you to accept payments in cryptocurrency using the API.

This library help you to work with Crypto Pay via Crypto Pay API.

Install

npm i @foile/crypto-pay-api

Usage

API

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

Next step: try to call a simple getMe() method to check that everything is working welll:

const { CryptoPay } = require('@foile/crypto-pay-api');
  
const cryptoPay = new CryptoPay(token);
const app = await cryptoPay.getMe();
console.log(app);

You can setup net hostname (defaults to pay.crypt.bot) and protocol in optional param:

const cryptoPay = new CryptoPay(token, {
  hostname: 'testnet-pay.crypt.bot',
  protocol: 'https'
});
Net Bot Hostname
mainnet @CryptoBot pay.crypt.bot
testnet @CryptoTestnetBot testnet-pay.crypt.bot

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

You can find all available methods in next chapter.

Also, you can get supported assets and paid button names:

const { CryptoPay, Assets, PaidButtonNames } = require('@foile/crypto-pay-api');

const cryptoPay = new CryptoPay(token);
cryptoPay.createInvoice(Assets.BTC, 1, {
  description: 'kitten',
  paid_btn_name: PaidButtonNames.VIEW_ITEM,
  paid_btn_url: 'http://placekitten.com/150',
});

Look full code in the examples directory.

Webhooks

Use Webhooks to get updates for the app.

If you'd like to make sure that the Webhook request comes from Crypto Pay, we recommend using a secret path in the URL, e.g. https://www.example.com/<secret>.

Webhooks will send may at least one time

const cryptoPay = new CryptoPay(token, {
  webhook: {
    serverHostname: 'localhost',
    serverPort: 4200,
    path: '/secret-path'
  },
});

cryptoPay.on('invoice_paid', update => console.log(update.payload));

You can use pretty simple alias methods named from update names:

cryptoPay.invoicePaid(update => console.log(update.payload));

See all available updates here.

Methods

API

Updates

getMe

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

cryptoPay.getMe();

createInvoice

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

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

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

  • description (string) Optional. Description for the invoice. User will see this description when they pay the invoice. Up to 1024 characters.

  • hidden_message (string) Optional. Text of the message that will be shown to a user after the invoice is paid. Up to 2048 characters.

  • paid_btn_name (string) default - callback Optional. Name of the button that will be shown to a user after the invoice is paid. Supported names:

    • viewItem - View Item
    • openChannel - View Channel
    • openBot - Open Bot
    • callback - Return
  • paid_btn_url (string) Optional Required if paid_btn_name is used. URL to be opened when the button is pressed. You can set any success link (for example, a link to your bot). Starts with https or http.

  • payload (string) Optional. Any data you want to attach to the invoice (for example, user ID, payment ID, ect). Up to 4kb.

  • allow_comments (boolean) Optional. Allow a user to add a comment to the payment. Default is true.

  • allow_anonymous (boolean) Optional. Allow a user to pay the invoice anonymously. Default is true.

  • expires_in (number) Optional. You can set a payment time limit for the invoice in seconds. Values between 1-2678400 are accepted.

cryptoPay.createInvoice(Assets.BTC, 1, {
  description: 'kitten',
  paid_btn_name: PaidButtonNames.VIEW_ITEM,
  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, USDT, USDC and BUSD.
  • amount (string) Amount of the transfer in float. The minimum and maximum amounts for each of the support asset roughly correspond to the limit of 1-25000 USD. Use getExchangeRates to convert amounts. For example: 125.50
  • spend_id (string) Unique ID to make your request idempotent and ensure that only one of the transfers with the same spend_id is accepted from your app. This parameter is useful when the transfer should be retried (i.e. request timeout, connection reset, 500 HTTP status, etc). Up to 64 symbols.
  • comment (string) Optional. Comment for the transfer. Users will see this comment when they receive a notification about the transfer. Up to 1024 symbols.
  • disable_send_notification (boolean) Optional. Pass true if the user should not receive a notification about the transfer. Default is false.
cryptoPay.transfer(121011054, Assets.ETH, 0.1, 'ZG9uYXRl', { comment: 'donate' });

getInvoices

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

  • asset (string) Optional. Currency codes separated by comma. Supported assets: BTC, TON, ETH, USDT, USDC and BUSD. Defaults to all assets.
  • invoice_ids (string) Optional. Invoice IDs separated by comma.
  • status (string) Optional. Status of invoices to be returned. Available statuses: active and paid. Defaults to all statuses.
  • offset (number) Optional. Offset needed to return a specific subset of invoices. Default is 0.
  • count (number) Optional. Number of invoices to be returned. Values between 1-1000 are accepted. Default is 100.
cryptoPay.getInvoices({ asset: Assets.BTC, count: 10 });

getBalance

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

cryptoPay.getBalance();

getExchangeRates

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

cryptoPay.getExchangeRates();

getCurrencies

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

cryptoPay.getCurrencies();

on

Adds handler to the choosen update type.

cryptoPay.on('invoice_paid', update => console.log(update.payload));

invoicePaid

Adds handler to invoice_paid update.

cryptoPay.invoicePaid(update => console.log(update.payload));

once

Adds a one-time handler to the choosen update type.

cryptoPay.once('invoice_paid', update => console.log(update.payload));

off

Removes the specified listener from the listener array for the event named eventName.

const subscriber = (update) => console.log(update.payload)

cryptoPay.on('invoice_paid', subscriber);

setTimeout(
  () => cryptoPay.off('invoice_paid', subscriber),
  10000
);

Update Types

Constants

Assets

constant value
Assets.BTC BTC
Assets.TON TON
Assets.ETH ETH
Assets.USDT USDT
Assets.USDC USDC
Assets.BUSD BUSD

Paid Button Names

constant value
PaidButtonNames.VIEW_ITEM viewItem
PaidButtonNames.OPEN_CHANNEL openChannel
PaidButtonNames.OPEN_BOT openBot
PaidButtonNames.CALLBACK callback

Package Sidebar

Install

npm i crypto-pay-api-v2

Weekly Downloads

0

Version

2.0.0

License

MIT

Unpacked Size

39.5 kB

Total Files

12

Last publish

Collaborators

  • iaiiai