commercetools-pay-on-account API

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

@evolve-framework/commercetools-pay-on-account

PayOnAccountPaymentAdapter and its options, configuration and client.

Classes

PayOnAccountPaymentAdapterPaying on account, for B2B: it offers the invoice method to a business unit whose canPayOnAccount field allows it, and moves the payment to the PaymentCreditGranted state, refusing to start when that state is missing.

import { PayOnAccountPaymentAdapter } from "@evolve-framework/commercetools-pay-on-account";

Extends BasePaymentAdapter

new PayOnAccountPaymentAdapter(options: PayOnAccountPaymentAdapterOptions)

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

Constants

CT_BUSINESS_UNIT_CUSTOM_FIELD_PAY_ON_ACCOUNT

import { CT_BUSINESS_UNIT_CUSTOM_FIELD_PAY_ON_ACCOUNT } from "@evolve-framework/commercetools-pay-on-account";

const CT_BUSINESS_UNIT_CUSTOM_FIELD_PAY_ON_ACCOUNT: "canPayOnAccount"

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

const mswServer: SetupServer

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