Skip to content

commercetools-mollie API

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

@evolve-framework/commercetools-mollie

MolliePaymentAdapter and its options, configuration and client.

Classes

MolliePaymentAdapterMollie as a commercetools payment provider.
import { MolliePaymentAdapter } from "@evolve-framework/commercetools-mollie";

Extends BasePaymentAdapter

new MolliePaymentAdapter(options: MolliePaymentAdapterOptions)
OptionTypeDescription
clientFactoryClientFactory

Pre-configured commercetools ClientFactory, used to build a system request builder for commercetools reads/writes.

configMollieConfig

Mollie credentials and runtime settings used by the SDK and routes.

MethodDescription
openPaymentRedirect(payment: Payment): Promise<string | undefined>Mollie's checkout page for the payment, while Mollie still reports it open.

Functions

createClient
import { createClient } from "@evolve-framework/commercetools-mollie";
function createClient(
config: MollieConfig,
): MollieClient
OptionTypeDescription
apiKeystring

Mollie API key (test_* or live_*).

serverUrlstring

Externally reachable base URL of this service; used to build the webhook URL passed to Mollie when creating payments.

shopName?string

The shop's name as the shopper's bank statement shows it. With it, a payment for an order is described as " order "; without it, as "Webshop payment ".

Returns MollieClient

@evolve-framework/commercetools-mollie/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-mollie/testing";
const mswServer: SetupServer

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