Skip to content

Latest commit

 

History

History
137 lines (78 loc) · 2.53 KB

InstrumentSelector.md

File metadata and controls

137 lines (78 loc) · 2.53 KB

@bigcommerce/checkout-sdk / InstrumentSelector

Interface: InstrumentSelector

Table of contents

Methods

Methods

getCardInstrument

getCardInstrument(instrumentId): undefined | CardInstrument

Parameters

Name Type
instrumentId string

Returns

undefined | CardInstrument


getCardInstrumentOrThrow

getCardInstrumentOrThrow(instrumentId): CardInstrument

Parameters

Name Type
instrumentId string

Returns

CardInstrument


getDeleteError

getDeleteError(instrumentId?): undefined | Error

Parameters

Name Type
instrumentId? string

Returns

undefined | Error


getInstruments

getInstruments(): undefined | PaymentInstrument[]

Returns

undefined | PaymentInstrument[]


getInstrumentsByPaymentMethod

getInstrumentsByPaymentMethod(paymentMethod): undefined | PaymentInstrument[]

Parameters

Name Type
paymentMethod PaymentMethod<any>

Returns

undefined | PaymentInstrument[]


getInstrumentsMeta

getInstrumentsMeta(): undefined | VaultAccessToken

Returns

undefined | VaultAccessToken


getLoadError

getLoadError(): undefined | Error

Returns

undefined | Error


isDeleting

isDeleting(instrumentId?): boolean

Parameters

Name Type
instrumentId? string

Returns

boolean


isLoading

isLoading(): boolean

Returns

boolean