Variable: paymentLinks
The paymentLinks namespace contains all the functions related to paymentLinks operations such as starting the payment link creation flow. It can be accessed like this:const
paymentLinks:object
=paymentLinksNamespace.paymentLinks
Type declaration
getPaymentLinkCreationFlowUrl()
getPaymentLinkCreationFlowUrl: (Generates the URL for initiating a payment link creation flow with specified items.params
) =>string
Parameters
params
PaymentLinkParams
<CreatePaymentLinkSettings
>
An object containing:
- paymentLinkSettings: An object containing:
- authUrl: The embed auth link retrieved from the Qonto API. Must be a valid URL.
- items: An array of items to be included in the payment link. Each item must conform to the Item type and will be validated.
Returns
string
The full URL as a string, which can be used to launch the payment link creation flow in an iframe or browser.
Example
Throws
InvalidParametersError
If the provided authUrl or items array is invalid.