TypeScript SDK

IntroCopy Anchor Link

The Adyen Checkout API SDK provides access to the Adyen Checkout API REST APIs.

Adyen Checkout API

InstallationCopy Anchor Link

The SDK compiles to dist/ before it can be referenced — run its build script once in the SDK folder, then add it to your project by path:

npm install <path-to-sdk>

Quick StartCopy Anchor Link

Create one client and reuse it. Configure its behaviour through ClientOptions.

import { AdyenCheckoutApiClient } from "adyen-checkout-api";

const client = new AdyenCheckoutApiClient({
  apiKeyAuth: "YOUR_API_KEY",
  basicAuth: { username: "YOUR_USERNAME", password: "YOUR_PASSWORD" },
});

Nothing in ClientOptions is required — new AdyenCheckoutApiClient() compiles — and each option left out falls back to its default. This API declares one environment, so there is no environment to select and no host to state at the construction site.

From CommonJSCopy Anchor Link

The package ships both dialects from a single entry, so require works with full types. In a TypeScript CommonJS file use the import ... = require(...) form — a plain destructuring require runs fine but gives you any.

import sdk = require("adyen-checkout-api");

const client = new sdk.AdyenCheckoutApiClient({
  apiKeyAuth: "YOUR_API_KEY",
  basicAuth: { username: "YOUR_USERNAME", password: "YOUR_PASSWORD" },
});