Paga Collect Nodejs API Library v1.0.0

Paga Collect Services exposed by the library

• paymentRequest
• getBanks
• paymentStatus
• paymentHistory

For more information on the services listed above, visit the Paga DEV website

How to use

npm install paga-collect

import PagaCollectClient from './PagaCollectClient.js';

const pagaCollectClient = new PagaCollectClient.Builder()
                            .setClientId("<publicId>")
                            .setPassword("<password>")
                            .setApiKey("<apiKey>")
                            .setIsTest(true)
                            .build();

As shown above, you set the publicId, apiKey, password given to you by Paga, If you pass true as the value for setIsTest(), the library will use the test url as the base for all calls. Otherwise setting it to false will use the live url value you pass as the base.

Paga Collect Service Functions

Request Payment

Registers a new request for payment between a payer and a payee. Once a payment request is initiated successfully, the payer is notified by the platform (this can be suppressed) and can proceed to authorize/execute the payment. Once the payment is fulfilled, a notification is sent to the supplied callback URL.

To make use of this function, call the paymentRequest inside PagaCollectClient which will return a JSONObject.

let data = {
      "referenceNumber": "53yw19011000009112",
      "amount": 200,
      "callBackUrl": "http://localhost:5000/core/webhook/paga",
      "currency": "NGN",
      "expiryDateTimeUTC": "2021-05-20T19:35:47",
      "isAllowPartialPayments": false,
      "isSuppressMessages": false,
      "payee": {"bankAccountNumber": "XXXXXXXXXXX",
                "bankId": "XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX",
                "name": "John Doe",
              "accountNumber": "XXXXXXXXXX"},
      "payer": {"email": "foobar@gmail.com",
                "name": "Foo Bar", 
                "bankId": "XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", 
                "phoneNumber": "XXXXXXXXXXX"},
      "payerCollectionFeeShare": 1.0,
      "recipientCollectionFeeShare": 0.0,
      "paymentMethods": ["BANK_TRANSFER", "FUNDING_USSD"]
      }

  pagaCollectClient.paymentRequest(data).then(resp => {
        console.log(JSON.stringify(resp))
    });

Get Banks

Retrieve a list of supported banks and their complementary unique ids on the bank. This is required for populating the payer (optional) and payee objects in the payment request model. To make use of this function, call the getBanks inside PagaCollectClient which will return a JSONObject.

let data = {referenceNumber:'529383853031111'}
    pagaCollectClient.getBanks(data).then(resp => {
        console.log(JSON.stringify(resp))
    });
  
   

Query Payment Request Status

Query the current status of a submitted payment request. To make use of this function, call the paymentStatus inside PagaCollectClient which will return a JSONObject.

let data = {referenceNumber:'529383853031111'}
    pagaCollectClient.paymentStatus(data).then(resp => {
        console.log(JSON.stringify(resp))
    });

Payment Request History

Get payment requests for a period between to give start and end dates. The period window should not exceed 1 month. To make use of this function, call the paymentHistory inside PagaCollectClient which will return a JSONObject.

let data = {
      referenceNumber : "82353464000000",
      startDateTimeUTC : "2021-04-19T19:15:22",
      endDateTimeUTC : "2021-05-18T19:15:22"
  
    }

 pagaCollectClient.paymentHistory(data).then(resp => {
        console.log(JSON.stringify(resp))
    });