swirepay-js

v1.0.3

Published

3 years ago

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_da

Downloads

0High
0Medium
0Low

mariomegaitr

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- SwirepayApi.CustomerApi | addCustomer | POST /customer | Add a new customer SwirepayApi.CustomerApi | deleteCustomerByGid | DELETE /customer/{gid} | Delete customer by Gid SwirepayApi.CustomerApi | getAllCustomers | GET /customer | Get all customers SwirepayApi.CustomerApi | getCustomerByGid | GET /customer/{gid} | Get Customer by Gid SwirepayApi.CustomerApi | updateCustomer | PATCH /customer/{gid} | Update Customer by Gid SwirepayApi.DisputeApi | getAllDisputes | GET /dispute | Get All Disputes SwirepayApi.DisputeApi | getDisputeByGid | GET /dispute/{gid} | Get dispute by Gid SwirepayApi.InvoiceApi | addInvoice | POST /invoice | Add a new invoice SwirepayApi.InvoiceApi | getAllInvoices | GET /invoice | Get All Invoices SwirepayApi.InvoiceApi | getInvoiceByGid | GET /invoice/{gid} | Get invoice by Gid SwirepayApi.InvoiceApi | payInvoice | PATCH /invoice/{gid}/pay | pay for invoice SwirepayApi.InvoiceApi | updateInvoiceActive | PATCH /invoice/{gid}/active | Update invoice to active SwirepayApi.InvoiceApi | updateInvoiceDraft | PATCH /invoice/{gid}/draft | Update invoice to draft SwirepayApi.PaymentLinkApi | addPaymentLink | POST /payment-link | Add a new Payment Link SwirepayApi.PaymentLinkApi | cancelPaymentLinkByGid | PATCH /payment-link/{gid}/cancel | Get Payment Link by Gid SwirepayApi.PaymentLinkApi | getAllPaymentLink | GET /payment-link | Get All payment Link SwirepayApi.PaymentLinkApi | getPaymentLinkByGid | GET /payment-link/{gid} | Get Payment Link by Gid SwirepayApi.PaymentMethodApi | addPaymentMethod | POST /payment-method | Add Payment Method SwirepayApi.PaymentMethodApi | deletePaymentMethod | DELETE /payment-method/{gid} | Delete Payment Method SwirepayApi.PaymentMethodApi | getPaymentMethodByGid | GET /payment-method/{gid} | Get Payment Method by Gid SwirepayApi.PaymentSessionApi | addPaymentSession | POST /payment-session | Add a new payment ssession SwirepayApi.PaymentSessionApi | cancelPaymentSession | PATCH /payment-session/{gid}/cancel | Cancel Payment Session SwirepayApi.PaymentSessionApi | capturePaymentSession | PATCH /payment-session/{gid}/capture | Capture Payment Session SwirepayApi.PaymentSessionApi | confirmPaymentSession | PATCH /payment-session/{gid}/confirm | Confirm Payment Session SwirepayApi.PaymentSessionApi | getAllPaymentSession | GET /payment-session | Get all payment session SwirepayApi.PaymentSessionApi | getPaymentSessionByGid | GET /payment-session/{gid} | Get Payment Session by Gid SwirepayApi.PaymentSessionApi | notifyPaymentSessionByGid | GET /payment-session/{gid}/notify | Notify Payment Session by Gid SwirepayApi.PaymentSessionApi | refundPaymentSession | PATCH /payment-session/{gid}/refund | Refund Payment Session SwirepayApi.PaymentSessionApi | updatePaymentSession | PATCH /payment-session/{gid}/update | Update Payment Session SwirepayApi.PayoutApi | getAllPayouts | GET /payout | Get All payouts SwirepayApi.PayoutApi | getPayoutByGid | GET /payout/{gid} | Get payout by Gid SwirepayApi.PlanApi | addPlan | POST /plan | Add a new plan SwirepayApi.PlanApi | getAllPlan | GET /plan | Get All Plan SwirepayApi.PlanApi | getplanByGid | GET /plan/{gid} | Get Plan by Gid SwirepayApi.PlanApi | updatePlan | PATCH /plan/{gid} | Update Plan SwirepayApi.PublicKeyApi | getAllPublicKey | GET /public-key | Get All Public Key SwirepayApi.PublicKeyApi | rollPublicKeyByGid | PATCH /public-key/{gid}/roll | Roll Public Key by Gid SwirepayApi.RefundApi | getAllRefunds | GET /refund | Get All Refunds SwirepayApi.RefundApi | getRefundByGid | GET /refund/{gid} | Get refund by Gid SwirepayApi.SecretKeyApi | getAllSecretKey | GET /secret-key | Get All Secret Key SwirepayApi.SecretKeyApi | rollSecretKeyByGid | PATCH /secret-key/{gid}/roll | Roll Secret Key by Gid SwirepayApi.SubscriptionApi | addSubscription | POST /subscription | Add a new subscription SwirepayApi.SubscriptionApi | cancelSubscription | PATCH /subscription/{gid}/cancel | Cancel Subscription SwirepayApi.SubscriptionApi | getAllSubscription | GET /subscription | Get All Subscription SwirepayApi.SubscriptionApi | getSubscriptionByGid | GET /subscription/{gid} | Get Subscription by Gid SwirepayApi.TransactionApi | getAllTransaction | GET /transaction | Get All transactions SwirepayApi.WebhookApi | addWebhook | POST /webhook | Add new webhook SwirepayApi.WebhookApi | deleteWebhook | DELETE /webhook/{gid} | Delete webhook SwirepayApi.WebhookApi | getAllWebhook | GET /webhook | Get All Webhook SwirepayApi.WebhookApi | getWebhookByGid | GET /webhook/{gid} | Get webhook by gid SwirepayApi.WebhookApi | updateWebhook | PATCH /webhook/{gid} | Update webhook

Documentation for Models

Documentation for Authorization

api_key

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