refundPayment

Issues a refund for a payment. Some payment service providers may limit the maximum amount for or timeframe in which you can refund a payment.

Arguments

Argument
Description

Parameters for RefundPayment

RefundPaymentInput Arguments

Argument
Description

id (ID)

ID of the payment to issue the refund for. When provided, invoice_id is ignored.

invoiceId (ID)

ID of the invoice to find a paid payment for refunding when no payment ID is provided.

amount (Float!)

Amount to refund.

reason (String!)

Reason for issuing the refund.

Return fields

Errors while issuing the refund. Can also contain error messages from the payment service provider.

payment (Payment)

The payment the refund is issued for.

refund (Refund)

The refund when succesfully issued.

Last updated

Was this helpful?