hub / github.com/Adyen/adyen-node-api-library

github.com/Adyen/adyen-node-api-library @v31.0.0

Chat with this repo

repository ↗ · DeepWiki ↗ · release v31.0.0 ↗ · + Follow

9,808 symbols 11,548 edges 2,270 files 667 documented · 7%

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

Node js

Adyen API library for Node.js

npm bundle size (scoped)

This is the official Adyen API library for Node.js that we recommend for integrating with Adyen APIs.

Supported APIs

This library supports the following:

API name	API version	Description	API object
BIN Lookup API	v54	The BIN Lookup API provides endpoints for retrieving information based on a given BIN.	BinLookup
Checkout API	v71	Our latest integration for accepting online payments.	CheckoutAPI
Capital API	v1	Provides endpoints for embedding Adyen Capital into your marketplace or platform.	CapitalAPI
Configuration API	v2	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.	BalancePlatform
DataProtection API	v1	Adyen Data Protection API provides a way for you to process Subject Erasure Requests as mandated in GDPR. Use our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email)	DataProtection
Legal Entity Management API	v3	Manage legal entities that contain information required for verification.	LegalEntityManagement
Local/Cloud-based Terminal API	-	Our point-of-sale integration.	TerminalLocalAPI or TerminalCloudAPI
Management API	v3	Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.	Management
Open Banking API	v1	The Open Banking API provides secure endpoints to share financial data and services with third parties.	Open Banking
Payments API	v68	Our classic integration for online payments.	ClassicIntegrationAPI
Payouts API	v68	Endpoints for sending funds to your customers.	Payout
Platforms APIs	-	Set of APIs when using Adyen for Platforms. This API is used for the classic integration.	Platforms
Account API	v6	Provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents.	Account
Fund API	v6	Provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.	Fund
Hosted onboarding API	v6	Provides endpoints that you can use to generate links to Adyen-hosted pages, such as an onboarding page or a PCI compliance questionnaire. You can provide these links to your account holders so that they can complete their onboarding.	HostedOnboardingPage
Notification Configuration API	v6	Provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.	NotificationConfiguration
POS Terminal Management API	~~v1~~	~~Endpoints for managing your point-of-sale payment terminals.~~ ‼️ Deprecated: use instead the Management API for the management of your terminal fleet.	~~TerminalManagement~~
Recurring API	v68	Endpoints for managing saved payment details.	Recurring
Session Authentication API	v1

Extension points exported contracts — how you extend this code

ClientInterface (Interface)

(no doc) [5 implementers]

src/httpClient/clientInterface.ts

ConfigConstructor (Interface)

src/helpers/setApplicationInfo.ts

AccountTypes (Interface)

(no doc)

src/services/resource/platforms/account.ts

ApiError (Interface)

(no doc)

src/typings/apiError.ts

ExceptionInterface (Interface)

(no doc)

src/httpClient/httpClientException.ts

AccountDetailBalance (Interface)

(no doc)

src/typings/platformsFund.ts

AccountHolderBalanceRequest (Interface)

(no doc)

src/typings/platformsFund.ts

Core symbols most depended-on inside this repo

deserialize

called by 414

src/typings/terminal/models.ts

serialize

called by 244

src/typings/terminal/models.ts

src/typings/terminal/predefinedContentHelper.ts

stringify

called by 62

src/typings/payout/objectSerializer.ts

createClient

called by 34

src/__mocks__/base.ts

createRequest

called by 34

src/httpClient/httpURLConnectionClient.ts

getGenericWebhook

called by 20

src/notification/bankingWebhookHandler.ts

Shape

Method 4,163

Class 4,096

Enum 1,035

Interface 384

Function 130

Languages

TypeScript100%

Modules by API surface

src/typings/nexo.ts164 symbols

src/typings/marketPayNotifications.ts69 symbols

src/typings/marketPayAccount.ts56 symbols

src/services/management/index.ts32 symbols

src/typings/platformsFund.ts28 symbols

src/services/balancePlatform/index.ts26 symbols

src/typings/marketPayFund.ts23 symbols

src/typings/management/updateSplitConfigurationLogicRequest.ts18 symbols

src/typings/management/splitConfigurationLogic.ts18 symbols

src/typings/configurationWebhooks/configurationWebhooksHandler.ts16 symbols

src/services/paymentApi.ts16 symbols

src/notification/bankingWebhookHandler.ts16 symbols

For agents

$ claude mcp add adyen-node-api-library \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact