commercetools-buckaroo API

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

@evolve-framework/commercetools-buckaroo

BuckarooPaymentAdapter and its options, configuration and client.

Classes

BuckarooPaymentAdapterBuckaroo as a commercetools payment provider, offering iDEAL and Mastercard.

import { BuckarooPaymentAdapter } from "@evolve-framework/commercetools-buckaroo";

Extends BasePaymentAdapter

new BuckarooPaymentAdapter(options: BuckarooPaymentAdapterOptions)

Option	Type	Description
clientFactory	ClientFactory	Pre-configured commercetools ClientFactory, used to build a system request builder for commercetools reads/writes.
config	BuckarooConfig	Buckaroo credentials and runtime settings used by the SDK and routes.

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

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

Extends Error

new PaymentError(message?: string)

Functions

buckarooIsHealthyCheck if the Buckaroo client is healthy by confirming the credentials with the Buckaroo API.

import { buckarooIsHealthy } from "@evolve-framework/commercetools-buckaroo";

function buckarooIsHealthy(client: Buckaroo): Promise<boolean>

Returns Promise<boolean>

createBuckarooClient

import { createBuckarooClient } from "@evolve-framework/commercetools-buckaroo";

function createBuckarooClient(config: BuckarooConfig): Buckaroo

Option	Type	Description
credentials	{ secretKey: string; websiteKey: string; }
mode	BuckarooMode
currency	string
serverUrl	string

Returns Buckaroo

Constants

staticAvailablePaymentMethods

import { staticAvailablePaymentMethods } from "@evolve-framework/commercetools-buckaroo";

const staticAvailablePaymentMethods: { localizedName?: string | undefined; image?: { url: string; alt: string; } | undefined; provider?: string | undefined; options?: { image?: { url: string; alt: …

Types

BuckarooMode

import { type BuckarooMode } from "@evolve-framework/commercetools-buckaroo";

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

PaymentServiceCode

import { type PaymentServiceCode } from "@evolve-framework/commercetools-buckaroo";

export type PaymentServiceCode = "ideal" | "mastercard";

@evolve-framework/commercetools-buckaroo/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-buckaroo/testing";

const mswServer: SetupServer

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