Class Mage_Sales_Model_Order_Payment

Order payment information

Varien_Object

Mage_Sales_Model_Order_Payment

Package: Mage\Sales
Category: Mage
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/Sales/Model/Order/Payment.php

Methods summary
`protected`	# `_construct( )` Initialize resource model Initialize resource model
`public Mage_Sales_Model_Order_Payment`	# `setOrder( Mage_Sales_Model_Order $order )` Declare order model object Declare order model object Parameters `$order` `Mage_Sales_Model_Order` $order Returns `Mage_Sales_Model_Order_Payment`
`public Mage_Sales_Model_Order`	# `getOrder( )` Retrieve order model object Retrieve order model object Returns `Mage_Sales_Model_Order`
`public boolean`	# `canCapture( )` Check order payment capture action availability Check order payment capture action availability Returns `boolean`
`public`	# `canRefund( )`
`public`	# `canRefundPartialPerInvoice( )`
`public`	# `canCapturePartial( )`
`public Mage_Sales_Model_Order_Payment`	# `place( )` Authorize or authorize and capture payment on gateway, if applicable This method is supposed to be called only when order is placed Authorize or authorize and capture payment on gateway, if applicable This method is supposed to be called only when order is placed Returns `Mage_Sales_Model_Order_Payment`
`public Mage_Sales_Model_Order_Payment`	# `capture( mixed $invoice )` Capture the payment online Requires an invoice. If there is no invoice specified, will automatically prepare an invoice for order Updates transactions hierarchy, if required Updates payment totals, updates order status and adds proper comments Capture the payment online Requires an invoice. If there is no invoice specified, will automatically prepare an invoice for order Updates transactions hierarchy, if required Updates payment totals, updates order status and adds proper comments TODO: eliminate logic duplication with registerCaptureNotification() Returns `Mage_Sales_Model_Order_Payment` Throws `Mage_Core_Exception`
`public Mage_Sales_Model_Order_Payment`	# `registerCaptureNotification( float $amount )` Process a capture notification from a payment gateway for specified amount Creates an invoice automatically if the amount covers the order base grand total completely Updates transactions hierarchy, if required Prevents transaction double processing Updates payment totals, updates order status and adds proper comments Process a capture notification from a payment gateway for specified amount Creates an invoice automatically if the amount covers the order base grand total completely Updates transactions hierarchy, if required Prevents transaction double processing Updates payment totals, updates order status and adds proper comments TODO: eliminate logic duplication with capture() Parameters `$amount` `float` $amount Returns `Mage_Sales_Model_Order_Payment`
`public Mage_Sales_Model_Order_Payment`	# `registerAuthorizationNotification( float $amount )` Process authorization notification Process authorization notification Parameters `$amount` `float` $amount Returns `Mage_Sales_Model_Order_Payment` See `Mage_Sales_Model_Order_Payment::_authorize()`
`public Mage_Sales_Model_Order_Payment`	# `pay( Mage_Sales_Model_Order_Invoice $invoice )` Register payment fact: update self totals from the invoice Register payment fact: update self totals from the invoice Parameters `$invoice` `Mage_Sales_Model_Order_Invoice` $invoice Returns `Mage_Sales_Model_Order_Payment`
`public Mage_Sales_Model_Order_Payment`	# `cancelInvoice( Mage_Sales_Model_Order_Invoice $invoice )` Cancel specified invoice: update self totals from it Cancel specified invoice: update self totals from it Parameters `$invoice` `Mage_Sales_Model_Order_Invoice` $invoice Returns `Mage_Sales_Model_Order_Payment`
`protected Mage_Sales_Model_Order_Invoice`	# `_invoice( )` Create new invoice with maximum qty for invoice for each item register this invoice and capture Create new invoice with maximum qty for invoice for each item register this invoice and capture Returns `Mage_Sales_Model_Order_Invoice`
`public boolean`	# `canVoid( Varien_Object $document )` Check order payment void availability Check order payment void availability Returns `boolean`
`public Mage_Sales_Model_Order_Payment`	# `void( Varien_Object $document )` Void payment online Void payment online Parameters `$document` `Varien_Object` $document Returns `Mage_Sales_Model_Order_Payment` See `Mage_Sales_Model_Order_Payment::_void()`
`public Mage_Sales_Model_Payment`	# `registerVoidNotification( float $amount = null )` Process void notification Process void notification Parameters `$amount` `float` $amount Returns `Mage_Sales_Model_Payment` See `Mage_Sales_Model_Order_Payment::_void()`
`public Mage_Sales_Model_Order_Payment`	# `refund( Mage_Sales_Model_Order_Creditmemo $creditmemo )` Refund payment online or offline, depending on whether there is invoice set in the creditmemo instance Updates transactions hierarchy, if required Updates payment totals, updates order status and adds proper comments Refund payment online or offline, depending on whether there is invoice set in the creditmemo instance Updates transactions hierarchy, if required Updates payment totals, updates order status and adds proper comments Parameters `$creditmemo` `Mage_Sales_Model_Order_Creditmemo` $creditmemo Returns `Mage_Sales_Model_Order_Payment`
`public Mage_Sales_Model_Order_Payment`	# `registerRefundNotification( float $amount )` Process payment refund notification Updates transactions hierarchy, if required Prevents transaction double processing Updates payment totals, updates order status and adds proper comments TODO: potentially a full capture can be refunded. In this case if there was only one invoice for that transaction then we should create a creditmemo from invoice and also refund it offline TODO: implement logic of chargebacks reimbursements (via negative amount) Process payment refund notification Updates transactions hierarchy, if required Prevents transaction double processing Updates payment totals, updates order status and adds proper comments TODO: potentially a full capture can be refunded. In this case if there was only one invoice for that transaction then we should create a creditmemo from invoice and also refund it offline TODO: implement logic of chargebacks reimbursements (via negative amount) Parameters `$amount` `float` $amount Returns `Mage_Sales_Model_Order_Payment`
`public Mage_Sales_Model_Order_Payment`	# `cancelCreditmemo( Mage_Sales_Model_Order_Creditmemo $creditmemo )` Cancel a creditmemo: substract its totals from the payment Cancel a creditmemo: substract its totals from the payment Parameters `$creditmemo` `Mage_Sales_Model_Order_Creditmemo` $creditmemo Returns `Mage_Sales_Model_Order_Payment`
`public Mage_Sales_Model_Order_Payment`	# `cancel( )` Order cancellation hook for payment method instance Adds void transaction if needed Order cancellation hook for payment method instance Adds void transaction if needed Returns `Mage_Sales_Model_Order_Payment`
`public boolean`	# `canReviewPayment( )` Check order payment review availability Check order payment review availability Returns `boolean`
`public`	# `canFetchTransactionInfo( )`
`public Mage_Sales_Model_Order_Payment`	# `accept( )` Accept online a payment that is in review state Accept online a payment that is in review state Returns `Mage_Sales_Model_Order_Payment`
`public Mage_Sales_Model_Order_Payment`	# `deny( )` Accept order with payment method instance Accept order with payment method instance Returns `Mage_Sales_Model_Order_Payment`
`public Mage_Sales_Model_Order_Payment`	# `registerPaymentReviewAction( string $action, boolean $isOnline )` Perform the payment review action: either initiated by merchant or by a notification Perform the payment review action: either initiated by merchant or by a notification Sets order to processing state and optionally approves invoice or cancels the order Parameters `$action` `string` $action `$isOnline` `boolean` $isOnline Returns `Mage_Sales_Model_Order_Payment`
`protected Mage_Sales_Model_Order_Payment`	# `_order( float $amount )` Order payment either online Updates transactions hierarchy, if required Prevents transaction double processing Updates payment totals, updates order status and adds proper comments Order payment either online Updates transactions hierarchy, if required Prevents transaction double processing Updates payment totals, updates order status and adds proper comments Parameters `$amount` `float` $amount Returns `Mage_Sales_Model_Order_Payment`
`protected Mage_Sales_Model_Order_Payment`	# `_authorize( boolean $isOnline, float $amount )` Authorize payment either online or offline (process auth notification) Updates transactions hierarchy, if required Prevents transaction double processing Updates payment totals, updates order status and adds proper comments Authorize payment either online or offline (process auth notification) Updates transactions hierarchy, if required Prevents transaction double processing Updates payment totals, updates order status and adds proper comments Parameters `$isOnline` `boolean` $isOnline `$amount` `float` $amount Returns `Mage_Sales_Model_Order_Payment`
`public`	# `authorize( boolean $isOnline, float $amount )` Public access to _authorize method Public access to _authorize method Parameters `$isOnline` `boolean` $isOnline `$amount` `float` $amount
`protected Mage_Sales_Model_Order_Payment`	# `_void( boolean $isOnline, float $amount = null, string $gatewayCallback = 'void' )` Void payment either online or offline (process void notification) NOTE: that in some cases authorization can be voided after a capture. In such case it makes sense to use the amount void amount, for informational purposes. Updates payment totals, updates order status and adds proper comments Void payment either online or offline (process void notification) NOTE: that in some cases authorization can be voided after a capture. In such case it makes sense to use the amount void amount, for informational purposes. Updates payment totals, updates order status and adds proper comments Parameters `$isOnline` `boolean` $isOnline `$amount` `float` $amount `$gatewayCallback` `string` $gatewayCallback Returns `Mage_Sales_Model_Order_Payment`
`protected null\|Mage_Sales_Model_Order_Payment_Transaction`	# `_addTransaction( string $type, Mage_Sales_Model_Abstract $salesDocument = null, boolean $failsafe = false )` Create transaction, prepare its insertion into hierarchy and add its information to payment and comments Create transaction, prepare its insertion into hierarchy and add its information to payment and comments To add transactions and related information, the following information should be set to payment before processing: transaction_id is_transaction_closed (optional) - whether transaction should be closed or open (closed by default) parent_transaction_id (optional) should_close_parent_transaction (optional) - whether to close parent transaction (closed by default) If the sales document is specified, it will be linked to the transaction as related for future usage. Currently transaction ID is set into the sales object This method writes the added transaction ID into last_trans_id field of the payment object To make sure transaction object won't cause trouble before saving, use $failsafe = true Parameters `$type` `string` $type `$salesDocument` `Mage_Sales_Model_Abstract` $salesDocument `$failsafe` `boolean` $failsafe Returns `null\|Mage_Sales_Model_Order_Payment_Transaction`
`public null\|Mage_Sales_Model_Order_Payment_Transaction`	# `addTransaction( string $type, Mage_Sales_Model_Abstract $salesDocument = null, boolean $failsafe = false, string $message = false )` Public acces to _addTransaction method Public acces to _addTransaction method Parameters `$type` `string` $type `$salesDocument` `Mage_Sales_Model_Abstract` $salesDocument `$failsafe` `boolean` $failsafe `$message` `string` $message Returns `null\|Mage_Sales_Model_Order_Payment_Transaction`
`public Mage_Sales_Model_Order_Payment`	# `importTransactionInfo( Mage_Sales_Model_Order_Payment_Transaction $transactionTo )` Import details data of specified transaction Import details data of specified transaction Parameters `$transactionTo` `Mage_Sales_Model_Order_Payment_Transaction` $transactionTo Returns `Mage_Sales_Model_Order_Payment`
`public Mage_Sales_Model_Billing_Agreement\|null`	# `getBillingAgreement( )` Get the billing agreement, if any Get the billing agreement, if any Returns `Mage_Sales_Model_Billing_Agreement\|null`
`protected`	# `_updateTotals( array $data )` Totals updater utility method Updates self totals by keys in data array('key' => $delta) Totals updater utility method Updates self totals by keys in data array('key' => $delta) Parameters `$data` `array` $data
`protected boolean`	# `_isTransactionExists( string $txnId = null )` Check transaction existence by specified transaction id Check transaction existence by specified transaction id Parameters `$txnId` `string` $txnId Returns `boolean`
`protected string`	# `_appendTransactionToMessage( Mage_Sales_Model_Order_Payment_Transaction\|null $transaction, string $message )` Append transaction ID (if any) message to the specified message Append transaction ID (if any) message to the specified message Parameters `$transaction` `Mage_Sales_Model_Order_Payment_Transaction\|null` $transaction `$message` `string` $message Returns `string`
`protected string\|Mage_Sales_Model_Order_Status_History`	# `_prependMessage( string\|Mage_Sales_Model_Order_Status_History $messagePrependTo )` Prepend a "prepared_message" that may be set to the payment instance before, to the specified message Prepends value to the specified string or to the comment of specified order status history item instance Prepend a "prepared_message" that may be set to the payment instance before, to the specified message Prepends value to the specified string or to the comment of specified order status history item instance Parameters `$messagePrependTo` `string\|Mage_Sales_Model_Order_Status_History` $messagePrependTo Returns `string\|Mage_Sales_Model_Order_Status_History`
`protected string\|float`	# `_formatAmount( string\|float $amount, boolean $asFloat = false )` Round up and cast specified amount to float or string Round up and cast specified amount to float or string Parameters `$amount` `string\|float` $amount `$asFloat` `boolean` $asFloat Returns `string\|float`
`protected string`	# `_formatPrice( float $amount )` Format price with currency sign Format price with currency sign Parameters `$amount` `float` $amount Returns `string`
`protected Mage_Sales_Model_Order_Payment_Transaction\|false`	# `_lookupTransaction( string $txnId, string $txnType = false )` Find one transaction by ID or type Find one transaction by ID or type Parameters `$txnId` `string` $txnId `$txnType` `string` $txnType Returns `Mage_Sales_Model_Order_Payment_Transaction\|false`
`public Mage_Sales_Model_Order_Payment_Transaction\|false`	# `lookupTransaction( string $txnId, string $txnType = false )` Find one transaction by ID or type Find one transaction by ID or type Parameters `$txnId` `string` $txnId `$txnType` `string` $txnType Returns `Mage_Sales_Model_Order_Payment_Transaction\|false`
`public Mage_Sales_Model_Order_Payment_Transaction\|false`	# `getAuthorizationTransaction( )` Lookup an authorization transaction using parent transaction id, if set Lookup an authorization transaction using parent transaction id, if set Returns `Mage_Sales_Model_Order_Payment_Transaction\|false`
`public Mage_Sales_Model_Order_Payment_Transaction\|false`	# `getTransaction( string $transactionId )` Lookup the transaction by id Lookup the transaction by id Parameters `$transactionId` `string` $transactionId Returns `Mage_Sales_Model_Order_Payment_Transaction\|false`
`protected`	# `_generateTransactionId( string $type, Mage_Sales_Model_Order_Payment_Transaction $transactionBasedOn = false )` Update transaction ids for further processing If no transactions were set before invoking, may generate an "offline" transaction id Update transaction ids for further processing If no transactions were set before invoking, may generate an "offline" transaction id Parameters `$type` `string` $type `$transactionBasedOn` `Mage_Sales_Model_Order_Payment_Transaction` $transactionBasedOn
`protected boolean`	# `_isCaptureFinal( float $amountToCapture )` Decide whether authorization transaction may close (if the amount to capture will cover entire order) Decide whether authorization transaction may close (if the amount to capture will cover entire order) Parameters `$amountToCapture` `float` $amountToCapture Returns `boolean`
`protected Mage_Sales_Model_Order_Payment`	# `_beforeSave( )` Before object save manipulations Before object save manipulations Returns `Mage_Sales_Model_Order_Payment` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`protected`	# `_createBillingAgreement( )` Generate billing agreement object if there is billing agreement data Adds it to order as related object Generate billing agreement object if there is billing agreement data Adds it to order as related object
`public`	# `setTransactionAdditionalInfo( sting $key, string $value )` Additionnal transaction info setter Additionnal transaction info setter Parameters `$key` `sting` $key `$value` `string` $value
`public mixed`	# `getTransactionAdditionalInfo( sting $key = null )` Additionnal transaction info getter Additionnal transaction info getter Parameters `$key` `sting` $key Returns `mixed`
`public Mage_Sales_Model_Order_Payment`	# `resetTransactionAdditionalInfo( )` Reset transaction additional info property Reset transaction additional info property Returns `Mage_Sales_Model_Order_Payment`
`protected Mage_Sales_Model_Order_Invoice`	# `_getInvoiceForTransactionId( string $transactionId )` Return invoice model for transaction Return invoice model for transaction Parameters `$transactionId` `string` $transactionId Returns `Mage_Sales_Model_Order_Invoice`

