POST

Initiate Payment

Developer Preview

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

Initiates payment for a payment link by creating a Wix eCommerce checkout. Intended for use by Wix users to create a Wix eCommerce checkout directly without opening a payment link. Initiating a payment will fail if successful payment will take the payment link over it's payment limit.

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

ID of the payment link to initiate payment for.

Response Object
One Of
Choose one of the following parameters
ecomCheckoutEcomCheckout

Wix eCommerce checkout.

cashierOrderCashierOrderdeprecated
ecomOrderEcomOrder

Wix eCommerce order.

Initiate Payment Link Payment
Request
cURL
Response
JSON
Errors
400Invalid Argument

There is 1 error with this status code.

428Failed Precondition

There are 8 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 Payment Initiated
Did this help?