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

getOrderPaymentUrl() 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.

Get payment address to redirect user after placing order.

Signature:

export declare function getOrderPaymentUrl({ orderId, finishUrl, }: {
    orderId: string;
    finishUrl?: string;
}, contextInstance?: ShopwareApiInstance): Promise<{
    paymentUrl: string;
}>;

Parameters

Parameter	Type	Description
{ orderId, finishUrl, }	{ orderId: string; finishUrl?: string; }
contextInstance	ShopwareApiInstance

Returns:

Promise<{ paymentUrl: string; }>

Exceptions

ClientApiError