paymentVoid Mutation

DEPRECATED

The legacy Payments API is deprecated and will be removed. Use the Transactions API instead.

Voids the authorized payment.

Requires the MANAGE_ORDERSpermission.

paymentVoid(
  paymentId: ID!
): PaymentVoid @deprecated

Details

type PaymentVoid {
  payment: Payment
  paymentErrors: [PaymentError!]! @deprecated
  errors: [PaymentError!]!
}

Arguments

paymentId ● ID!

Payment ID.

Type

PaymentVoid

Voids the authorized payment.

Requires the MANAGE_ORDERSpermission.