POST

Update Payment Status


Updates the status of an order's payment.

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/payments/{paymentId}/orders/{orderId}/update-payment-transaction-status

Path Params
orderIdstringRequired

Order ID.


paymentIdstringRequired

Payment ID.

Body Params
statusstring

Payment status.

Response Object
orderTransactionsOrderTransactions

Order ID and its associated transactions after update.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/ecom/v1/payments/6ac204b6-d1df-44c7-ae84-aa08197380d8/orders/c7689f97-304f-425e-bbda-2451a32596c9/update-payment-transaction-status' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --data-binary '{ "status": "APPROVED" }'
Response
JSON
{ "orderTransactions": { "orderId": "c7689f97-304f-425e-bbda-2451a32596c9", "payments": [ { "id": "6ac204b6-d1df-44c7-ae84-aa08197380d8", "regularPaymentDetails": { "paymentOrderId": null, "gatewayTransactionId": "47303d3c-5a0f-4e6f-87f4-891d89cd8203", "paymentMethod": "WixPayments", "providerTransactionId": "47303d3c-5a0f-4e6f-87f4-891d89cd8203", "offlinePayment": false, "status": "APPROVED" }, "createdDate": "2023-11-17T15:00:27.293Z", "updatedDate": "2023-11-17T15:02:10.890Z", "amount": { "amount": "99.0", "formattedAmount": "$99.00" }, "refundDisabled": false } ], "refunds": [] } }
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?