Class Mage_Payment_Model_Method_Abstract

Payment method abstract model

Varien_Object

Mage_Payment_Model_Method_Abstract

Direct known subclasses

Mage_GoogleCheckout_Model_Payment, Mage_Payment_Model_Method_Banktransfer, Phoenix_Moneybookers_Model_Abstract, Mage_Payment_Model_Method_Cashondelivery, Mage_Payment_Model_Method_Cc, Mage_Payment_Model_Method_Checkmo, Mage_Payment_Model_Method_Free, Mage_Payment_Model_Method_Purchaseorder, Mage_Paypal_Model_Express, Mage_Paypal_Model_Standard, Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract

Indirect known subclasses

Abstract
Package: Mage\Payment
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Payment/Model/Method/Abstract.php

Methods summary
`public`	# `__construct( )`
`public boolean`	# `canOrder( )` Check order availability Check order availability Returns `boolean`
`public boolean`	# `canAuthorize( )` Check authorise availability Check authorise availability Returns `boolean`
`public boolean`	# `canCapture( )` Check capture availability Check capture availability Returns `boolean`
`public boolean`	# `canCapturePartial( )` Check partial capture availability Check partial capture availability Returns `boolean`
`public boolean`	# `canRefund( )` Check refund availability Check refund availability Returns `boolean`
`public boolean`	# `canRefundPartialPerInvoice( )` Check partial refund availability for invoice Check partial refund availability for invoice Returns `boolean`
`public boolean`	# `canVoid( Varien_Object $payment )` Check void availability Check void availability Parameters `$payment` `Varien_Object` $payment Returns `boolean`
`public boolean`	# `canUseInternal( )` Using internal pages for input payment data Can be used in admin Using internal pages for input payment data Can be used in admin Returns `boolean`
`public boolean`	# `canUseCheckout( )` Can be used in regular checkout Can be used in regular checkout Returns `boolean`
`public boolean`	# `canUseForMultishipping( )` Using for multiple shipping address Using for multiple shipping address Returns `boolean`
`public boolean`	# `canEdit( )` Can be edit order (renew order) Can be edit order (renew order) Returns `boolean`
`public boolean`	# `canFetchTransactionInfo( )` Check fetch transaction info availability Check fetch transaction info availability Returns `boolean`
`public boolean`	# `canCreateBillingAgreement( )` Check whether payment method instance can create billing agreements Check whether payment method instance can create billing agreements Returns `boolean`
`public array`	# `fetchTransactionInfo( Mage_Payment_Model_Info $payment, string $transactionId )` Fetch transaction info Fetch transaction info Parameters `$payment` `Mage_Payment_Model_Info` $payment `$transactionId` `string` $transactionId Returns `array`
`public boolean`	# `isGateway( )` Retrieve payment system relation flag Retrieve payment system relation flag Returns `boolean`
`public boolean`	# `isInitializeNeeded( )` flag if we need to run payment initialize while order place flag if we need to run payment initialize while order place Returns `boolean`
`public boolean`	# `canUseForCountry( mixed $country )` To check billing country is allowed for the payment method To check billing country is allowed for the payment method Returns `boolean`
`public boolean`	# `canUseForCurrency( string $currencyCode )` Check method for processing with base currency Check method for processing with base currency Parameters `$currencyCode` `string` $currencyCode Returns `boolean`
`public boolean`	# `canManageBillingAgreements( )` Check manage billing agreements availability Check manage billing agreements availability Returns `boolean`
`public boolean`	# `canManageRecurringProfiles( )` Whether can manage recurring profiles Whether can manage recurring profiles Returns `boolean`
`protected Mage_Payment_Helper_Data`	# `_getHelper( )` Retrieve model helper Retrieve model helper Returns `Mage_Payment_Helper_Data`
`public string`	# `getCode( )` Retrieve payment method code Retrieve payment method code Returns `string`
`public string`	# `getFormBlockType( )` Retrieve block type for method form generation Retrieve block type for method form generation Returns `string`
`public string`	# `getInfoBlockType( )` Retrieve block type for display method information Retrieve block type for display method information Returns `string`
`public Mage_Payment_Model_Info`	# `getInfoInstance( )` Retrieve payment iformation model object Retrieve payment iformation model object Returns `Mage_Payment_Model_Info`
`public Mage_Payment_Model_Abstract`	# `validate( )` Validate payment method information object Validate payment method information object Returns `Mage_Payment_Model_Abstract`
`public Mage_Payment_Model_Abstract`	# `order( Varien_Object $payment, float $amount )` Order payment abstract method Order payment abstract method Parameters `$payment` `Varien_Object` $payment `$amount` `float` $amount Returns `Mage_Payment_Model_Abstract`
`public Mage_Payment_Model_Abstract`	# `authorize( Varien_Object $payment, float $amount )` Authorize payment abstract method Authorize payment abstract method Parameters `$payment` `Varien_Object` $payment `$amount` `float` $amount Returns `Mage_Payment_Model_Abstract`
`public Mage_Payment_Model_Abstract`	# `capture( Varien_Object $payment, float $amount )` Capture payment abstract method Capture payment abstract method Parameters `$payment` `Varien_Object` $payment `$amount` `float` $amount Returns `Mage_Payment_Model_Abstract`
`public Mage_Payment_Model_Method_Abstract`	# `processInvoice( Mage_Sales_Model_Order_Invoice $invoice, Mage_Sales_Model_Order_Payment $payment )` Set capture transaction ID to invoice for informational purposes Set capture transaction ID to invoice for informational purposes Parameters `$invoice` `Mage_Sales_Model_Order_Invoice` $invoice `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `Mage_Payment_Model_Method_Abstract`
`public Mage_Payment_Model_Method_Abstract`	# `processBeforeRefund( Mage_Sales_Model_Order_Invoice $invoice, Mage_Sales_Model_Order_Payment $payment )` Set refund transaction id to payment object for informational purposes Candidate to be deprecated: there can be multiple refunds per payment, thus payment.refund_transaction_id doesn't make big sense Set refund transaction id to payment object for informational purposes Candidate to be deprecated: there can be multiple refunds per payment, thus payment.refund_transaction_id doesn't make big sense Parameters `$invoice` `Mage_Sales_Model_Order_Invoice` $invoice `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `Mage_Payment_Model_Method_Abstract`
`public Mage_Payment_Model_Abstract`	# `refund( Varien_Object $payment, float $amount )` Refund specified amount for payment Refund specified amount for payment Parameters `$payment` `Varien_Object` $payment `$amount` `float` $amount Returns `Mage_Payment_Model_Abstract`
`public Mage_Payment_Model_Method_Abstract`	# `processCreditmemo( Mage_Sales_Model_Order_Creditmemo $creditmemo, Mage_Sales_Model_Order_Payment $payment )` Set transaction ID into creditmemo for informational purposes Set transaction ID into creditmemo for informational purposes Parameters `$creditmemo` `Mage_Sales_Model_Order_Creditmemo` $creditmemo `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `Mage_Payment_Model_Method_Abstract`
`public Mage_Payment_Model_Abstract`	# `cancel( Varien_Object $payment )` Cancel payment abstract method Cancel payment abstract method Parameters `$payment` `Varien_Object` $payment Returns `Mage_Payment_Model_Abstract`
`public Mage_Payment_Model_Abstract`	# `void( Varien_Object $payment )` Void payment abstract method Void payment abstract method Parameters `$payment` `Varien_Object` $payment Returns `Mage_Payment_Model_Abstract`
`public boolean`	# `canReviewPayment( Mage_Payment_Model_Info $payment )` Whether this method can accept or deny payment Whether this method can accept or deny payment Parameters `$payment` `Mage_Payment_Model_Info` $payment Returns `boolean`
`public boolean`	# `acceptPayment( Mage_Payment_Model_Info $payment )` Attempt to accept a payment that us under review Attempt to accept a payment that us under review Parameters `$payment` `Mage_Payment_Model_Info` $payment Returns `boolean` Throws `Mage_Core_Exception`
`public boolean`	# `denyPayment( Mage_Payment_Model_Info $payment )` Attempt to deny a payment that us under review Attempt to deny a payment that us under review Parameters `$payment` `Mage_Payment_Model_Info` $payment Returns `boolean` Throws `Mage_Core_Exception`
`public string`	# `getTitle( )` Retrieve payment method title Retrieve payment method title Returns `string`
`public mixed`	# `getConfigData( string $field, integer\|string\|null\|Mage_Core_Model_Store $storeId = null )` Retrieve information from payment configuration Retrieve information from payment configuration Parameters `$field` `string` $field `$storeId` `integer\|string\|null\|Mage_Core_Model_Store` $storeId Returns `mixed`
`public Mage_Payment_Model_Info`	# `assignData( mixed $data )` Assign data to info model instance Assign data to info model instance Parameters `$data` `mixed` $data Returns `Mage_Payment_Model_Info`
`public Mage_Payment_Model_Abstract`	# `prepareSave( )` Parepare info instance for save Parepare info instance for save Returns `Mage_Payment_Model_Abstract`
`public boolean`	# `isAvailable( Mage_Sales_Model_Quote\|null $quote = null )` Check whether payment method can be used Check whether payment method can be used TODO: payment method instance is not supposed to know about quote Parameters `$quote` `Mage_Sales_Model_Quote\|null` $quote Returns `boolean`
`public Mage_Payment_Model_Abstract`	# `initialize( string $paymentAction, object $stateObject )` Method that will be executed instead of authorize or capture if flag isInitializeNeeded set to true Method that will be executed instead of authorize or capture if flag isInitializeNeeded set to true Parameters `$paymentAction` `string` $paymentAction `$stateObject` `object` $stateObject Returns `Mage_Payment_Model_Abstract`
`public string`	# `getConfigPaymentAction( )` Get config payment action url Used to universalize payment actions when processing payment place Get config payment action url Used to universalize payment actions when processing payment place Returns `string`
`protected`	# `_debug( mixed $debugData )` Log debug data to file Log debug data to file Parameters `$debugData` `mixed` $debugData
`public boolean`	# `getDebugFlag( )` Define if debugging is enabled Define if debugging is enabled Returns `boolean`
`public`	# `debugData( mixed $debugData )` Used to call debug method from not Payment Method context Used to call debug method from not Payment Method context Parameters `$debugData` `mixed` $debugData