Methods inherited from Mage_Payment_Model_Info
`_initAdditionalInformation(), decrypt(), encrypt(), getAdditionalInformation(), getData(), getMethodInstance(), hasAdditionalInformation(), setAdditionalInformation(), unsAdditionalInformation()`

Methods inherited from Mage_Core_Model_Abstract
_afterDelete(), _afterDeleteCommit(), _afterLoad(), _afterSave(), _beforeDelete(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()

Constants summary
`string`	`REVIEW_ACTION_ACCEPT`	`'accept'`	# Actions for payment when it triggered review state Actions for payment when it triggered review state
`string`	`REVIEW_ACTION_DENY`	`'deny'`	#
`string`	`REVIEW_ACTION_UPDATE`	`'update'`	#

Properties summary
`protected Mage_Sales_Model_Order`	`$_order`		# Order model object Order model object
`protected Mage_Sales_Model_Billing_Agreement`	`$_billingAgreement`	`null`	# Billing agreement instance that may be created during payment processing Billing agreement instance that may be created during payment processing
`protected string`	`$_canVoidLookup`	`null`	# Whether can void Whether can void
`protected array`	`$_transactionsLookup`	`array()`	# Transactions registry to spare resource calls array(txn_id => sales/order_payment_transaction) Transactions registry to spare resource calls array(txn_id => sales/order_payment_transaction)
`protected string`	`$_eventPrefix`	`'sales_order_payment'`	# Prefix of model events names Prefix of model events names
`protected string`	`$_eventObject`	`'payment'`	# Parameter name in event Parameter name in event In observe method you can use $observer->getEvent()->getObject() in this case
`protected array`	`$_transactionAdditionalInfo`	`array()`	# Transaction addditional information container Transaction addditional information container

Properties inherited from Mage_Payment_Model_Info
`$_additionalInformation`

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Interfaces

Class Mage_Sales_Model_Order_Payment

Parameters

Returns

Returns

Returns

Returns

Returns

Throws

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns

Returns

Overrides

Parameters

Parameters

Returns