commercetools-adyen API

Everything the package exports, by the path you import it from. Open an export for its signature and options.

@evolve-framework/commercetools-adyen

AdyenPaymentAdapter and its options, configuration and client.

Classes

AdyenPaymentAdapterAdyen as a commercetools payment provider.

import { AdyenPaymentAdapter } from "@evolve-framework/commercetools-adyen";

Extends BasePaymentAdapter

new AdyenPaymentAdapter(options: AdyenPaymentAdapterOptions)

Option	Type	Description
clientFactory	ClientFactory	Pre-configured commercetools ClientFactory, used to build a system request builder for commercetools reads/writes.
config	AdyenConfig	Adyen credentials and runtime settings used by the SDK and routes.
messagePublisher	MessagePublisher	Publisher used to emit Adyen notifications from the /push webhook. Pass a messagePublisher from a cloud adapter (e.g. new SqsPublisher(...)) or a NoopPublisher to disable publishing.

Method	Description
inFlightWindowMs(payment: Payment): number | undefined	A redirect nobody finishes produces no notification from Adyen, so its transaction would stay Pending for good.
validateApplePaySession( args: { cartId: string; displayName: string; domainName: string; merchantIdentifier: string; }, ): Promise<{ data: string; }>	Apple Pay's merchant validation, through Adyen's Apple Pay certificate, so the project needs no certificate of its own.
updateExpressCheckout( args: { paymentId: string; paymentData: string; amount: { currency: string; centAmount: number; }; deliveryMethods: { amount: { currency: string; centAmount: number; }; reference: string; description: string; selected: boolean; }[]; }, ): Promise<{ paymentData: string; }>	PayPal Express's address or shipping change, through Adyen's /paypal/updateOrder: the new amount and shipping options, against the payment's PayPal order.
submitPaymentDetails( args: { paymentId: string; targetId: string; targetType: "cart" | "order" | "invoice"; details: { [x: string]: any; }; }, ): Promise<TransactionResponse>	Continue a payment Adyen's component carried on in the page, with what it reported on onAdditionalDetails.
cancelPayment( args: { paymentId: string; targetId: string; targetType: "cart" | "order" | "invoice"; }, ): Promise<{ cancelled: boolean; }>	Withdraw a payment the shopper abandoned in Adyen's component.

PaymentErrorThrown by a payment adapter when a transaction cannot be started.

import { PaymentError } from "@evolve-framework/commercetools-adyen";

Extends Error

new PaymentError(message?: string)

Functions

createAdyenCheckoutAPI

import { createAdyenCheckoutAPI } from "@evolve-framework/commercetools-adyen";

function createAdyenCheckoutAPI(client: Client): CheckoutAPI

Returns CheckoutAPI

createAdyenClient

import { createAdyenClient } from "@evolve-framework/commercetools-adyen";

function createAdyenClient(config: AdyenConfig): Client

Option	Type	Description
apiKey	string	Adyen API key used to authenticate against the Adyen API.
hmacKey	string	HMAC key used to validate inbound webhook signatures.
merchantAccount	string	Adyen merchant account identifier.
serverUrl	string	Externally reachable base URL of this service; used to build return URLs.
environment?	AdyenEnvironment	Adyen environment to target. Defaults to "TEST" when omitted.
redirectWindowMs?	number	How long, in milliseconds, a shopper sent to a redirect may take before the attempt counts as abandoned and they may pay again. Defaults to one hour. Keep it longer than the redirect stays valid at Adyen for the methods you offer: a payment completed after it is still recorded, but the buyer may by then have paid a second time.

Returns Client

processNotification

import { processNotification } from "@evolve-framework/commercetools-adyen";

function processNotification(
  adapter: AdyenPaymentAdapter,
  notification: NotificationRequestItem,
): Promise<void>

Returns Promise<void>

Types

AdyenEnvironment

import { type AdyenEnvironment } from "@evolve-framework/commercetools-adyen";

export type AdyenEnvironment = "TEST" | "LIVE";

SupportedTypeEnum

import { type SupportedTypeEnum } from "@evolve-framework/commercetools-adyen";

export type SupportedTypeEnum = IdealDetails.TypeEnum | CardDetails.TypeEnum | KlarnaDetails.TypeEnum | StoredPaymentMethodDetails.TypeEnum | AfterpayDetails.TypeEnum | ApplePayDetails.TypeEnum | GooglePayDetails.TypeEnum | PayPalDetails.TypeEnum;

@evolve-framework/commercetools-adyen/testing

An MSW server with the mocked commercetools project, for testing a service that uses the adapter.

Constants

mswServer

import { mswServer } from "@evolve-framework/commercetools-adyen/testing";

const mswServer: SetupServer

Not listed: 2 options types. They appear as the tables under the constructors and functions they type.