Adyen Node.js API Library

This is the officially supported NodeJS library for using Adyen's APIs.

Integration

The Library supports all APIs under the following services:

• BIN lookup API: The BIN Lookup API provides endpoints for retrieving information based on a given BIN. Current supported version: v52
• Checkout API: Our latest integration for accepting online payments. Current supported version: v69
• Configuration API: The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts. Current supported verison: v2
• Legal Entity Management API: Manage legal entities that contain information required for verification. Current supported version: v2
• Local/Cloud-based Terminal API: Our point-of-sale integration.
• Management API: Configure and manage your Adyen company and merchant accounts, stores, and payment terminals. Current supported version v1
• Payments API: Our classic integration for online payments. Current supported version: v68
• Payouts API: Endpoints for sending funds to your customers. Current supported version: v68
• Platforms APIs: Set of APIs when using Adyen for Platforms. This API is used for the classic integration.
  • Account API Current supported version: v6
  • Fund API Current supported version: v6
  • Hosted onboarding API: Current supported version: v6
  • Notification Configuration API Current supported version: v6
• Platforms Notifications Webhooks Current supported version: v6
• POS Terminal Management API: Endpoints for managing your point-of-sale payment terminals. Current supported version v1
• Recurring API: Endpoints for managing saved payment details. Current supported version: v68
• Stored Value API: Manage both online and point-of-sale gift cards and other stored-value cards. Current supported version: v46
• Transfers API The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument. v3

For more information, refer to our documentation or the API Explorer.

Prerequisites

• Adyen test account
• API key. For testing, your API credential needs to have the API PCI Payments role.
• Node 12 or higher

Installation

You can use NPM to add our library to your project

NPM

npm install --save @adyen/api-library

Alternatively, you can download the release on GitHub.

Using the library

General use with API key

Set up the client as a singleton resource; you can then use it to create service objects for the API calls that you make to Adyen:

    const client = new Client({apiKey: "YOUR_API_KEY", environment: "TEST"});

General use with API key for live environment

    const client = new Client({apiKey: "YOUR_API_KEY", environment: "LIVE"});

General use with basic auth

    const client = new Client({username: "YOUR_USERNAME", password: "YOUR_PASSWORD", environment: "TEST"});

Custom HTTP Client Configuration

By default, NodeJS https will be used to submit requests to the API. But you can change that by injecting your own HttpClient on your client instance. In the example below, we use axios:

const {Client, Config} = require('@adyen/api-library');
const axios = require("axios");
...
const config = new Config();
const client = new Client({
  config,
  httpClient: {
    async request(endpoint, json, config, isApiKeyRequired, requestOptions) {
        const response = await axios({
            method: 'POST',
            url: endpoint,
            data: JSON.parse(json),
            headers: {
                "X-API-Key": config.apiKey,
                "Content-type": "application/json"
            },
        });

        return response.data;
    }
  }
});
...

Proxy configuration

You can configure a proxy connection by injecting your own HttpURLConnectionClient on your client instance and changing the proxy setter value.

Example:

const {HttpURLConnectionClient, Client, Config} = require('@adyen/api-library');
...
const config = new Config();
const client = new Client({ config });
const httpClient = new HttpURLConnectionClient();
httpClient.proxy = { host: "http://google.com", port: 8888,  };

client.setEnvironment('TEST');
client.httpClient = httpClient;
...

Example integration

For a closer look at how our NodeJS library works, clone our example integration. This includes commented code, highlighting key features and concepts, and examples of API calls that can be made using the library.

Contributing

We strongly encourage you to join us in contributing to this repository so everyone can benefit from:

• New features and functionality
• Resolved bug fixes and issues
• Any general improvements

Read our contribution guidelines to find out how to create a pull request.

Support

If you have a feature request, or spotted a bug or a technical problem, create a GitHub issue. For other questions, contact our support team.

Licence

This repository is available under the MIT license.

See also

• example integration