npm package: @kikapay/node-sdk
Description: JS API client generated by OpenAPI Generator
Latest version: 1.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](https://openapi-generator.tech) project:

- API version: 1.5.3
- Package version: 1.5.3
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @kikapay/node-sdk --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
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**](docs/PaymentsApi.md#createExactRecurringPayment) | **POST** /v1/payments/recurring/exact | Create a link for an exact recurring payment
*@KikapayNodeSdk.PaymentsApi* | [**createExactSinglePayment**](docs/PaymentsApi.md#createExactSinglePayment) | **POST** /v1/payments/single/immediate/exact | Create a link for an exact single payment
*@KikapayNodeSdk.PaymentsApi* | [**createSinglePaymentMultiUse**](docs/PaymentsApi.md#createSinglePaymentMultiUse) | **POST** /v1/payments/single/immediate/exact/multi-use-link | Create a link for a multi-use exact single payment
*@KikapayNodeSdk.ReconciliationApi* | [**reconciliationMultiUseLinkPayments**](docs/ReconciliationApi.md#reconciliationMultiUseLinkPayments) | **GET** /v1/payments/reconciliation/{kikaReference}/multi-use-link | Get multi-use single immediate payments
*@KikapayNodeSdk.ReconciliationApi* | [**reconciliationPayment**](docs/ReconciliationApi.md#reconciliationPayment) | **GET** /v1/payments/reconciliation/{kikaReference} | Get information about a payment
*@KikapayNodeSdk.ReconciliationApi* | [**reconciliationRecurringPayments**](docs/ReconciliationApi.md#reconciliationRecurringPayments) | **POST** /v1/payments/recurring/exact/reconciliation | Get a list of recurring payments
*@KikapayNodeSdk.ReconciliationApi* | [**reconciliationSinglePayments**](docs/ReconciliationApi.md#reconciliationSinglePayments) | **POST** /v1/payments/single/immediate/exact/reconciliation | Get a list of single payments


## Documentation for Models

 - [@KikapayNodeSdk.ExactRecurringPayment](docs/ExactRecurringPayment.md)
 - [@KikapayNodeSdk.ExactRecurringPayment201Response](docs/ExactRecurringPayment201Response.md)
 - [@KikapayNodeSdk.ExactRecurringPayment400Response](docs/ExactRecurringPayment400Response.md)
 - [@KikapayNodeSdk.ExactRecurringPayment400ResponseErrors](docs/ExactRecurringPayment400ResponseErrors.md)
 - [@KikapayNodeSdk.ExactRecurringPayment500Response](docs/ExactRecurringPayment500Response.md)
 - [@KikapayNodeSdk.Merchant](docs/Merchant.md)
 - [@KikapayNodeSdk.MerchantCustomer](docs/MerchantCustomer.md)
 - [@KikapayNodeSdk.Payment403Response](docs/Payment403Response.md)
 - [@KikapayNodeSdk.Payment403ResponseErrors](docs/Payment403ResponseErrors.md)
 - [@KikapayNodeSdk.PaymentConditions](docs/PaymentConditions.md)
 - [@KikapayNodeSdk.PaymentConditionsSingleImmediatePaymentMulti](docs/PaymentConditionsSingleImmediatePaymentMulti.md)
 - [@KikapayNodeSdk.PaymentDetails](docs/PaymentDetails.md)
 - [@KikapayNodeSdk.PaymentNumberPayments](docs/PaymentNumberPayments.md)
 - [@KikapayNodeSdk.PaymentSingleExact](docs/PaymentSingleExact.md)
 - [@KikapayNodeSdk.QrCode](docs/QrCode.md)
 - [@KikapayNodeSdk.ReconciliationMultiUseLinkPayment200Response](docs/ReconciliationMultiUseLinkPayment200Response.md)
 - [@KikapayNodeSdk.ReconciliationMultiUseLinkPayment200ResponsePayment](docs/ReconciliationMultiUseLinkPayment200ResponsePayment.md)
 - [@KikapayNodeSdk.ReconciliationMultiUseLinkPayment200ResponsePaymentConditions](docs/ReconciliationMultiUseLinkPayment200ResponsePaymentConditions.md)
 - [@KikapayNodeSdk.ReconciliationMultiUseLinkPayment200ResponsePaymentDetails](docs/ReconciliationMultiUseLinkPayment200ResponsePaymentDetails.md)
 - [@KikapayNodeSdk.ReconciliationMultiUseLinkPayment403Response](docs/ReconciliationMultiUseLinkPayment403Response.md)
 - [@KikapayNodeSdk.ReconciliationMultiUseLinkPayment404Response](docs/ReconciliationMultiUseLinkPayment404Response.md)
 - [@KikapayNodeSdk.ReconciliationMultiUseLinkPayment500Response](docs/ReconciliationMultiUseLinkPayment500Response.md)
 - [@KikapayNodeSdk.ReconciliationPayment200Response](docs/ReconciliationPayment200Response.md)
 - [@KikapayNodeSdk.ReconciliationPayment200ResponseMerchant](docs/ReconciliationPayment200ResponseMerchant.md)
 - [@KikapayNodeSdk.ReconciliationPayment200ResponseMerchantCustomer](docs/ReconciliationPayment200ResponseMerchantCustomer.md)
 - [@KikapayNodeSdk.ReconciliationPayment200ResponsePayment](docs/ReconciliationPayment200ResponsePayment.md)
 - [@KikapayNodeSdk.ReconciliationPayment200ResponsePaymentDetails](docs/ReconciliationPayment200ResponsePaymentDetails.md)
 - [@KikapayNodeSdk.ReconciliationPayment400Response](docs/ReconciliationPayment400Response.md)
 - [@KikapayNodeSdk.ReconciliationPayment400ResponseErrors](docs/ReconciliationPayment400ResponseErrors.md)
 - [@KikapayNodeSdk.ReconciliationPayment403Response](docs/ReconciliationPayment403Response.md)
 - [@KikapayNodeSdk.ReconciliationPayment404Response](docs/ReconciliationPayment404Response.md)
 - [@KikapayNodeSdk.ReconciliationPayment404ResponseErrors](docs/ReconciliationPayment404ResponseErrors.md)
 - [@KikapayNodeSdk.ReconciliationPayment500Response](docs/ReconciliationPayment500Response.md)
 - [@KikapayNodeSdk.ReconciliationPayment500ResponseErrors](docs/ReconciliationPayment500ResponseErrors.md)
 - [@KikapayNodeSdk.ReconciliationPayments](docs/ReconciliationPayments.md)
 - [@KikapayNodeSdk.ReconciliationPayments200Response](docs/ReconciliationPayments200Response.md)
 - [@KikapayNodeSdk.ReconciliationPayments200ResponsePayment](docs/ReconciliationPayments200ResponsePayment.md)
 - [@KikapayNodeSdk.ReconciliationPayments200ResponsePayments](docs/ReconciliationPayments200ResponsePayments.md)
 - [@KikapayNodeSdk.ReconciliationPayments400Response](docs/ReconciliationPayments400Response.md)
 - [@KikapayNodeSdk.ReconciliationPayments400ResponseErrors](docs/ReconciliationPayments400ResponseErrors.md)
 - [@KikapayNodeSdk.ReconciliationPayments403Response](docs/ReconciliationPayments403Response.md)
 - [@KikapayNodeSdk.ReconciliationPayments404Response](docs/ReconciliationPayments404Response.md)
 - [@KikapayNodeSdk.ReconciliationPayments404ResponseErrors](docs/ReconciliationPayments404ResponseErrors.md)
 - [@KikapayNodeSdk.ReconciliationPayments500Response](docs/ReconciliationPayments500Response.md)
 - [@KikapayNodeSdk.ReconciliationPayments500ResponseErrors](docs/ReconciliationPayments500ResponseErrors.md)
 - [@KikapayNodeSdk.ReconciliationSinglePayments](docs/ReconciliationSinglePayments.md)
 - [@KikapayNodeSdk.Redirect](docs/Redirect.md)
 - [@KikapayNodeSdk.ScheduleNumberPayments](docs/ScheduleNumberPayments.md)
 - [@KikapayNodeSdk.ScheduleNumberPaymentsEnd](docs/ScheduleNumberPaymentsEnd.md)
 - [@KikapayNodeSdk.ScheduleNumberPaymentsStart](docs/ScheduleNumberPaymentsStart.md)
 - [@KikapayNodeSdk.SingleImmediatePayment](docs/SingleImmediatePayment.md)
 - [@KikapayNodeSdk.SingleImmediatePaymentMulti](docs/SingleImmediatePaymentMulti.md)
 - [@KikapayNodeSdk.SinglePayment201Response](docs/SinglePayment201Response.md)
 - [@KikapayNodeSdk.SinglePayment400Response](docs/SinglePayment400Response.md)
 - [@KikapayNodeSdk.SinglePayment400ResponseErrors](docs/SinglePayment400ResponseErrors.md)
 - [@KikapayNodeSdk.SinglePayment500Response](docs/SinglePayment500Response.md)
 - [@KikapayNodeSdk.SinglePayment500ResponseErrors](docs/SinglePayment500ResponseErrors.md)


## Documentation for Authorization



### bearerAuth

- **Type**: Bearer authentication (JWT)