cryptopay v1.3.3

Cryptopay

The unofficial Node.js library for the Cryptopay API.

Credentials

In order to use the Cryptopay API, you need to register on their website. After registration, you can create API keys. Create one and provide the details from that to the constructor function.

Usage

Installation

npm i cryptopay

Setup

const CryptopayClient = require("cryptopay");

const client = new CryptopayClient({
  apiKey: "api key here", // Your Cryptopay API Key
  apiSecret: "api secret here", // Your Cryptopay API Secret
  sandbox: false // Uses sandbox/development endpoints if true
});

Methods

getAllRates()

Get all public rates for cryptocurrencies.

Parameters

None

Returns

• Promise (Multiple Objects with buy_rate and sell_rate keys)

Example

client.getAllRates().then(rates => {
  //...do something with the rates
});

getPairRate()

Get rate for a specific cryptocurrency pair.

Parameters

Returns

• Promise (Object with buy_rate and sell_rate keys)

Example

client.getPairRate("BTCEUR").then(rate => {
  //...do something with the rate
});

getAccounts()

Get all user created accounts.

Parameters

None

Returns

• Promise (Array of AccountObject's)

Example

client.getAccounts().then(accounts => {
  //...do something with the accounts
});

getAccountTransactions()

Get all account transactions.

Parameters

Returns

• Promise (Array of TransactionObject's)

Example

client
  .getAccountTransactions("91202339-52e2-432d-8078-12d49d96ce02")
  .then(transactions => {
    //...do something with the transactions
  });

createChannel()

Create channel and crypto address for the user

Parameters

Returns

• Promise (ChannelObject)

Example

client
  .createChannel({
    pay_currency: "BTC",
    receiver_currency: "EUR",
    custom_id: "123456",
    name: "Deposit",
    description: "Deposit Address for User X"
  })
  .then(channel => {
    //...do something with the channel
  });

getAllChannels()

Get all channels created

Parameters

None

Returns

• Promise (Array of ChannelObject's)

Example

client.getAllChannels().then(channels => {
  //...do something with the channels
});

getChannelPayments()

Get all specific channel payments

Parameters

Returns

• Promise (Array of PaymentObject's)

Example

client
  .getChannelPayments("50eb5775-f77e-4c64-870b-dc93624b5967")
  .then(channels => {
    //...do something with the channels
  });

createCoinPayment()

Create a coin withdrawal payment

Parameters

Returns

• Promise (PaymentObject)

Example

client
  .createCoinPayment({
    charged_currency: "EUR",
    received_currency: "BTC",
    charged_amount: 10,
    address: "2N122JKRz52gokTmaVYNiMA43qvdSqnhLGV",
    custom_id: "123456"
  })
  .then(payment => {
    //...do something with the payment
  });

commitCoinPayment()

Commit a coin withdrawal payment

Parameters

Returns

• Promise (PaymentObject)

Example

client
  .commitCoinPayment("50eb5775-f77e-4c64-870b-dc93624b5967")
  .then(payment => {
    //...do something with the payment
  });

Objects

AccountObject

TransactionObject

ChannelObject

PaymentObject