POST

Bulk Update Payment Statuses


Updates multiple order payments with a specified status.

Authentication

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

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/bulk/payments/update-payment-transaction-status

Body Params
paymentAndOrderIdsArray <PaymentAndOrderId>RequiredminItems 1maxItems 300

Order and payment IDs for which to update payment status.


returnFullEntityboolean

Whether to return the full payment entity (results.item) in the response.


statusstring

Payment status.

Response Object
resultsArray <BulkPaymentResult>

Bulk operation results.


bulkActionMetadataBulkActionMetadata

Bulk operation metadata.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/ecom/v1/bulk/payments/update-payment-transaction-status' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --data-binary '{ "paymentAndOrderIds": [ { "orderId": "69c598e5-987f-4429-9b61-76aaf47efedc", "paymentId": "770f8669-6ae7-47ed-a3fc-815ada5d86f9" }, { "orderId": "4f0cc39e-bb17-44be-bdbd-8331a5138987", "paymentId": "21cc0ff7-7ff5-4931-9ef8-1ee3d84a2215" } ], "status": "CANCELED", "returnFullEntity": false }'
Response
JSON
{ "results": [ { "itemMetadata": { "id": "770f8669-6ae7-47ed-a3fc-815ada5d86f9", "originalIndex": 0, "success": true } }, { "itemMetadata": { "id": "21cc0ff7-7ff5-4931-9ef8-1ee3d84a2215", "originalIndex": 1, "success": true } } ], "bulkActionMetadata": { "totalSuccesses": 2, "totalFailures": 0, "undetailedFailures": 0 } }
Errors

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

Event TriggersThis method triggers the following events:
Did this help?