cross-switch

Cross-Switch Ghana

Issues

Star

License

Nodejs API wrapper for Cross-Switch Ghana.

Installation

npm install cross-switch

Usaged

var live = false;

if (process.env.NODE_ENV === 'production') {
	live = true;
}
// Require the library
var cross_switch = require('cross-switch')(process.env.APP_ID, process.env.APP_KEY, live);

Making calls to the resources

The resource methods accepts are promisified, but can receive optional callback as the last argument.

// cross_switch.{resource}
cross_switch.payment.createPayment({})
	.then((body)=> {
  		console.log(body);
	})
	.catch((error)=> {
		console.log(error);
	});

For all resource methods, the JSON body can be passed as the argument.

Resources

• payment
  • createPayment
  • Collection
  • Cashout
  • getBalance
  • verifyPayment
  • Ota
• sms
  • Coming soon

Method to Initiation Sending or Receiving from mobile Money.

	cross_switch.payment.createPayment({
		type: 'Receive || Send',
		name: 'Harmony Alabi',
		mobile: '[phone]',
		mobile_network: 'MTN',
		email: '[e-mail]',
		currency: 'GHS',
		amount: 0.1,
		order_id: `${Math.ceil(Math.random() * 10e8)}`,
		order_desc: 'Testing',
		account: '',
		signature: '',
		callback: ''
	}).then((body)=> {
		console.log(body);
	}).catch((error)=> {
		console.log(error);
	});

Method to Initiation Only Receiving from mobile Money.

	cross_switch.payment.Collection({
		name: 'Harmony Alabi',
		mobile: '[phone]',
		mobile_network: 'MTN',
		email: '[e-mail]',
		currency: 'GHS',
		amount: 0.1,
		order_id: `${Math.ceil(Math.random() * 10e8)}`,
		order_desc: 'Testing',
		account: '',
		signature: '',
		callback: ''
	}).then((body)=> {
		console.log(body);
	}).catch((error)=> {
		console.log(error);
	});;

Method to Initiation Only Receiving from mobile Money.

	cross_switch.payment.Cashout({
		name: 'Harmony Alabi',
		mobile: '[phone]',
		mobile_network: 'MTN',
		email: '[e-mail]',
		currency: 'GHS',
		amount: 0.1,
		order_id: `${Math.ceil(Math.random() * 10e8)}`,
		order_desc: 'Testing',
	}).then((body)=> {
		console.log(body);
	}).catch((error)=> {
		console.log(error);
	});

Method to Get Cashout Balance.

	cross_switch.payment.getBalance({})
	.then((body)=> {
		console.log(body);
	}).catch((error)=> {
		console.log(error);
	});

Method to Verify Transaction status.

	cross_switch.payment.verifyPayment({
		order_id: `${data.transaction_no}`,
	}).then((body)=> {
		console.log(body);
	}).catch((error)=> {
		console.log(error);
	});

Todo

• Add MOMO Number Verification
• Add MOMO Direct Debit
• Sms