Skip to main content

Remove a payment from an order

DELETE 

/v1/orders/:id/payments/:paymentId

Cancels one payment of an order and returns the order with its payment totals recalculated.

The payment is not erased: it stays on the order with canceled_at set, so the money movement remains auditable. Cancelling every payment is also what an order needs before it can be cancelled with POST /v1/orders/{id}/cancel.

Works on orders created through the API, placed by the customer on the storefront (INBOUND) or taken by the merchant on the POS (OUTBOUND). An order from a food app belongs to that channel and answers 422 order_not_modifiable.

Required scope: orders:write

Request​

Responses​

The order without the cancelled payment.