1.0.3 • Published 3 months ago

koinworks-node-sdk v1.0.3

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
3 months ago

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);
ValueDescription
YOUR_PUBLIC_TOKENpartner's public token provided by koinworks
YOUR_PRIVATE_TOKENpartner's secret key provided by koinworks
YOUR_PARTNER_NAMEpartner's company name
ACCESS_TOKENgenerated from generateToken function response

Specification

FunctionAuthorizationDataNote
requestLimitPayload
getLimitPayloadput params in payload
generateTokenPayloadonly put key parameter
requestLimitOTPACCESS_TOKEN
verifyLimitOTPACCESS_TOKENPayload
userLimitACCESS_TOKENPayload
reuploadDocumentACCESS_TOKENPayload
uploadSignContractACCESS_TOKENPayload
createLoanACCESS_TOKENPayload
requestLoanOTPACCESS_TOKENPayloadput loanId parameter in Payload
verifyLoanOTPACCESS_TOKENPayloadput loanId parameter in Payload
loanPartnerCancelledACCESS_TOKENPayloadput loanId parameter in Payload
deliveryConfirmationACCESS_TOKENPayloadput loanId parameter in Payload
loanDisbursementReportPayloadput from_date, to_date parameter in Payload
repaymentPayloadput loanId parameter in Payload

BNPL

For more details, visit our BNPL Documentation Page

License

Apache 2.0