Constants summary
`string`	`ACTION_ORDER`	`'order'`	#
`string`	`ACTION_AUTHORIZE`	`'authorize'`	#
`string`	`ACTION_AUTHORIZE_CAPTURE`	`'authorize_capture'`	#
`string`	`STATUS_UNKNOWN`	`'UNKNOWN'`	#
`string`	`STATUS_APPROVED`	`'APPROVED'`	#
`string`	`STATUS_ERROR`	`'ERROR'`	#
`string`	`STATUS_DECLINED`	`'DECLINED'`	#
`string`	`STATUS_VOID`	`'VOID'`	#
`string`	`STATUS_SUCCESS`	`'SUCCESS'`	#

Properties summary
`protected mixed`	`$_code`		#
`protected string`	`$_formBlockType`	`'payment/form'`	#
`protected string`	`$_infoBlockType`	`'payment/info'`	#
`protected boolean`	`$_isGateway`	`false`	# Payment Method features Payment Method features
`protected boolean`	`$_canOrder`	`false`	#
`protected boolean`	`$_canAuthorize`	`false`	#
`protected boolean`	`$_canCapture`	`false`	#
`protected boolean`	`$_canCapturePartial`	`false`	#
`protected boolean`	`$_canRefund`	`false`	#
`protected boolean`	`$_canRefundInvoicePartial`	`false`	#
`protected boolean`	`$_canVoid`	`false`	#
`protected boolean`	`$_canUseInternal`	`true`	#
`protected boolean`	`$_canUseCheckout`	`true`	#
`protected boolean`	`$_canUseForMultishipping`	`true`	#
`protected boolean`	`$_isInitializeNeeded`	`false`	#
`protected boolean`	`$_canFetchTransactionInfo`	`false`	#
`protected boolean`	`$_canReviewPayment`	`false`	#
`protected boolean`	`$_canCreateBillingAgreement`	`false`	#
`protected boolean`	`$_canManageRecurringProfiles`	`true`	#
`protected boolean`	`$_canCancelInvoice`	`false`	# TODO: whether a captured transaction may be voided by this gateway This may happen when amount is captured, but not settled TODO: whether a captured transaction may be voided by this gateway This may happen when amount is captured, but not settled
`protected array`	`$_debugReplacePrivateDataKeys`	`array()`	# Fields that should be replaced in debug with '*' Fields that should be replaced in debug with '*'

Packages

Classes

Interfaces

Exceptions

Class Mage_Payment_Model_Method_Abstract

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters