koinworks-node-sdk

NodeJS SDK for Koinworks Partners

Installation

The SDK requires Node.js ^12.22.12 to run.

Install the package

npm install koinworks-node-sdk

Usage

var config = {
    "headers": {
      "x-koinworks-token": "YOUR_PUBLIC_TOKEN",
      "x-koinworks-private-token": "YOUR_PRIVATE_TOKEN",
      "env" : "sandbox",
      "User-Agent" : "YOUR_PARTNER_NAME",
      "Authorization": "ACCESS_TOKEN"
    },
    "data": {}
};

const response = await requestLimit(config);

| Value | Description | | ---------------------- | ------------------------------------------------ | | YOUR_PUBLIC_TOKEN | partner's public token provided by koinworks | | YOUR_PRIVATE_TOKEN | partner's secret key provided by koinworks | | YOUR_PARTNER_NAME | partner's company name | | ACCESS_TOKEN | generated from generateToken function response |

Specification

| Function | Authorization | Data | Note | | ------------------------ | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------- | | requestLimit | | Payload | | | getLimit | | Payload | put params in payload | | generateToken | | Payload | only put key parameter | | requestLimitOTP | ACCESS_TOKEN | | | | verifyLimitOTP | ACCESS_TOKEN | Payload | | | userLimit | ACCESS_TOKEN | Payload | | | reuploadDocument | ACCESS_TOKEN | Payload | | | uploadSignContract | ACCESS_TOKEN | Payload | | | createLoan | ACCESS_TOKEN | Payload | | | requestLoanOTP | ACCESS_TOKEN | Payload | put loanId parameter in Payload | | verifyLoanOTP | ACCESS_TOKEN | Payload | put loanId parameter in Payload | | loanPartnerCancelled | ACCESS_TOKEN | Payload | put loanId parameter in Payload | | deliveryConfirmation | ACCESS_TOKEN | Payload | put loanId parameter in Payload | | loanDisbursementReport | | Payload | put from_date, to_date parameter in Payload | | repayment | | Payload | put loanId parameter in Payload |

BNPL

For more details, visit our BNPL Documentation Page

License

Apache 2.0