@slick-pay-algeria/quick-transfer NPM

Description

Node.js module for Slick-Pay Quick Transfer API implementation.

Installation

Just run this command line :

npm i @slick-pay-algeria/quick-transfer

How to use?

By using the @slick-pay-algeria/quick-transfer package, you will be able to create new payments, and also check payments statuses identified by their transfer ID.

createPayment

To create any new payment, you will use the createPayment function provided within the @slick-pay-algeria/quick-transfer package.

Parameters

params: <object> (required), the callback URL that the user will be redirected to after the payment was successfully completed from the payment platform.
sandbox: <boolean> (optional), Will indicate if you want to use a sandbox or live environment (default: false).
params.returnUrl: <string> (optional), the callback URL that the user will be redirected to after the payment was successfully completed from the payment platform.
params.amount: <numeric> (required), the transaction amount in "Dinar algérien" currency, the minimum accepted amount is 100 DA.
params.rib: <string> (required) It will define the merchant bank account ID, it should be a string with the exact size of 20 characters.
params.fname: <string> (required) To define the merchant first name, it should be a string with minimum length of 2 characters.
params.lname: <string> (required) To define the merchant last name, it should be a string with minimum length of 2 characters.
params.address: <string> (required) To define the merchant address, it should be a string with minimum length of 5 characters.

Example

Check the example below :

const QuickTransfer = require('@slick-pay-algeria/quick-transfer');

QuickTransfer.createPayment({
        "rib": "00012345678912345678",
        "amount": 1000,
        "fname": "Lorem",
        "lname": "ipsum",
        "address": "Dolor",
    })
    .then((result: any) => {
        console.log(result);
    })
    .catch((err: any) => {
        console.log(err);
    });

After calling then method you'll be able to access to :

transferId: Payment transfer ID (can be used to check payment status)
redirectUrl: The redirect url to redirect the client to the payment platform

Meanwhile, when the catch method is call, it will retruns an array of strings for errors occured.

paymentStatus

If you would like to check any payment status, you will use the paymentStatus function provided within the @slick-pay-algeria/quick-transfer package.

Parameters

rib: <string> (required) Define your own account ID, it should be a string with the exact size of 20 characters.
transferId: <number> (required), Payment transfer ID.
sandbox: <boolean> (optional), Will indicate if you want to use a sandbox or live environment (default: false).

Example

Check the example below :

const QuickTransfer = require('@slick-pay-algeria/quick-transfer');

QuickTransfer.paymentStatus("00012345678912345678", 1)
    .then((result: any) => {
        this.result = result;
    }).catch((err: any) => {
        console.log(err);
    });

After calling then method you'll be able to access to :