CoinForBarter Nodejs Library - Integrate and Manage cryptocurrency payments for goods and services
- About
- Getting Started
- Usage
- Services and Methods
- Deployment
- Built Using
- CoinForBarter API References
This is a NodeJs package for implementing CoinForBarter.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. See references for links to dashboard and API documentation.
$ npm install coinforbarter-node
# or
$ yarn add coinforbarter-node
const CoinForBarter = require('coinforbarter-node');
const publicKey = 'xxxxxxxxxxxxx';
const privateKey = 'xxxxxxxxxxxxx';
const secretHash = 'xxxxxxxxxxxxx';
const coinforbarter = new CoinForBarter(publicKey, privateKey, secretHash);
# An example to get all customers
const customers = coinforbarter.Customer.findAll();
This method handles all customers related to your account. The methods exposed by this service are listed below. See customer object properties
This method gets the list of all customers.
const query = {};
const getAllCustomers = async () => {
return await coinforbarter.Customer.findAll(query);
}
See list of query parameters
This method gets a particular customer by id.
const query = {};
const customerId = '';
const getCustomer = async (customerId) => {
return await coinforbarter.Customer.findOne(customerId);
}
See list of query parameters
This method creates a customer.
const params = {};
const createCustomer = async (params) => {
return await coinforbarter.Customer.create(params);
}
This method updates a customer.
const params = {};
const updateCustomer = async (params) => {
return await coinforbarter.Customer.update(params);
}
See customer update parameters
This method handles all bank account related to your account. The methods exposed by this service are listed below. See bank account object properties
const query = {};
const getBankAccountName = async () => {
return await coinforbarter.BankAccount.getBankAccountName(query);
}
See list of query parameters
const parms = {};
const createBankAccount = async (parms) => {
return await coinforbarter.BankAccount.create(parms);
}
See list of query parameters
This method gets the list of all bank accounts.
const query = {};
const getAllBankAccounts = async () => {
return await coinforbarter.BankAccount.findAll(query);
}
See list of query parameters
const query = {};
const bankAccountId = '';
const getBankAccount = async (bankAccountId) => {
return await coinforbarter.BankAccount.findOne(bankAccountId);
}
See list of query parameters
const parms = {};
const bankAccountId = '';
const makePrimary = async (bankAccountId) => {
return await coinforbarter.BankAccount.makePrimary(bankAccountId);
}
See list of query parameters
const query = {};
const countryCode = '';
const getBank = async (countryCode) => {
return await coinforbarter.BankAccount.getBanks(countryCode);
}
See list of query parameters
This method handles all payments related to your account. The methods exposed by this service are listed below. See payment object properties
const query = {};
const paymentId = '';
const getPayment = async (paymentId) => {
return await coinforbarter.Payment.findOne(paymentId);
}
See list of query parameters
const params = {};
const createPayment = async (params) => {
return await coinforbarter.Payment.create(params);
}
See list of query parameters
const params = {};
const setCurrency = async (params) => {
return await coinforbarter.Payment.setCurrency(params);
}
See list of query parameters
const paymentId = '';
const lockCurrency = async (paymentId) => {
return await coinforbarter.Payment.lockCurrency(paymentId);
}
See list of query parameters
const query = {};
const getAllBankAccount = async () => {
return await coinforbarter.Payment.getPaymentUpdates(query);
}
See list of query parameters
const query = {};
const paymentId = async () => {
return await coinforbarter.Payment.cancel(query);
}
See list of query parameters
const query = {};
const getAllPaymentPlan = async () => {
return await coinforbarter.PaymentPlan.findAll(query);
}
See list of query parameters
const query = {};
const getPaymentPlan = async () => {
return await coinforbarter.PaymentPlan.findOne(query);
}
See list of query parameters
const params = {};
const createPaymentPlan = async () => {
return await coinforbarter.PaymentPlan.create(params);
}
See list of query parameters
const params = {};
const updatePaymentPlan = async (params) => {
return await coinforbarter.PaymentPlan.update(params);
}
See list of query parameters
const params = {};
const createPaymentPlanSubscriber = async () => {
return await coinforbarter.PaymentPlanSubscriber.create(query);
}
See list of query parameters
const query = {};
const paymentPlanSubscriberId = '';
const getPaymentPlanSubscriber = async (paymentPlanSubscriberId) => {
return await coinforbarter.PaymentPlanSubscriber.findOne(paymentPlanSubscriberId);
}
See list of query parameters
const query = {};
const getAllPaymentPlanSubscriber = async () => {
return await coinforbarter.PaymentPlanSubscriber.findAll(query);
}
See list of query parameters
const paymentPlanSubscriberId = '';
const removePaymentPlanSubscriber = async () => {
return await coinforbarter.PaymentPlanSubscriber.remove(paymentPlanSubscriberId);
}
See list of query parameters
const query = {};
const getAllPayout = async () => {
return await coinforbarter.Payout.findAll(query);
}
See list of query parameters
const query = {};
const payOutId = '';
const getPayout = async (payOutId) => {
return await coinforbarter.Payout.findOne(payOutId);
}
See list of query parameters
const query = {};
const getAllTransactions = async () => {
return await coinforbarter.Transaction.findAll(query);
}
See list of query parameters
const query = {};
const transactionId = '';
const getTransaction = async (transactionId) => {
return await coinforbarter.Transaction.findOne(transactionId);
}
See list of query parameters
const transactionId = '';
const verifyTransaction = async (transactionId) => {
return await coinforbarter.Transaction.verify(transactionId);
}
See list of query parameters
const query = {};
const getEvent = async () => {
return await coinforbarter.Transaction.events(query);
}
See list of query parameters
const transactionId = {};
const getfeeForTransaction = async (transactionId) => {
return await coinforbarter.Transaction.getFee(transactionId);
}
See list of query parameters
const transactionId = {};
const transaction = async (transactionId) => {
return await coinforbarter.Transaction.webhook(transactionId);
}
See list of query parameters
const query = {};
const getAllTransfer = async () => {
return await coinforbarter.Transfer.findAll(query);
}
See list of query parameters
const query = {};
const transferId = '';
const getTransfer = async (transferId) => {
return await coinforbarter.Transfer.findOne(transferId);
}
See list of query parameters
const params = {};
const createTransfer = async (params) => {
return await coinforbarter.Transfer.findAll(params);
}
See list of query parameters
const query = {};
const getFeeForTransfer = async () => {
return await coinforbarter.Transfer.getFee(query);
}
See list of query parameters
const params = {};
const createWalletAddress = async (params) => {
return await coinforbarter.WalletAddress.create(params);
}
See list of query parameters
const query = {};
const getAllWalletAddress = async () => {
return await coinforbarter.WalletAddress.findAll(query);
}
See list of query parameters
const query = {};
const walletId = '';
const getWalletAddress = async (walletId) => {
return await coinforbarter.WalletAddress.findOne(walletId);
}
See list of query parameters
const query = {};
const walletAddressId = '';
const makeWalletAddressPrimary = async (walletAddressId) => {
return await coinforbarter.WalletAddress.makePrimary(walletAddressId);
}
See list of query parameters
const query = {};
const getAllWallet = async () => {
return await coinforbarter.Wallet.findAll(query);
}
See list of query parameters
const query = {};
const walletId = '';
const getWallet = async (walletId) => {
return await coinforbarter.Wallet.findOne(walletId);
}
See list of query parameters
const params = {};
const createWallet = async (params) => {
return await coinforbarter.Wallet.create(params);
}
See list of query parameters
const query = {};
const deleteWallet = async () => {
return await coinforbarter.Wallet.delete(query);
}
See list of query parameters
const query = {};
const getCountriesMisc = async () => {
return await coinforbarter.Misc.getCountries(query);
}
See list of query parameters
const query = {};
const getBalanceMisc = async () => {
return await coinforbarter.Misc.getBalance(query);
}
See list of query parameters
const query = {};
const getCurrenciesMisc = async () => {
return await coinforbarter.Misc.getCurrencies(query);
}
See list of query parameters
This SDK can be used closely with the official API Reference. All services and methods can be called this way
const customers = c4b.Customer.findAll();
i.e
c4b:{
[service]:method
}
# I will do more on documenting each method till i can complete it ๐
- Typescript
- CoinForBarter Developers Doc
- CoinForBarter API Reference
- CoinForBarter Inline Payment Doc
- CoinForBarter Dashboard
- Author - Nwachukwu, Kingsley Tochukwu
- Twitter - @tkings_
- Github - t-kings
Contributions are open, meta properties are not being returned yet by this SDK. You can send me an email via tochukwu@coinforbarter.com