<?php
/**
 * Payout gateway contract.
 *
 * @package PPL_AFW
 */

namespace PPL_AFW\Payouts;

defined( 'ABSPATH' ) || exit;

/**
 * Implement and register via the ppl_afw_payout_gateways filter to add
 * a payout method.
 */
interface Payout_Gateway_Interface {

	/**
	 * Machine id, e.g. paypal.
	 *
	 * @since 1.0.0
	 * @return string
	 */
	public function id();

	/**
	 * Human label shown in settings and the portal.
	 *
	 * @since 1.0.0
	 * @return string
	 */
	public function label();

	/**
	 * Executes a payout.
	 *
	 * Return the gateway reference string when the money was sent. Return
	 * array( 'status' => 'processing', 'reference' => '...', 'note' => '...' )
	 * when the payout is recorded but no money has moved yet (an offline
	 * method, or a provider that confirms later); the payout then waits in
	 * processing until Payouts_Service::complete_payout() or fail_payout().
	 * Return a WP_Error when nothing could be sent.
	 *
	 * @since 1.0.0
	 * @param object $payout    Payout row.
	 * @param object $affiliate Affiliate row.
	 * @return string|array|\WP_Error Gateway reference, processing result or error.
	 */
	public function process( $payout, $affiliate );
}