@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

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'
});

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.

Methods

• getMe
• createInvoice
• getInvoices
• getPayments
• confirmPayment
• getBalance
• getExchangeRates
• getCurrencies

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 (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.

• 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 1kb) 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.

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

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.

cryptoPay.getInvoices({ asset: Assets.BTC, count: 10 })

getPayments

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

• 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.

cryptoPay.getPayments({ offset: 200, count: 100 })

confirmPayment

Use this method to confirm paid invoice of your app. On success, the return confirmed invoice.

• invoice_id (number) Invoice ID you want to confirm.

cryptoPay.confirmPayment(42)

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()

Constants

Assets

Paid Button Names