POST

Send Payment Link

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Sends a payment link to up to 50 specified recipients.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Paylinks
Manage Stores
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/payment-links/v1/payment-links/{paymentLinkId}/send
Path Params
paymentLinkIdstringRequired

Payment link ID.

Body Params
recipientsArray <Recipient>maxItems 50

Recipients who will receive the payment link.

Response Object
statusesArray <RecipientSendStatus>

Statuses of payment links sent.

sendMetadataSendMetadata

Send metadata.

Send Payment Link

Sends a payment link to the specified recipients

Request
cURL
Response
JSON
Errors
400Invalid Argument

There are 4 errors with this status code.

428Failed Precondition

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Payment Link Updated
Payment Link Sent
Did this help?