failOrderPayment
Records that the payment for the order failed and moves its primary payment to failed. Fails with CONFLICT when the shop's payment state machine has no direct transition from the payment's current state to failed, or when the order has no payment. Does nothing when the payment is already failed. Fires the flows configured for the state change. Returns the order.
Required scopes
The token needs the orders:write access scope.
failOrderPayment(
id: ID!
): Order!
Arguments
failOrderPayment.id ● ID! non-null scalar
ID of the order whose payment failed.
Type
Order object
A customer order.