Home > @shopware-pwa/shopware-6-client > getStoreOrderPaymentUrl

getStoreOrderPaymentUrl() function

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Signature:

export declare function getStoreOrderPaymentUrl(orderId: string, finishUrl?: string, errorUrl?: string, contextInstance?: ShopwareApiInstance): Promise<{
    redirectUrl: string | null;
    apiAlias: string;
}>;

Parameters

Parameter	Type	Description
orderId	string	Id of an order
finishUrl	string	URL where the customer is redirected to after payment is done
errorUrl	string	URL where the customer is redirected to after payment fails
contextInstance	ShopwareApiInstance

Returns:

Promise<{ redirectUrl: string | null; apiAlias: string; }>