Kaizen
Browse modulesCheckoutcheckout/sharedInterfaces

Interface: PaymentProvider

Defined in: shared/checkout/provider.ts:149

Properties

key

readonly key: string;

Defined in: shared/checkout/provider.ts:150

Methods

authorize()

authorize(input: AuthorizeInput): Promise<PaymentOpResult>;

Defined in: shared/checkout/provider.ts:155

Parameters

ParameterType
inputAuthorizeInput

Returns

Promise<PaymentOpResult>


capture()

capture(input: CaptureInput): Promise<PaymentOpResult>;

Defined in: shared/checkout/provider.ts:159

Parameters

ParameterType
inputCaptureInput

Returns

Promise<PaymentOpResult>


confirm()?

optional confirm(input: ConfirmInput): Promise<PaymentOpResult>;

Defined in: shared/checkout/provider.ts:156

Parameters

ParameterType
inputConfirmInput

Returns

Promise<PaymentOpResult>


fetchPaymentState()?

optional fetchPaymentState(input: FetchStateInput): Promise<CanonicalTxn[]>;

Defined in: shared/checkout/provider.ts:163

Parameters

ParameterType
inputFetchStateInput

Returns

Promise<CanonicalTxn[]>


getCapabilities()

getCapabilities(method?: 
  | "check"
  | "unknown"
  | "other"
  | "card"
  | "gift_card"
  | "account_balance"
  | "bank_transfer"
  | "cash"
  | "warrant"
  | "wallet"
  | "money_order"): ProviderCapabilities;

Defined in: shared/checkout/provider.ts:151

Parameters

ParameterType
method?| "check" | "unknown" | "other" | "card" | "gift_card" | "account_balance" | "bank_transfer" | "cash" | "warrant" | "wallet" | "money_order"

Returns

ProviderCapabilities


parseWebhook()

parseWebhook(req: WebhookRequest): Promise<ParsedWebhook>;

Defined in: shared/checkout/provider.ts:162

Parameters

ParameterType
reqWebhookRequest

Returns

Promise<ParsedWebhook>


refund()

refund(input: RefundInput): Promise<PaymentOpResult>;

Defined in: shared/checkout/provider.ts:161

Parameters

ParameterType
inputRefundInput

Returns

Promise<PaymentOpResult>


void()

void(input: VoidInput): Promise<PaymentOpResult>;

Defined in: shared/checkout/provider.ts:160

Parameters

ParameterType
inputVoidInput

Returns

Promise<PaymentOpResult>

On this page