Adyen-api-js NPM

adyen-api-js

AdyenApiJs - JavaScript client for adyen-api-js Operations about payments, recurring and payout This SDK is automatically generated by the Swagger Codegen project:

API version: 30
Package version: 1.30.4
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 adyen-api-js --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 adyen-api-js from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('adyen-api-js') 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/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, 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 AdyenApiJs = require('adyen-api-js');

var defaultClient = AdyenApiJs.ApiClient.instance;

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

var api = new AdyenApiJs.PaymentApi()

var modificationRequest = new AdyenApiJs.ModificationRequest(); // {ModificationRequest} The Modification Request

api.adjustAuthorisation(modificationRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://pal-test.adyen.com/pal/servlet

Class	Method	HTTP request	Description
AdyenApiJs.PaymentApi	adjustAuthorisation	POST /Payment/v30/adjustAuthorisation	Increase or decrease the authorised amount
AdyenApiJs.PaymentApi	authorise	POST /Payment/v30/authorise	Creates a payment authorisation
AdyenApiJs.PaymentApi	authorise3d	POST /Payment/v30/authorise3d	Completes a 3-D Secure payment authorisation
AdyenApiJs.PaymentApi	cancel	POST /Payment/v30/cancel	Cancels a payment authorisation
AdyenApiJs.PaymentApi	cancelOrRefund	POST /Payment/v30/cancelOrRefund	Disable a stored payment detail
AdyenApiJs.PaymentApi	capture	POST /Payment/v30/capture	Captures a payment authorisation
AdyenApiJs.PaymentApi	refund	POST /Payment/v30/refund	Refunds a payment
AdyenApiJs.PayoutApi	confirm	POST /Payout/v30/confirmThirdParty	Confirm a payout
AdyenApiJs.PayoutApi	decline	POST /Payout/v30/declineThirdParty	Decline a payout
AdyenApiJs.PayoutApi	storeDetailAndSubmit	POST /Payout/v30/storeDetailAndSubmitThirdParty	Store the payouts details and make a payout request
AdyenApiJs.RecurringApi	disable	POST /Recurring/v30/disable	Disable a stored payment detail
AdyenApiJs.RecurringApi	listRecurringDetails	POST /Recurring/v30/listRecurringDetails	Retrieves stored payment details for a shopper