POST

Create Order Payment Request


Developer Preview

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

Creates an order payment request.

The response includes the payment page URL, which you can share with the customer. To retrieve the URL later, call Get Order Payment Request URL.

Creation fails with ORDER_PAYMENT_REQUEST_PAGE_NOT_FOUND if the site doesn't have a Payment Request Page added and published.

Authentication

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

Permissions
Manage eCommerce - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/order-payment-requests

Errors
428Failed Precondition

There are 4 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:
Did this help?