Skip to content

@checkout-kit/conformance / ConformanceSuite

Interface: ConformanceSuite<TConfig> ​

Type Parameters ​

Type Parameter
TConfig

Properties ​

PropertyModifierTypeDescription
configreadonlyTConfig-
declineMessagereadonlystringThe message the issuer returns for decline, asserted verbatim.
evidenceForreadonly(action, testCase) => ActionEvidence | Promise<ActionEvidence>What comes back from the action, shaped to produce this case's outcome. It may call the backend first: that is what the bank's page or the provider's frame does.
handlersreadonlyreadonly RequestHandler<RequestHandlerDefaultInfo, any, any, RequestHandlerOptions>[]MSW handlers for this provider's backend.
instrumentForreadonly(testCase) => PaymentInstrumentThe instrument that starts each case. Plugins that collect the card somewhere else - a hosted page, a frame, a wallet - return { kind: 'none' } for all of them and decide the outcome in evidenceFor instead.
planId?readonlystring-
providerreadonlyPaymentProvider<TConfig>-
reset?readonly() => void | Promise<void>Reset the merchant fixture before each case. Defaults to checkout-kit's mock backend.
secrets?readonlyreadonly string[]Card numbers this suite pays with. None of them may come back out of the plugin.

Apache-2.0 · Headless engine, provider adapters and runnable examples.