updatePaymentStatus( )


Developer Preview

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

Updates the status of an order's payment.

The updatePaymentStatus() function returns a Promise that resolves when the payment status is updated.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Stores - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
identifiersUpdatePaymentStatusIdentifiersRequired

optionsUpdatePaymentStatusOptions
Returns
Return Type:Promise<UpdatePaymentStatusResponse>
Was this helpful?
Yes
No