swirepay-js v1.0.3

swirepay_api

SwirepayApi - JavaScript client for swirepay_api Swirepay REST APIs' are resource-oriented URLs that accept JSON-encoded request bodies, return JSON-encoded responses, and use standard HTTP response codes, authentication, and verbs. You can use the Swirepay API in test mode, which does not affect your live data or interact with the banking networks. The API key you use to authenticate the request determines whether the request is live mode or test mode. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.3
• Package version: 1.0.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 swirepay_api --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 swirepay_api 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 SwirepayApi = require('swirepay_api');

var defaultClient = SwirepayApi.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new SwirepayApi.CustomerApi()
var customerRequest = new SwirepayApi.CustomerRequest(); // {CustomerRequest} 
var opts = {
  'destinationAccount': "destinationAccount_example" // {String} If processing on behalf of another Swirepay affiliate account
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCustomer(customerRequest, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.swirepay.com/v1

Documentation for Models

• SwirepayApi.AccountRate
• SwirepayApi.Acquirer
• SwirepayApi.Address
• SwirepayApi.AddressRequest
• SwirepayApi.BillingFrequency
• SwirepayApi.Bin
• SwirepayApi.Card
• SwirepayApi.CardRequest
• SwirepayApi.Category
• SwirepayApi.Country
• SwirepayApi.Currency
• SwirepayApi.Customer
• SwirepayApi.CustomerListResponse
• SwirepayApi.CustomerListResponseEntity
• SwirepayApi.CustomerRequest
• SwirepayApi.CustomerResponse
• SwirepayApi.Dispute
• SwirepayApi.DisputeListResponse
• SwirepayApi.DisputeListResponseEntity
• SwirepayApi.DisputeResponse
• SwirepayApi.Invoice
• SwirepayApi.InvoiceLineItem
• SwirepayApi.InvoiceLink
• SwirepayApi.InvoiceListResponse
• SwirepayApi.InvoiceListResponseEntity
• SwirepayApi.InvoiceRequest
• SwirepayApi.InvoiceResponse
• SwirepayApi.InvoicelineItemRequest
• SwirepayApi.Payment
• SwirepayApi.PaymentLink
• SwirepayApi.PaymentLinkListResponse
• SwirepayApi.PaymentLinkListResponseEntity
• SwirepayApi.PaymentLinkRequest
• SwirepayApi.PaymentLinkResponse
• SwirepayApi.PaymentMethod
• SwirepayApi.PaymentMethodRequest
• SwirepayApi.PaymentMethodResponse
• SwirepayApi.PaymentMethodType
• SwirepayApi.PaymentSession
• SwirepayApi.PaymentSessionListResponse
• SwirepayApi.PaymentSessionListResponseEntity
• SwirepayApi.PaymentSessionPublicResponse
• SwirepayApi.PaymentSessionRequest
• SwirepayApi.PaymentSessionResponse
• SwirepayApi.PaymentType
• SwirepayApi.Payout
• SwirepayApi.PayoutListResponse
• SwirepayApi.PayoutListResponseEntity
• SwirepayApi.PayoutResponse
• SwirepayApi.Plan
• SwirepayApi.PlanListResponse
• SwirepayApi.PlanListResponseEntity
• SwirepayApi.PlanRequest
• SwirepayApi.PlanResponse
• SwirepayApi.PublicKey
• SwirepayApi.PublicKeyListResponse
• SwirepayApi.PublicKeyListResponseEntity
• SwirepayApi.PublicKeyRequest
• SwirepayApi.PublicKeyResponse
• SwirepayApi.Rate
• SwirepayApi.Refund
• SwirepayApi.RefundListResponse
• SwirepayApi.RefundListResponseEntity
• SwirepayApi.RefundResponse
• SwirepayApi.SecretKey
• SwirepayApi.SecretKeyListResponse
• SwirepayApi.SecretKeyListResponseEntity
• SwirepayApi.SecretKeyRequest
• SwirepayApi.SecretKeyResponse
• SwirepayApi.Subscription
• SwirepayApi.SubscriptionButton
• SwirepayApi.SubscriptionLineItem
• SwirepayApi.SubscriptionLineItemRequest
• SwirepayApi.SubscriptionLink
• SwirepayApi.SubscriptionListResponse
• SwirepayApi.SubscriptionListResponseEntity
• SwirepayApi.SubscriptionRequest
• SwirepayApi.SubscriptionResponse
• SwirepayApi.Support
• SwirepayApi.Tax
• SwirepayApi.Transaction
• SwirepayApi.TransactionListResponse
• SwirepayApi.TransactionListResponseEntity
• SwirepayApi.Upi
• SwirepayApi.UpiRequest
• SwirepayApi.Webhook
• SwirepayApi.WebhookEvent
• SwirepayApi.WebhookListResponse
• SwirepayApi.WebhookListResponseEntity
• SwirepayApi.WebhookRequest
• SwirepayApi.WebhookResponse

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header