getAvailable(): BasketPayment[]¶

The getAvailable method retrieves the list of payment options that are currently available based on the basket's state and user eligibility.

Returned value¶

A returned value has a type of BasketPayment[] where BasketPayment represents the BasketPayment model.

Example¶

In this example, we use the basketPaymentsApi to get the available payment options.

useStorefront(async (storefront) => {
    let basketPaymentsApi = storefront.getApiSync('basketPaymentsApi');

    if (!basketPaymentsApi) {
        const featureSystemApi = this.getApiSync('FeatureSystemApi');
        await featureSystemApi.registerDynamic('basket');

        basketPaymentsApi = storefront.getApiSync('basketPaymentsApi');
    }

    const availablePaymentOptions = basketPaymentsApi.getAvailable();

    console.log('Available payment options:', availablePaymentOptions);
});

Basket Payments API methods reference¶

Models reference¶

BasketPayment