💸 node-payfast

A node library to simplify creating custom integrations with Payfast.

Installation

npm install node-payfast yarn add node-payfast

Usage

// server.js

const {PayFast} = require('node-payfast');

const  config  = {
sandbox: true, // Defaults to false
merchant_id: process.env.MERCHANT_ID,
merchant_key: process.env.MERCHANT_KEY,
passphrase: process.env.PASSPHRASE
}

// Initialize a new Payfast instance with your config data.
const  pf  =  new PayFast(config);

// Very important to keep the order of the parameters as per Payfast's documentation, else it will drive you mad, cause the signature won't validate.
// I know, it's dumb, but that's how it is till Payfast's dev team fixes it.

var  paymentData  = {
return_url: 'https://www.someurl.com/success',
cancel_url: 'https://www.someurl.com/cancel',
notify_url: 'https://www.someurl.com/notify',
name_first: 'John',
name_last: 'Doe',
email_address: 'john@doe.com',
amount: '300.00',
item_name: 'Cheese',
item_description: '1 block of cheese',
// add extra lines for subscriptions, etc.
};

async  function  getPaymentURL() {
// Keep each function seperate as it may have for future features:

const  urlString  =  pf.createStringfromObject(paymentData);
const  hash  =  pf.createSignature(urlString);
const  paymentObject  =  pf.createPaymentObject(paymentData, hash);
const  generatePaymentUrl  =  await  pf.generatePaymentUrl(paymentObject);
return  generatePaymentUrl;
// It will return a URL like https://sandbox.payfast.co.za/eng/process/payment/9d64e7f4-bca2-4db1-a0b8-41f32e905c0d
// Send that URL to your frontend or redirect user to it, or however you wish to use it.
};

Roadmap 🛣

• Create URL String from payment data
• Generate Signature
• Sends request with Payment data and returns Payment page URL (Inspired by Stripe)
• Webhook validation
• Split Payments