Paycomet_rest_api NPM

2.88.0 • Published 12 months ago

Install

Weekly downloads

License

Unlicense

Repository

Last release

12 months ago

paycomet_rest_api

PaycometRestApi - JavaScript client for paycomet_rest_api PAYCOMET API REST for customers. This SDK is automatically generated by the Swagger Codegen project:

API version: 2.88.0
Package version: 2.88.0
Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit https://www.paycomet.com

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 paycomet_rest_api --save

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 PaycometRestApi = require('paycomet_rest_api');

var api = new PaycometRestApi.BalanceApi()
var opts = { 
  'body': new PaycometRestApi.V1BalanceBody(), // {V1BalanceBody} 
  'PAYCOMET_API_TOKEN': "PAYCOMET_API_TOKEN_example" // {String} PAYCOMET API key (Query privilege required)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.productBalance(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://rest.paycomet.com

Class	Method	HTTP request	Description
PaycometRestApi.BalanceApi	productBalance	POST /v1/balance	Get balance info
PaycometRestApi.CardsApi	addUser	POST /v1/cards	Tokenizes a card. Either card number and CVC2 or jetToken are required. For you to send directly the card data you should be PCI certified or the accepting the requirement to submit quarterly SAQ-AEP and get ASV scans. For most users is strongly recommended getting the jetToken with JETIFRAME or using GET integration to register the cards instead of REST.
PaycometRestApi.CardsApi	editUser	POST /v1/cards/edit	Changes the expiry date, cvc2 or both
PaycometRestApi.CardsApi	infoUser	POST /v1/cards/info	Get card info
PaycometRestApi.CardsApi	physicalAddCard	POST /v1/cards/physical	Tokenize a card by physical encrypted data
PaycometRestApi.CardsApi	physicalEditCard	POST /v1/cards/physical/edit	Edit a card entered by physical encrypted data
PaycometRestApi.CardsApi	removeUser	POST /v1/cards/delete	Removes a card
PaycometRestApi.DccApi	dccPurchaseConfirm	POST /v1/payments/{order}/dcc/confirm	Confirm previous DCC payment
PaycometRestApi.DccApi	dccPurchaseCreate	POST /v1/payments/dcc	Create an DCC payment
PaycometRestApi.ErrorApi	infoError	POST /v1/errors	Gets an error description
PaycometRestApi.ExchangeApi	exchange	POST /v1/exchange	Converts a certain amount from a currency to another.
PaycometRestApi.FormApi	form	POST /v1/form	Create form view for user capture
PaycometRestApi.HeartbeatApi	heartbeat	POST /v1/heartbeat	Check the system
PaycometRestApi.IVRApi	checkSession	POST /v1/ivr/session-state	Checks an IVR session
PaycometRestApi.IVRApi	getSession	POST /v1/ivr/get-session	Creates an IVR session
PaycometRestApi.IVRApi	sessionCancel	POST /v1/ivr/session-cancel	Cancel an IVR session
PaycometRestApi.IpApi	getCountrybyIP	POST /v1/ip	Retrieves country info by IP
PaycometRestApi.IpApi	getRemoteAddress	POST /v1/ip/remote	Retrieves request remote address IP
PaycometRestApi.LaunchpadApi	launchAuthorization	POST /v1/launchpad/authorization	Creates a payment link and sends it to customer
PaycometRestApi.LaunchpadApi	launchPreauthorization	POST /v1/launchpad/preauthorization	Executes a preauthorization link and sends it to customer
PaycometRestApi.LaunchpadApi	launchSubscription	POST /v1/launchpad/subscription	Creates a subscription link and sends it to customer
PaycometRestApi.MarketplaceApi	splitTransfer	POST /v1/marketplace/split-transfer	Make a transfer to other accounts on PAYCOMET
PaycometRestApi.MarketplaceApi	splitTransferReversal	POST /v1/marketplace/split-transfer-reversal	Run a split transfer reversal based on a previous split transfer
PaycometRestApi.MarketplaceApi	transfer	POST /v1/marketplace/transfer	Run a transfer
PaycometRestApi.MarketplaceApi	transferReversal	POST /v1/marketplace/transfer-reversal	Make a transfer reversal based on a previous transfer
PaycometRestApi.MethodsApi	getUserPaymentMethods	POST /v1/methods	Retrieves product methods
PaycometRestApi.MiraklApi	miraklInvoicesSearch	POST /v1/invoices	Search Mirakl invoices
PaycometRestApi.PaymentsApi	executePurchase	POST /v1/payments	Executes a payment
PaycometRestApi.PaymentsApi	executePurchaseRtoken	POST /v1/payments/rtoken	Executes a payment by refence
PaycometRestApi.PaymentsApi	operationInfo	POST /v1/payments/{order}/info	Get info of a order
PaycometRestApi.PaymentsApi	operationSearch	POST /v1/payments/search	Search orders
PaycometRestApi.PreauthorizationsApi	cancelPreauthorization	POST /v1/payments/{order}/preauth/cancel	Cancel previous preauthorization
PaycometRestApi.PreauthorizationsApi	confirmPreauthorization	POST /v1/payments/{order}/preauth/confirm	Confirm previous preauthorization
PaycometRestApi.PreauthorizationsApi	createPreauthorization	POST /v1/payments/preauth	Create preauthorization
PaycometRestApi.PreauthorizationsApi	createPreauthorizationRtoken	POST /v1/payments/preauthrtoken	Creates a preauthorization by reference
PaycometRestApi.RefundApi	executeRefund	POST /v1/payments/{order}/refund	Perform a refund
PaycometRestApi.SepaApi	addDocument	POST /v1/sepa/add-document	Adds a SEPA document
PaycometRestApi.SepaApi	cancel	POST /v1/sepa/cancel	Cancel a SEPA order
PaycometRestApi.SepaApi	checkCustomer	POST /v1/sepa/check-customer	Check a customers SEPA documentation
PaycometRestApi.SepaApi	checkDocument	POST /v1/sepa/check-document	Check a SEPA document
PaycometRestApi.SepaApi	enroleCustomer	POST /v1/sepa/enrole-customer	Generate a link to make a account check to a customer
PaycometRestApi.SepaApi	sepaOperations	POST /v1/sepa/operations	Send SEPA operations
PaycometRestApi.SusbcriptionsApi	createSubscription	POST /v1/subscription	Create susbcription payment
PaycometRestApi.SusbcriptionsApi	editSubscription	POST /v1/subscription/{order}/edit	Edit susbcription payment.
PaycometRestApi.SusbcriptionsApi	infoSubscription	POST /v1/subscription/{order}/info	Gets susbcription info. If the susbscription is not a card subscription only the idUser is need. TokenUser is just for card subscriptions.
PaycometRestApi.SusbcriptionsApi	removeSubscription	POST /v1/subscription/{order}/remove	Remove susbcription payment. If the susbscription is not a card subscription only the idUser is need. TokenUser is just for card subscriptions.
PaycometRestApi.TokenApi	addToken	POST /v1/token	Tokenizes an APM.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

@babel/cli superagent

@everything-registry/sub-chunk-2418

2.88.0

12 months ago