Paid API

NPM

npm install paid-api

Using the API

const Paid = require('paid');
const paid = new Paid({
  key: '{your-key}'
});

For post requests, include a data object that follows this pattern

const params = {
  id: '12345',
  data: {
    amount: 500,
    description: 'test'
  }
}
paid.v1.createPlan(params, (err, response, body) => {})

Methods available on paid.v1:

  //Get Account Details
  paid.v1.getAccountDetails(callback);

  //Create new customer
  paid.v1.createCustomer(data, callback);

  //Get all customers
  paid.v1.getAllCustomers(data, callback);

  //Get single customer by id
  paid.v1.getCustomer(data, callback);

  //Update customer
  paid.v1.updateCustomer({id: recipient_id}, callback);

  //Get event by id
  paid.v1.getEvent({id: recipient_id, data: {}}, callback);

  //Get all events
  paid.v1.getAllEvents({id: recipient_id}, callback);

  //Get all invoices
  paid.v1.getAllInvoices(callback);

  //Get invoice by id
  paid.v1.getInvoice(data, callback);

  //Update invoice
  paid.v1.updateInvoice({id: wallet_id}, callback);

  //Generate invoices
  paid.v1.generateInvoices({id: wallet_id}, callback);

  //Issue invoice
  paid.v1.issueInvoice(data, callback);

  //Mark invoice as paid
  paid.v1.markAsPaid(callback);

  //List all plans
  paid.v1.listAllPlans({id: transfer_id}, callback);

  //Create plan
  paid.v1.createPlan({id: transfer_id}, callback);

  //Get plan by id
  paid.v1.getPlan({id: transfer_id}, callback);

  //Update plan
  paid.v1.updatePlan({id: transfer_id}, callback);

  //List all subscriptions
  paid.v1.listAllSubscriptions({id: transfer_id}, callback);

  //Create subscription
  paid.v1.createSubscription({id: transfer_id}, callback);

  //Get subscription by id
  paid.v1.getSubscription({id: transfer_id}, callback);

  //List all transactions
  paid.v1.listTransactions({id: transfer_id}, callback);

  //Create transaction
  paid.v1.createTransaction({id: transfer_id}, callback);

  //Get transaction by id
  paid.v1.getTransaction({id: transfer_id}, callback);

  //Update transaction
  paid.v1.updateTransaction({id: transfer_id}, callback);

  //Mark transaction as paid
  paid.v1.markTransaction({id: transfer_id}, callback);

  //Refund transaction
  paid.v1.refundTransaction({id: transfer_id}, callback);

  //Delete transaction
  paid.v1.deleteTransaction({id: transfer_id}, callback);

API

For full documentation, check out the official Paid API docs