Skip to content

Latest commit

 

History

History
437 lines (276 loc) · 14.6 KB

README.md

File metadata and controls

437 lines (276 loc) · 14.6 KB
Raw

Features!

  • Merchant

    • Create Merchant
    • Get Merchant Activation Status
    • Get Merchant Profile
    • DeActivate Merchant
    • Remove Merchant

  • Payees (Customers)

    • Add Payee
    • Edit Payee
    • Remove Payee(s)
    • Import Payees

  • Cards

    • Add Card for Payee
    • Remove Card from Payee

  • Payment Transaction

    • Process Payment
    • Get Payment Transactions (filter by mechant, payee, date, keyword etc.)

  • Recurring Billing

    • Add Recurring Transaction
    • Edit Recurring Transaction
    • Remove Recurring Transaction

  • Invoice

    • Create Invoice
    • Send Invoice

  • Refund

    • Process Refund for Transaction

  • Reports/Stats

  • WebHooks.

Installation

$ npm install payment-module-prodio --save

Initialization

Require the payment-module-prodio module and initialize the payment npm module client.

 const paymentClass = require('payment-module-prodio');
 const paymentObj = new paymentClass(BASE_URL); //BASE_URL => is the url where its loopback apis are running. eg.

Method

1. Create Merchant:

This will register subscriber as merchant into the given payment gateway.

Payload

Key Type Value Description Required
action string CREATE_MERCHANT key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

Example

	const payload = {
	    "action": "CREATE_MERCHANT",
	    "meta": SAMPLE_META_INFO
	};
	//create merchant in payment module
	paymentObj.execute(payload, function(response) {
	    if (typeof response == "string" || typeof response === "string") {
	        response = JSON.parse(response);
	    }

	    if (!isNull(response.data)) {
	        let serverResponse = response["data"];
	        if (typeof serverResponse == "string" || typeof serverResponse === "string") {
	            serverResponse = JSON.parse(response["data"]);
	        }

	        if (!isNull(serverResponse.error)) {
	            //Error Response
	            return cb(new HttpErrors.InternalServerError(response.data.error.message, {
	                expose: false
	            }));
	        } else {
	            // HTTP : 200 , Success Response , Merchant Successfully Created!!
	            return cb(null, response.data);
	        }
	    } else {
	        if (!isNull(response["response"])) {
	            let serverResponse = response["response"]["data"];
	            if (typeof serverResponse == "string" || typeof serverResponse === "string") {
	                serverResponse = JSON.parse(response["response"]["data"]);
	            }

	            let serverResponseError = serverResponse["error"];
	            if (typeof serverResponseError == "string" || typeof serverResponseError === "string") {
	                serverResponseError = JSON.parse(serverResponseError["error"]);
	            }

	            let _msg = isNull(serverResponseError["message"]) ? 'Internal Server Error' : serverResponseError["message"];

	            //Error Response
	            return cb(new HttpErrors.InternalServerError(_msg, {
	                expose: false
	            }));
	        } else {
	            let _msg = isNull(response["data"]["message"]) ? 'Internal Server Error' : response["data"]["message"];

	            //Error Response
	            return cb(new HttpErrors.InternalServerError(_msg, {
	                expose: false
	            }));
	        }
	    }
	});

2. Get Merchant Activation Status:

This function will be used to get the merchant activation status.

Payload

Key Type Value Description Required
action string GET_MERCHANT_STATUS key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

3. Get Merchant Id from (Your) User Id:

This function will be used to get the merchant id from user id.

Payload

Key Type Value Description Required
action string GET_MERCHANT_ID key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

4. Get Merchant Profile:

This function will be used to get the merchant activation status.

Payload

Key Type Value Description Required
action string GET_MERCHANT_PROFILE key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

5. Update Merchant Profile:

This function will be used to update the merchant info.

Payload

Key Type Value Description Required
action string UPDATE_MERCHANT_PROFILE key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

6. Deactivate Merchant Account:

This function will be used to deactivate the merchant account.

Payload

Key Type Value Description Required
action string DEACTIVATE_MERCHANT key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

7. Create Payer:

This function will be used to add payer to the merchant.

Payload

Key Type Value Description Required
action string CREATE_PAYER key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

8. Edit Payer Info:

This function will be used to edit payer information.

Payload

Key Type Value Description Required
action string EDIT_PAYER key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

9. Remove Payer:

This function will be used to remove payer from merchant account.

Payload

Key Type Value Description Required
action string REMOVE_PAYER key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

10. Upload Payers:

This function will be used to upload excel file with multiple payers to perform batch upload.

Payload

Key Type Value Description Required
action string IMPORT_PAYERS key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

11. Create Transaction:

This function will be used to request or create payment transaction.

Payload

Key Type Value Description Required
action string CREATE_TRANSACTION key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

12. Get Payers Listing:

This function will provide the listing of active payers for the merchant.

Payload

Key Type Value Description Required
action string GET_PAYERS_LISTING key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

13. Get Payer Profile:

This function will provide the profile details for the payer account.

Payload

Key Type Value Description Required
action string GET_PAYER_PROFILE key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

14. Save Card for Payer:

This function will allow to save credit cards for payers, if opted.

Payload

Key Type Value Description Required
action string SAVE_CARD key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

15. Remove Card for Payer:

This function will allow to save credit cards for payers, if opted.

Payload

Key Type Value Description Required
action string REMOVE_CARD key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

16. Get Saved Cards Listing For Payer:

This function will allow to save credit cards for payers, if opted.

Payload

Key Type Value Description Required
action string GET_SAVED_CARDS key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

17. Process Payment:

This function will allow to complete payments.

Payload

Key Type Value Description Required
action string PROCESS_PAYMENT key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

18. Get Transactions Listing:

This function will list all the transactions with respect to the merchant and you can also search based on filter criterias.

Payload

Key Type Value Description Required
action string GET_TRANSACTIONS_LISTING key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

19. Get Transaction Details:

This function will provide the details for particular transaction.

Payload

Key Type Value Description Required
action string GET_TRANSACTION_DETAILS key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

20. Get Transaction Stats:

This function will provide transactions stats like AmountPending and TotalCollections.

Payload

Key Type Value Description Required
action string GET_TRANSACTION_STATS key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

21. Get Non Payers Listing:

This function will provide listing of all non payers.

Payload

Key Type Value Description Required
action string GET_NON_PAYERS_LISTING key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

22. Get Payers Transactions:

This function will provide listing of transactions of a payer.

Payload

Key Type Value Description Required
action string GET_PAYERS_TRANSACTION key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

23. Get All Merchants:

This function will provide listing of all active merchants.

Payload

Key Type Value Description Required
action string GET_ALL_MERCHANTS key which defines the type of action to be performed YES

24. Get Payer Transaction Stats:

This function will provide transactions stats like AmountPending and TotalCollections for a payer.

Payload

Key Type Value Description Required
action string GET_PAYER_TRANSACTION_STATS key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

25. Attach Payer with Merchants:

This function will attach any given payer with any given merchants.

Payload

Key Type Value Description Required
action string ATTACH_PAYER_MERCHANT key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

26. Get Active Merchants for Payer:

This function will provide listing of all the active merchants attached with a payer.

Payload

Key Type Value Description Required
action string GET_MERCHANTS_OF_PAYER key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES

27. Make Refund:

This will does the refund part for the transaction.

Payload

Key Type Value Description Required
action string MAKE_REFUND key which defines the type of action to be performed YES
meta json SAMPLE_META_INFO Json having merchant details. YES