Qpapi NPM | npm.io

qualpay_platform_api

QualpayPlatformApi - JavaScript client for qualpay_platform_api This document describes the Qualpay Platform API. This SDK is automatically generated by the Swagger Codegen project:

API version: 1.1.9
Package version: 1.1.9
Build package: io.swagger.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 qualpay_platform_api --save

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

Finally, switch to the directory you want to use your qualpay_platform_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('qualpay_platform_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/qualpay_platform_api then install it via:

    npm install YOUR_USERNAME/qualpay_platform_api --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, that's to say your javascript file where you actually use this library):

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 QualpayPlatformApi = require('qualpay_platform_api');

var defaultClient = QualpayPlatformApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new QualpayPlatformApi.AccountUpdaterApi()

var body = new QualpayPlatformApi.AusRequest(); // {AusRequest} aus request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAusJsonRequest(body, callback);

Documentation for API Endpoints

All URIs are relative to https://api-test.qualpay.com/platform

Class	Method	HTTP request	Description
QualpayPlatformApi.AccountUpdaterApi	addAusJsonRequest	POST /aus/add	Submit Account Updater Request
QualpayPlatformApi.AccountUpdaterApi	browseAusRequestsDetail	GET /aus/request/detail	Get Detailed List of all Account Updater Results
QualpayPlatformApi.AccountUpdaterApi	browseAusRequestsSummary	GET /aus/request/summary	Get summary of all Account Updater Results
QualpayPlatformApi.AccountUpdaterApi	cancelAusRequest	POST /aus/request/cancel/{request_id}	Cancel Account Updater Request
QualpayPlatformApi.AccountUpdaterApi	createAusRequest	POST /aus/request/create	Create an Account Updater Request using Card IDs
QualpayPlatformApi.AccountUpdaterApi	getAusDetail	GET /aus/request/detail/{request_id}	Get detailed list of an Account Updater Request
QualpayPlatformApi.AccountUpdaterApi	getAusResponse	GET /aus/{requestId}	Get Account Updater Results (Full Card Number Requests)
QualpayPlatformApi.AccountUpdaterApi	getAusSummary	GET /aus/request/summary/{request_id}	Get summary of an Account Updater Request
QualpayPlatformApi.AccountUpdaterApi	putOnAusHold	POST /aus/hold	Put on Account Updater Harvest Hold
QualpayPlatformApi.AccountUpdaterApi	releaseFromAusHold	POST /aus/release	Release from Account Updater Harvest Hold
QualpayPlatformApi.ApplicationBoardingApi	addApp	POST /application/add	Create Application
QualpayPlatformApi.ApplicationBoardingApi	browseApps	GET /application/browse	Browse applications
QualpayPlatformApi.ApplicationBoardingApi	browseSalesReps	GET /application/sales/browse	Browse Sales Reps
QualpayPlatformApi.ApplicationBoardingApi	emailApp	POST /application/{appId}/email	Email Application
QualpayPlatformApi.ApplicationBoardingApi	getApp	GET /application/{appId}/get	Get Application
QualpayPlatformApi.ApplicationBoardingApi	saveData	POST /application/{appId}/data	Save Data
QualpayPlatformApi.ApplicationBoardingApi	uploadFile	POST /application/{appId}/upload	Upload Document
QualpayPlatformApi.ApplicationBoardingApi	validateApp	GET /application/{appId}/validate	Validate Application
QualpayPlatformApi.CustomerVaultApi	addBillingCard	POST /vault/customer/{customer_id}/billing	Add a Payment Method
QualpayPlatformApi.CustomerVaultApi	addCustomer	POST /vault/customer	Add a Customer
QualpayPlatformApi.CustomerVaultApi	addShippingAddress	POST /vault/customer/{customer_id}/shipping	Add a Shipping Address
QualpayPlatformApi.CustomerVaultApi	browseCustomers	GET /vault/customer	Get all Customers
QualpayPlatformApi.CustomerVaultApi	deleteBillingCard	PUT /vault/customer/{customer_id}/billing/delete	Delete a Payment Method
QualpayPlatformApi.CustomerVaultApi	deleteCustomer	DELETE /vault/customer/{customer_id}	Delete a Customer
QualpayPlatformApi.CustomerVaultApi	deleteShippingAddress	DELETE /vault/customer/{customer_id}/shipping/{id}	Delete a Shipping Address
QualpayPlatformApi.CustomerVaultApi	getBillingCards	GET /vault/customer/{customer_id}/billing	Get Payment Methods
QualpayPlatformApi.CustomerVaultApi	getCustomer	GET /vault/customer/{customer_id}	Get by Customer ID
QualpayPlatformApi.CustomerVaultApi	getShippingAddresses	GET /vault/customer/{customer_id}/shipping	Get Shipping Addresses
QualpayPlatformApi.CustomerVaultApi	setPrimaryBillingCard	PUT /vault/customer/{customer_id}/billing/primary	Set Primary Payment Method
QualpayPlatformApi.CustomerVaultApi	setPrimaryShippingAddress	PUT /vault/customer/{customer_id}/shipping/primary	Set Primary Shipping Address
QualpayPlatformApi.CustomerVaultApi	updateBillingCard	PUT /vault/customer/{customer_id}/billing	Update a Payment Method
QualpayPlatformApi.CustomerVaultApi	updateCustomer	PUT /vault/customer/{customer_id}	Update a Customer
QualpayPlatformApi.CustomerVaultApi	updateShippingAddress	PUT /vault/customer/{customer_id}/shipping	Update a Shipping Address
QualpayPlatformApi.DisputeManagementApi	acceptDispute	GET /dispute/{recId}/accept	Accept Dispute
QualpayPlatformApi.DisputeManagementApi	createDispute	GET /dispute/{merchantId}/create	Create Dispute Data
QualpayPlatformApi.DisputeManagementApi	getCreditedTran	GET /dispute/{recId}/creditedtrans	Get Credited Transaction Detail
QualpayPlatformApi.DisputeManagementApi	getDisputeResponse	GET /dispute/{recId}/response	Get Submitted Dispute Response
QualpayPlatformApi.DisputeManagementApi	getDisputes	GET /dispute/browse	Get Disputes
QualpayPlatformApi.DisputeManagementApi	getNonDisputedTran	GET /dispute/{recId}/nondisputedtrans	Get Non Disputed Transaction
QualpayPlatformApi.DisputeManagementApi	resetDispute	GET /dispute/{recId}/reset	Reset Dispute Data
QualpayPlatformApi.DisputeManagementApi	submitDisputesResponse	POST /dispute/{recId}/respond	Submit Dispute Response
QualpayPlatformApi.EmbeddedFieldsApi	getEmbeddedTransientKey	GET /embedded	Get Transient Key
QualpayPlatformApi.IntegratorApi	createTestAccount	POST /vendor/settings/account/add	Generate Test Account
QualpayPlatformApi.IntegratorApi	getMerchantSettings	GET /vendor/settings/{mid}	Merchant Settings
QualpayPlatformApi.IntegratorApi	rotateApiKey	POST /vendor/settings/key/{mid}	Generate Security Key
QualpayPlatformApi.InvoicingApi	addInvoicePayment	POST /invoice/{invoice_id}/payments	Add Payment to an Invoice
QualpayPlatformApi.InvoicingApi	browseBouncedInvoices	GET /invoice/bounced	Get Undelivered Invoices
QualpayPlatformApi.InvoicingApi	browseInvoicePayments	GET /invoice/payments	Get Invoice Payments
QualpayPlatformApi.InvoicingApi	browseInvoicePaymentsById	GET /invoice/{invoice_id}/payments	Get invoice payments by id
QualpayPlatformApi.InvoicingApi	browseInvoices	GET /invoice	Get all Invoices
QualpayPlatformApi.InvoicingApi	cancelInvoice	DELETE /invoice/{invoice_id}/cancel	Cancel an Invoice
QualpayPlatformApi.InvoicingApi	copyInvoice	POST /invoice/{invoice_id}/copy	Copy an Invoice
QualpayPlatformApi.InvoicingApi	createInvoice	POST /invoice	Create an invoice
QualpayPlatformApi.InvoicingApi	getInvoice	GET /invoice/{invoice_id}/detail	Get by Invoice ID
QualpayPlatformApi.InvoicingApi	removeInvoicePayment	DELETE /invoice/{invoice_id}/payments/{payment_id}	Remove an Invoice Payment
QualpayPlatformApi.InvoicingApi	resendInvoice	POST /invoice/{invoice_id}/resend	Resend an Invoice
QualpayPlatformApi.InvoicingApi	sendInvoice	POST /invoice/{invoice_id}/send	Send an Invoice
QualpayPlatformApi.InvoicingApi	updateDraftInvoice	PUT /invoice/{invoice_id}/draft	Update a Draft Invoice
QualpayPlatformApi.InvoicingApi	updateInvoicePayment	PUT /invoice/{invoice_id}/payments/{payment_id}	Update an Invoice Payment
QualpayPlatformApi.InvoicingApi	updateOutstandingInvoice	PUT /invoice/{invoice_id}/outstanding	Update an Outstanding Invoice
QualpayPlatformApi.QualpayCheckoutApi	addCheckout	POST /checkout	Create a Checkout Link
QualpayPlatformApi.QualpayCheckoutApi	getDetails	GET /checkout/{checkoutId}	Lookup Checkout Payment
QualpayPlatformApi.RecurringBillingApi	addPlan	POST /plan	Add a Recurring Plan
QualpayPlatformApi.RecurringBillingApi	addSubscription	POST /subscription	Add a Subscription
QualpayPlatformApi.RecurringBillingApi	archivePlan	POST /plan/{plan_code}/archive	Archive a Recurring Plan
QualpayPlatformApi.RecurringBillingApi	browsePlans	GET /plan	Get all Recurring Plans
QualpayPlatformApi.RecurringBillingApi	browseSubscriptions	GET /subscription	Get all Subscriptions
QualpayPlatformApi.RecurringBillingApi	cancelSubscription	POST /subscription/{subscription_id}/cancel	Cancel a Subscription
QualpayPlatformApi.RecurringBillingApi	deletePlan	DELETE /plan/{plan_id}/delete	Delete a Recurring Plan
QualpayPlatformApi.RecurringBillingApi	getAllSubscriptionTransactions	GET /subscription/transactions	Get all subscription transactions
QualpayPlatformApi.RecurringBillingApi	getPlan	GET /plan/{plan_code}	Find Recurring Plan by Plan Code
QualpayPlatformApi.RecurringBillingApi	getSubscription	GET /subscription/{subscription_id}	Get Subscription by Subscription ID
QualpayPlatformApi.RecurringBillingApi	getSubscriptionTransactions	GET /subscription/transactions/{subscription_id}	Get transactions by Subscription ID
QualpayPlatformApi.RecurringBillingApi	pauseSubscription	POST /subscription/{subscription_id}/pause	Pause a Subscription
QualpayPlatformApi.RecurringBillingApi	resumeSubscription	POST /subscription/{subscription_id}/resume	Resume a Subscription
QualpayPlatformApi.RecurringBillingApi	updatePlan	PUT /plan/{plan_code}	Update a Recurring Plan
QualpayPlatformApi.RecurringBillingApi	updateSubscription	PUT /subscription/{subscription_id}	Update a Subscription
QualpayPlatformApi.ReportingApi	browseAusRequests	GET /reporting/aus/detail	Account Updater Detail Report
QualpayPlatformApi.ReportingApi	browseAusSummary	GET /reporting/aus/summary	Account Updater Summary Report
QualpayPlatformApi.ReportingApi	browseBatches	GET /reporting/batches	Batch Report
QualpayPlatformApi.ReportingApi	browseDeposits	GET /reporting/deposits	Deposit Report
QualpayPlatformApi.ReportingApi	browseDisputes	GET /reporting/disputes	Disputes Report
QualpayPlatformApi.ReportingApi	browseStatementDisputeAdjustmentData	GET /reporting/statement-report/disputeAdjustment	Statement Dispute Adjustments Data
QualpayPlatformApi.ReportingApi	browseStatementFeeData	GET /reporting/statement-report/fees	Statement Fee Data
QualpayPlatformApi.ReportingApi	browseStatementPlanData	GET /reporting/statement-report/planType	Statement Plan Type Data
QualpayPlatformApi.ReportingApi	browseStatementReserveData	GET /reporting/statement-report/reserve	Statement Reserve Data
QualpayPlatformApi.ReportingApi	browseStatementSettlemetData	GET /reporting/statement-report/settlement	Statement Settlemet Data
QualpayPlatformApi.ReportingApi	browseTrans	GET /reporting/transactions	Settled Transaction Report
QualpayPlatformApi.ReportingApi	getTransactionByPgId	GET /reporting/transactions/bypgid/{pg_id}	Get transaction by PG ID
QualpayPlatformApi.ReportingApi	getTransactionRequests	GET /reporting/transaction-requests	Transaction Report
QualpayPlatformApi.WebhooksApi	addEvent	POST /webhook/{webhook_id}/event/{event}	Add an event
QualpayPlatformApi.WebhooksApi	addWebhook	POST /webhook	Add webhook
QualpayPlatformApi.WebhooksApi	browseWebhook	GET /webhook	Browse webhooks
QualpayPlatformApi.WebhooksApi	disableWebhook	PUT /webhook/{webhook_id}/disable	Disable a Webhook
QualpayPlatformApi.WebhooksApi	editWebhook	PUT /webhook/{webhook_id}	Update webhook
QualpayPlatformApi.WebhooksApi	enableWebhook	PUT /webhook/{webhook_id}/enable	Enable a Webhook
QualpayPlatformApi.WebhooksApi	getEvents	GET /webhook/{webhook_id}/event	Get events
QualpayPlatformApi.WebhooksApi	getWebhook	GET /webhook/{webhook_id}	Get webhook
QualpayPlatformApi.WebhooksApi	removeEvent	DELETE /webhook/{webhook_id}/event/{event}	Delete event

Documentation for Models

Documentation for Authorization

basicAuth

Type: HTTP basic authentication

qualpay

superagent querystring

@everything-registry/sub-chunk-2509 @infinitebrahmanuniverse/nolb-qp

1.1.19

3 years ago