Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory :  /home/corals/old/lib/internal/Customweb/Payment/Authorization/

Upload File : current_dir [ Writeable ] document_root [ Writeable ]

<?php
/**
  * You are allowed to use this API in your web application.
 *
 * Copyright (C) 2018 by customweb GmbH
 *
 * This program is licenced under the customweb software licence. With the
 * purchase or the installation of the software in your application you
 * accept the licence agreement. The allowed usage is outlined in the
 * customweb software licence which can be found under
 * http://www.sellxed.com/en/software-license-agreement
 *
 * Any modification or distribution is strictly forbidden. The license
 * grants you the installation in one application. For multiuse you will need
 * to purchase further licences at http://www.sellxed.com/shop.
 *
 * See the customweb software licence agreement for more details.
 *
 */

/**
 * This interface represents a capture done a transaction. On each transactin 
 * multiple refunds can be applied.
 * 
 * @author Thomas Hunziker
 *
 */
interface Customweb_Payment_Authorization_ITransactionCapture {
	
	const STATUS_SUCCEED = 'succeed';
	const STATUS_PENDING = 'pending';
	const STATUS_FAILED = 'failed';
	
	/**
	 * The refund id associated with this captured.
	 * 
	 * @return string 
	 */
	public function getCaptureId();
	
	/**
	 * This method returns the amount captured.
	 * 
	 * @return double Amount refunded
	 */
	public function getAmount();
	
	/**
	 * This method returns the date on which the amount was captured.
	 * 
	 * @return DateTime
	 */
	public function getCaptureDate();
	
	/**
	 * This method returns the status of the capture. A capture is status
	 * 'pending' in case it is not clear if it will succeed or not.
	 * 
	 * @return string The status of the catpure.
	 */
	public function getStatus();
	
	/**
	 * This method returns a set of labels, which describs this
	 * capture. 
	 * 
	 * The structure of the map:
	 * 
	 * array(
	 *    'label_key' => array(
	 *         'label' => 'Translated Title of the label',
	 *         'value' => 'The translated value of the label.',
	 *         'description' => 'An optional description of the label.',
	 *     ),
	 * )
	 * 
	 * @return array
	 */
	public function getCaptureLabels();
	
	/**
	 * This method returns a list of items used to capture.
	 * 
	 * @return Customweb_Payment_Authorization_IInvoiceItem[]
	 */
	public function getCaptureItems();
		
}