@kikapay/node-sdk v1.5.3
@kikapay/node-sdk
@KikapayNodeSdk - JavaScript client for @kikapay/node-sdk No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.5.3
- Package version: 1.5.3
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install @kikapay/node-sdk --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your @kikapay/node-sdk from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var @KikapayNodeSdk = require('@kikapay/node-sdk');
var defaultClient = @KikapayNodeSdk.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
var api = new @KikapayNodeSdk.PaymentsApi()
var exactRecurringPayment = new @KikapayNodeSdk.ExactRecurringPayment(); // {ExactRecurringPayment}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createExactRecurringPayment(exactRecurringPayment, callback);
Documentation for API Endpoints
All URIs are relative to https://qa.kikapay.com
Class | Method | HTTP request | Description |
---|---|---|---|
@KikapayNodeSdk.PaymentsApi | createExactRecurringPayment | POST /v1/payments/recurring/exact | Create a link for an exact recurring payment |
@KikapayNodeSdk.PaymentsApi | createExactSinglePayment | POST /v1/payments/single/immediate/exact | Create a link for an exact single payment |
@KikapayNodeSdk.PaymentsApi | createSinglePaymentMultiUse | POST /v1/payments/single/immediate/exact/multi-use-link | Create a link for a multi-use exact single payment |
@KikapayNodeSdk.ReconciliationApi | reconciliationMultiUseLinkPayments | GET /v1/payments/reconciliation/{kikaReference}/multi-use-link | Get multi-use single immediate payments |
@KikapayNodeSdk.ReconciliationApi | reconciliationPayment | GET /v1/payments/reconciliation/{kikaReference} | Get information about a payment |
@KikapayNodeSdk.ReconciliationApi | reconciliationRecurringPayments | POST /v1/payments/recurring/exact/reconciliation | Get a list of recurring payments |
@KikapayNodeSdk.ReconciliationApi | reconciliationSinglePayments | POST /v1/payments/single/immediate/exact/reconciliation | Get a list of single payments |
Documentation for Models
- @KikapayNodeSdk.ExactRecurringPayment
- @KikapayNodeSdk.ExactRecurringPayment201Response
- @KikapayNodeSdk.ExactRecurringPayment400Response
- @KikapayNodeSdk.ExactRecurringPayment400ResponseErrors
- @KikapayNodeSdk.ExactRecurringPayment500Response
- @KikapayNodeSdk.Merchant
- @KikapayNodeSdk.MerchantCustomer
- @KikapayNodeSdk.Payment403Response
- @KikapayNodeSdk.Payment403ResponseErrors
- @KikapayNodeSdk.PaymentConditions
- @KikapayNodeSdk.PaymentConditionsSingleImmediatePaymentMulti
- @KikapayNodeSdk.PaymentDetails
- @KikapayNodeSdk.PaymentNumberPayments
- @KikapayNodeSdk.PaymentSingleExact
- @KikapayNodeSdk.QrCode
- @KikapayNodeSdk.ReconciliationMultiUseLinkPayment200Response
- @KikapayNodeSdk.ReconciliationMultiUseLinkPayment200ResponsePayment
- @KikapayNodeSdk.ReconciliationMultiUseLinkPayment200ResponsePaymentConditions
- @KikapayNodeSdk.ReconciliationMultiUseLinkPayment200ResponsePaymentDetails
- @KikapayNodeSdk.ReconciliationMultiUseLinkPayment403Response
- @KikapayNodeSdk.ReconciliationMultiUseLinkPayment404Response
- @KikapayNodeSdk.ReconciliationMultiUseLinkPayment500Response
- @KikapayNodeSdk.ReconciliationPayment200Response
- @KikapayNodeSdk.ReconciliationPayment200ResponseMerchant
- @KikapayNodeSdk.ReconciliationPayment200ResponseMerchantCustomer
- @KikapayNodeSdk.ReconciliationPayment200ResponsePayment
- @KikapayNodeSdk.ReconciliationPayment200ResponsePaymentDetails
- @KikapayNodeSdk.ReconciliationPayment400Response
- @KikapayNodeSdk.ReconciliationPayment400ResponseErrors
- @KikapayNodeSdk.ReconciliationPayment403Response
- @KikapayNodeSdk.ReconciliationPayment404Response
- @KikapayNodeSdk.ReconciliationPayment404ResponseErrors
- @KikapayNodeSdk.ReconciliationPayment500Response
- @KikapayNodeSdk.ReconciliationPayment500ResponseErrors
- @KikapayNodeSdk.ReconciliationPayments
- @KikapayNodeSdk.ReconciliationPayments200Response
- @KikapayNodeSdk.ReconciliationPayments200ResponsePayment
- @KikapayNodeSdk.ReconciliationPayments200ResponsePayments
- @KikapayNodeSdk.ReconciliationPayments400Response
- @KikapayNodeSdk.ReconciliationPayments400ResponseErrors
- @KikapayNodeSdk.ReconciliationPayments403Response
- @KikapayNodeSdk.ReconciliationPayments404Response
- @KikapayNodeSdk.ReconciliationPayments404ResponseErrors
- @KikapayNodeSdk.ReconciliationPayments500Response
- @KikapayNodeSdk.ReconciliationPayments500ResponseErrors
- @KikapayNodeSdk.ReconciliationSinglePayments
- @KikapayNodeSdk.Redirect
- @KikapayNodeSdk.ScheduleNumberPayments
- @KikapayNodeSdk.ScheduleNumberPaymentsEnd
- @KikapayNodeSdk.ScheduleNumberPaymentsStart
- @KikapayNodeSdk.SingleImmediatePayment
- @KikapayNodeSdk.SingleImmediatePaymentMulti
- @KikapayNodeSdk.SinglePayment201Response
- @KikapayNodeSdk.SinglePayment400Response
- @KikapayNodeSdk.SinglePayment400ResponseErrors
- @KikapayNodeSdk.SinglePayment500Response
- @KikapayNodeSdk.SinglePayment500ResponseErrors
Documentation for Authorization
bearerAuth
- Type: Bearer authentication (JWT)