# 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](https://openapi-generator.tech) project: - API version: 1.0.3 - Package version: 1.0.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 swirepay_api --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 swirepay_api from, and run: ```shell npm link /path/to/ ``` 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 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**](https://github.com/swirepay/swirepay-js/tree/master/docs/CustomerApi.md#addCustomer) | **POST** /customer | Add a new customer *SwirepayApi.CustomerApi* | [**deleteCustomerByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/CustomerApi.md#deleteCustomerByGid) | **DELETE** /customer/{gid} | Delete customer by Gid *SwirepayApi.CustomerApi* | [**getAllCustomers**](https://github.com/swirepay/swirepay-js/tree/master/docs/CustomerApi.md#getAllCustomers) | **GET** /customer | Get all customers *SwirepayApi.CustomerApi* | [**getCustomerByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/CustomerApi.md#getCustomerByGid) | **GET** /customer/{gid} | Get Customer by Gid *SwirepayApi.CustomerApi* | [**updateCustomer**](https://github.com/swirepay/swirepay-js/tree/master/docs/CustomerApi.md#updateCustomer) | **PATCH** /customer/{gid} | Update Customer by Gid *SwirepayApi.DisputeApi* | [**getAllDisputes**](https://github.com/swirepay/swirepay-js/tree/master/docs/DisputeApi.md#getAllDisputes) | **GET** /dispute | Get All Disputes *SwirepayApi.DisputeApi* | [**getDisputeByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/DisputeApi.md#getDisputeByGid) | **GET** /dispute/{gid} | Get dispute by Gid *SwirepayApi.InvoiceApi* | [**addInvoice**](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoiceApi.md#addInvoice) | **POST** /invoice | Add a new invoice *SwirepayApi.InvoiceApi* | [**getAllInvoices**](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoiceApi.md#getAllInvoices) | **GET** /invoice | Get All Invoices *SwirepayApi.InvoiceApi* | [**getInvoiceByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoiceApi.md#getInvoiceByGid) | **GET** /invoice/{gid} | Get invoice by Gid *SwirepayApi.InvoiceApi* | [**payInvoice**](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoiceApi.md#payInvoice) | **PATCH** /invoice/{gid}/pay | pay for invoice *SwirepayApi.InvoiceApi* | [**updateInvoiceActive**](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoiceApi.md#updateInvoiceActive) | **PATCH** /invoice/{gid}/active | Update invoice to active *SwirepayApi.InvoiceApi* | [**updateInvoiceDraft**](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoiceApi.md#updateInvoiceDraft) | **PATCH** /invoice/{gid}/draft | Update invoice to draft *SwirepayApi.PaymentLinkApi* | [**addPaymentLink**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentLinkApi.md#addPaymentLink) | **POST** /payment-link | Add a new Payment Link *SwirepayApi.PaymentLinkApi* | [**cancelPaymentLinkByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentLinkApi.md#cancelPaymentLinkByGid) | **PATCH** /payment-link/{gid}/cancel | Get Payment Link by Gid *SwirepayApi.PaymentLinkApi* | [**getAllPaymentLink**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentLinkApi.md#getAllPaymentLink) | **GET** /payment-link | Get All payment Link *SwirepayApi.PaymentLinkApi* | [**getPaymentLinkByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentLinkApi.md#getPaymentLinkByGid) | **GET** /payment-link/{gid} | Get Payment Link by Gid *SwirepayApi.PaymentMethodApi* | [**addPaymentMethod**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentMethodApi.md#addPaymentMethod) | **POST** /payment-method | Add Payment Method *SwirepayApi.PaymentMethodApi* | [**deletePaymentMethod**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentMethodApi.md#deletePaymentMethod) | **DELETE** /payment-method/{gid} | Delete Payment Method *SwirepayApi.PaymentMethodApi* | [**getPaymentMethodByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentMethodApi.md#getPaymentMethodByGid) | **GET** /payment-method/{gid} | Get Payment Method by Gid *SwirepayApi.PaymentSessionApi* | [**addPaymentSession**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionApi.md#addPaymentSession) | **POST** /payment-session | Add a new payment ssession *SwirepayApi.PaymentSessionApi* | [**cancelPaymentSession**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionApi.md#cancelPaymentSession) | **PATCH** /payment-session/{gid}/cancel | Cancel Payment Session *SwirepayApi.PaymentSessionApi* | [**capturePaymentSession**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionApi.md#capturePaymentSession) | **PATCH** /payment-session/{gid}/capture | Capture Payment Session *SwirepayApi.PaymentSessionApi* | [**confirmPaymentSession**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionApi.md#confirmPaymentSession) | **PATCH** /payment-session/{gid}/confirm | Confirm Payment Session *SwirepayApi.PaymentSessionApi* | [**getAllPaymentSession**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionApi.md#getAllPaymentSession) | **GET** /payment-session | Get all payment session *SwirepayApi.PaymentSessionApi* | [**getPaymentSessionByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionApi.md#getPaymentSessionByGid) | **GET** /payment-session/{gid} | Get Payment Session by Gid *SwirepayApi.PaymentSessionApi* | [**notifyPaymentSessionByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionApi.md#notifyPaymentSessionByGid) | **GET** /payment-session/{gid}/notify | Notify Payment Session by Gid *SwirepayApi.PaymentSessionApi* | [**refundPaymentSession**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionApi.md#refundPaymentSession) | **PATCH** /payment-session/{gid}/refund | Refund Payment Session *SwirepayApi.PaymentSessionApi* | [**updatePaymentSession**](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionApi.md#updatePaymentSession) | **PATCH** /payment-session/{gid}/update | Update Payment Session *SwirepayApi.PayoutApi* | [**getAllPayouts**](https://github.com/swirepay/swirepay-js/tree/master/docs/PayoutApi.md#getAllPayouts) | **GET** /payout | Get All payouts *SwirepayApi.PayoutApi* | [**getPayoutByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/PayoutApi.md#getPayoutByGid) | **GET** /payout/{gid} | Get payout by Gid *SwirepayApi.PlanApi* | [**addPlan**](https://github.com/swirepay/swirepay-js/tree/master/docs/PlanApi.md#addPlan) | **POST** /plan | Add a new plan *SwirepayApi.PlanApi* | [**getAllPlan**](https://github.com/swirepay/swirepay-js/tree/master/docs/PlanApi.md#getAllPlan) | **GET** /plan | Get All Plan *SwirepayApi.PlanApi* | [**getplanByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/PlanApi.md#getplanByGid) | **GET** /plan/{gid} | Get Plan by Gid *SwirepayApi.PlanApi* | [**updatePlan**](https://github.com/swirepay/swirepay-js/tree/master/docs/PlanApi.md#updatePlan) | **PATCH** /plan/{gid} | Update Plan *SwirepayApi.PublicKeyApi* | [**getAllPublicKey**](https://github.com/swirepay/swirepay-js/tree/master/docs/PublicKeyApi.md#getAllPublicKey) | **GET** /public-key | Get All Public Key *SwirepayApi.PublicKeyApi* | [**rollPublicKeyByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/PublicKeyApi.md#rollPublicKeyByGid) | **PATCH** /public-key/{gid}/roll | Roll Public Key by Gid *SwirepayApi.RefundApi* | [**getAllRefunds**](https://github.com/swirepay/swirepay-js/tree/master/docs/RefundApi.md#getAllRefunds) | **GET** /refund | Get All Refunds *SwirepayApi.RefundApi* | [**getRefundByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/RefundApi.md#getRefundByGid) | **GET** /refund/{gid} | Get refund by Gid *SwirepayApi.SecretKeyApi* | [**getAllSecretKey**](https://github.com/swirepay/swirepay-js/tree/master/docs/SecretKeyApi.md#getAllSecretKey) | **GET** /secret-key | Get All Secret Key *SwirepayApi.SecretKeyApi* | [**rollSecretKeyByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/SecretKeyApi.md#rollSecretKeyByGid) | **PATCH** /secret-key/{gid}/roll | Roll Secret Key by Gid *SwirepayApi.SubscriptionApi* | [**addSubscription**](https://github.com/swirepay/swirepay-js/tree/master/docs/SubscriptionApi.md#addSubscription) | **POST** /subscription | Add a new subscription *SwirepayApi.SubscriptionApi* | [**cancelSubscription**](https://github.com/swirepay/swirepay-js/tree/master/docs/SubscriptionApi.md#cancelSubscription) | **PATCH** /subscription/{gid}/cancel | Cancel Subscription *SwirepayApi.SubscriptionApi* | [**getAllSubscription**](https://github.com/swirepay/swirepay-js/tree/master/docs/SubscriptionApi.md#getAllSubscription) | **GET** /subscription | Get All Subscription *SwirepayApi.SubscriptionApi* | [**getSubscriptionByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/SubscriptionApi.md#getSubscriptionByGid) | **GET** /subscription/{gid} | Get Subscription by Gid *SwirepayApi.TransactionApi* | [**getAllTransaction**](https://github.com/swirepay/swirepay-js/tree/master/docs/TransactionApi.md#getAllTransaction) | **GET** /transaction | Get All transactions *SwirepayApi.WebhookApi* | [**addWebhook**](https://github.com/swirepay/swirepay-js/tree/master/docs/WebhookApi.md#addWebhook) | **POST** /webhook | Add new webhook *SwirepayApi.WebhookApi* | [**deleteWebhook**](https://github.com/swirepay/swirepay-js/tree/master/docs/WebhookApi.md#deleteWebhook) | **DELETE** /webhook/{gid} | Delete webhook *SwirepayApi.WebhookApi* | [**getAllWebhook**](https://github.com/swirepay/swirepay-js/tree/master/docs/WebhookApi.md#getAllWebhook) | **GET** /webhook | Get All Webhook *SwirepayApi.WebhookApi* | [**getWebhookByGid**](https://github.com/swirepay/swirepay-js/tree/master/docs/WebhookApi.md#getWebhookByGid) | **GET** /webhook/{gid} | Get webhook by gid *SwirepayApi.WebhookApi* | [**updateWebhook**](https://github.com/swirepay/swirepay-js/tree/master/docs/WebhookApi.md#updateWebhook) | **PATCH** /webhook/{gid} | Update webhook ## Documentation for Models - [SwirepayApi.AccountRate](https://github.com/swirepay/swirepay-js/tree/master/docs/AccountRate.md) - [SwirepayApi.Acquirer](https://github.com/swirepay/swirepay-js/tree/master/docs/Acquirer.md) - [SwirepayApi.Address](https://github.com/swirepay/swirepay-js/tree/master/docs/Address.md) - [SwirepayApi.AddressRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/AddressRequest.md) - [SwirepayApi.BillingFrequency](https://github.com/swirepay/swirepay-js/tree/master/docs/BillingFrequency.md) - [SwirepayApi.Bin](https://github.com/swirepay/swirepay-js/tree/master/docs/Bin.md) - [SwirepayApi.Card](https://github.com/swirepay/swirepay-js/tree/master/docs/Card.md) - [SwirepayApi.CardRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/CardRequest.md) - [SwirepayApi.Category](https://github.com/swirepay/swirepay-js/tree/master/docs/Category.md) - [SwirepayApi.Country](https://github.com/swirepay/swirepay-js/tree/master/docs/Country.md) - [SwirepayApi.Currency](https://github.com/swirepay/swirepay-js/tree/master/docs/Currency.md) - [SwirepayApi.Customer](https://github.com/swirepay/swirepay-js/tree/master/docs/Customer.md) - [SwirepayApi.CustomerListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/CustomerListResponse.md) - [SwirepayApi.CustomerListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/CustomerListResponseEntity.md) - [SwirepayApi.CustomerRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/CustomerRequest.md) - [SwirepayApi.CustomerResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/CustomerResponse.md) - [SwirepayApi.Dispute](https://github.com/swirepay/swirepay-js/tree/master/docs/Dispute.md) - [SwirepayApi.DisputeListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/DisputeListResponse.md) - [SwirepayApi.DisputeListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/DisputeListResponseEntity.md) - [SwirepayApi.DisputeResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/DisputeResponse.md) - [SwirepayApi.Invoice](https://github.com/swirepay/swirepay-js/tree/master/docs/Invoice.md) - [SwirepayApi.InvoiceLineItem](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoiceLineItem.md) - [SwirepayApi.InvoiceLink](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoiceLink.md) - [SwirepayApi.InvoiceListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoiceListResponse.md) - [SwirepayApi.InvoiceListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoiceListResponseEntity.md) - [SwirepayApi.InvoiceRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoiceRequest.md) - [SwirepayApi.InvoiceResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoiceResponse.md) - [SwirepayApi.InvoicelineItemRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/InvoicelineItemRequest.md) - [SwirepayApi.Payment](https://github.com/swirepay/swirepay-js/tree/master/docs/Payment.md) - [SwirepayApi.PaymentLink](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentLink.md) - [SwirepayApi.PaymentLinkListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentLinkListResponse.md) - [SwirepayApi.PaymentLinkListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentLinkListResponseEntity.md) - [SwirepayApi.PaymentLinkRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentLinkRequest.md) - [SwirepayApi.PaymentLinkResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentLinkResponse.md) - [SwirepayApi.PaymentMethod](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentMethod.md) - [SwirepayApi.PaymentMethodRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentMethodRequest.md) - [SwirepayApi.PaymentMethodResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentMethodResponse.md) - [SwirepayApi.PaymentMethodType](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentMethodType.md) - [SwirepayApi.PaymentSession](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSession.md) - [SwirepayApi.PaymentSessionListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionListResponse.md) - [SwirepayApi.PaymentSessionListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionListResponseEntity.md) - [SwirepayApi.PaymentSessionPublicResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionPublicResponse.md) - [SwirepayApi.PaymentSessionRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionRequest.md) - [SwirepayApi.PaymentSessionResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentSessionResponse.md) - [SwirepayApi.PaymentType](https://github.com/swirepay/swirepay-js/tree/master/docs/PaymentType.md) - [SwirepayApi.Payout](https://github.com/swirepay/swirepay-js/tree/master/docs/Payout.md) - [SwirepayApi.PayoutListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/PayoutListResponse.md) - [SwirepayApi.PayoutListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/PayoutListResponseEntity.md) - [SwirepayApi.PayoutResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/PayoutResponse.md) - [SwirepayApi.Plan](https://github.com/swirepay/swirepay-js/tree/master/docs/Plan.md) - [SwirepayApi.PlanListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/PlanListResponse.md) - [SwirepayApi.PlanListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/PlanListResponseEntity.md) - [SwirepayApi.PlanRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/PlanRequest.md) - [SwirepayApi.PlanResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/PlanResponse.md) - [SwirepayApi.PublicKey](https://github.com/swirepay/swirepay-js/tree/master/docs/PublicKey.md) - [SwirepayApi.PublicKeyListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/PublicKeyListResponse.md) - [SwirepayApi.PublicKeyListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/PublicKeyListResponseEntity.md) - [SwirepayApi.PublicKeyRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/PublicKeyRequest.md) - [SwirepayApi.PublicKeyResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/PublicKeyResponse.md) - [SwirepayApi.Rate](https://github.com/swirepay/swirepay-js/tree/master/docs/Rate.md) - [SwirepayApi.Refund](https://github.com/swirepay/swirepay-js/tree/master/docs/Refund.md) - [SwirepayApi.RefundListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/RefundListResponse.md) - [SwirepayApi.RefundListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/RefundListResponseEntity.md) - [SwirepayApi.RefundResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/RefundResponse.md) - [SwirepayApi.SecretKey](https://github.com/swirepay/swirepay-js/tree/master/docs/SecretKey.md) - [SwirepayApi.SecretKeyListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/SecretKeyListResponse.md) - [SwirepayApi.SecretKeyListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/SecretKeyListResponseEntity.md) - [SwirepayApi.SecretKeyRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/SecretKeyRequest.md) - [SwirepayApi.SecretKeyResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/SecretKeyResponse.md) - [SwirepayApi.Subscription](https://github.com/swirepay/swirepay-js/tree/master/docs/Subscription.md) - [SwirepayApi.SubscriptionButton](https://github.com/swirepay/swirepay-js/tree/master/docs/SubscriptionButton.md) - [SwirepayApi.SubscriptionLineItem](https://github.com/swirepay/swirepay-js/tree/master/docs/SubscriptionLineItem.md) - [SwirepayApi.SubscriptionLineItemRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/SubscriptionLineItemRequest.md) - [SwirepayApi.SubscriptionLink](https://github.com/swirepay/swirepay-js/tree/master/docs/SubscriptionLink.md) - [SwirepayApi.SubscriptionListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/SubscriptionListResponse.md) - [SwirepayApi.SubscriptionListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/SubscriptionListResponseEntity.md) - [SwirepayApi.SubscriptionRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/SubscriptionRequest.md) - [SwirepayApi.SubscriptionResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/SubscriptionResponse.md) - [SwirepayApi.Support](https://github.com/swirepay/swirepay-js/tree/master/docs/Support.md) - [SwirepayApi.Tax](https://github.com/swirepay/swirepay-js/tree/master/docs/Tax.md) - [SwirepayApi.Transaction](https://github.com/swirepay/swirepay-js/tree/master/docs/Transaction.md) - [SwirepayApi.TransactionListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/TransactionListResponse.md) - [SwirepayApi.TransactionListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/TransactionListResponseEntity.md) - [SwirepayApi.Upi](https://github.com/swirepay/swirepay-js/tree/master/docs/Upi.md) - [SwirepayApi.UpiRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/UpiRequest.md) - [SwirepayApi.Webhook](https://github.com/swirepay/swirepay-js/tree/master/docs/Webhook.md) - [SwirepayApi.WebhookEvent](https://github.com/swirepay/swirepay-js/tree/master/docs/WebhookEvent.md) - [SwirepayApi.WebhookListResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/WebhookListResponse.md) - [SwirepayApi.WebhookListResponseEntity](https://github.com/swirepay/swirepay-js/tree/master/docs/WebhookListResponseEntity.md) - [SwirepayApi.WebhookRequest](https://github.com/swirepay/swirepay-js/tree/master/docs/WebhookRequest.md) - [SwirepayApi.WebhookResponse](https://github.com/swirepay/swirepay-js/tree/master/docs/WebhookResponse.md) ## Documentation for Authorization ### api_key - **Type**: API key - **API key parameter name**: x-api-key - **Location**: HTTP header