addPayments( )

Adds up to 50 payment records to an order.

The addPayments() function returns a Promise that resolves when the payment records are added to an order.

Note: This does NOT perform the actual charging - the order is only updated with records of the payments.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
orderIdstringRequired

Order ID.

paymentsArray<Payment>Required

Payments to be added to order.

Returns
Return Type:Promise<AddPaymentsResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?