paymentRefund Mutation

DEPRECATED

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

Refunds the captured payment amount.

Requires the MANAGE_ORDERSpermission.

paymentRefund(
  amount: PositiveDecimal
  paymentId: ID!
): PaymentRefund @deprecated

Details

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

Arguments

amount ● PositiveDecimal

Transaction amount.

paymentId ● ID!

Payment ID.

Type

PaymentRefund

Refunds the captured payment amount.

Requires the MANAGE_ORDERSpermission.