Delete Sales Order Payment

DELETE 
/api/sales-orders/:salesOrderId/payments/:payment

Delete a payment from a sales order. Recalculates the order's payment_status afterward.

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Guard: When the payment was created by applying a store credit (Credit-type payment) and a matching SalesCreditAllocation row exists (same sales_order_id and amount), this endpoint returns 422. Use the Unallocate Sales Credit endpoint under Customers instead — it reverses both the allocation and the corresponding payment atomically.

Authentication: Requires Bearer token.

Requires permission: sales_orders.manage_payments

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Unprocessable Entity

Response Headers

Content-Type

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.