WC_Payment_Gateway::process_refund( int $order_id, float|null $amount = null, string $reason = '' )

Process refund.


Description Description

If the gateway declares ‘refunds’ support, this will allow it to refund. a passed in amount.


Parameters Parameters

$order_id

(Required) Order ID.

$amount

(Optional) Refund amount.

Default value: null

$reason

(Optional) Refund reason.

Default value: ''


Top ↑

Return Return

(boolean) True or false based on success, or a WP_Error object.


Top ↑

Source Source

File: includes/abstracts/abstract-wc-payment-gateway.php

	public function process_refund( $order_id, $amount = null, $reason = '' ) {
		return false;
	}

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.