Class Mage_Paypal_Model_Method_Agreement

Paypal Billing Agreement method

Varien_Object

Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract

Mage_Paypal_Model_Method_Agreement implements Mage_Payment_Model_Billing_Agreement_MethodInterface

Package: Mage\Paypal
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/Paypal/Model/Method/Agreement.php

Methods summary
`public`	# `__construct( array $params = array() )` Initialize Mage_Paypal_Model_Pro model Initialize Mage_Paypal_Model_Pro model Parameters `$params` `array` $params Overrides `Mage_Payment_Model_Method_Abstract::__construct()`
`public`	# `setStore( Mage_Core_Model_Store\|integer $store )` Store setter Also updates store ID in config object Store setter Also updates store ID in config object Parameters `$store` `Mage_Core_Model_Store\|integer` $store
`public Mage_Paypal_Model_Method_Agreement`	# `initBillingAgreementToken( Mage_Payment_Model_Billing_AgreementAbstract $agreement )` Init billing agreement Init billing agreement Parameters `$agreement` `Mage_Payment_Model_Billing_AgreementAbstract` $agreement Returns `Mage_Paypal_Model_Method_Agreement` Implementation of `Mage_Payment_Model_Billing_Agreement_MethodInterface::initBillingAgreementToken()`
`public array`	# `getBillingAgreementTokenInfo( Mage_Payment_Model_Billing_AgreementAbstract $agreement )` Retrieve billing agreement customer details by token Retrieve billing agreement customer details by token Parameters `$agreement` `Mage_Payment_Model_Billing_AgreementAbstract` $agreement Returns `array` Implementation of `Mage_Payment_Model_Billing_Agreement_MethodInterface::getBillingAgreementTokenInfo()`
`public Mage_Paypal_Model_Method_Agreement`	# `placeBillingAgreement( Mage_Payment_Model_Billing_AgreementAbstract $agreement )` Create billing agreement by token specified in request Create billing agreement by token specified in request Parameters `$agreement` `Mage_Payment_Model_Billing_AgreementAbstract` $agreement Returns `Mage_Paypal_Model_Method_Agreement` Implementation of `Mage_Payment_Model_Billing_Agreement_MethodInterface::placeBillingAgreement()`
`public Mage_Paypal_Model_Method_Agreement`	# `updateBillingAgreementStatus( Mage_Payment_Model_Billing_AgreementAbstract $agreement )` Update billing agreement status Update billing agreement status Parameters `$agreement` `Mage_Payment_Model_Billing_AgreementAbstract` $agreement Returns `Mage_Paypal_Model_Method_Agreement` Implementation of `Mage_Payment_Model_Billing_Agreement_MethodInterface::updateBillingAgreementStatus()`
`public Mage_Paypal_Model_Method_Agreement`	# `authorize( Varien_Object $payment, float $amount )` Authorize payment Authorize payment Parameters `$payment` `Varien_Object` $payment `$amount` `float` $amount Returns `Mage_Paypal_Model_Method_Agreement` Overrides `Mage_Payment_Model_Method_Abstract::authorize()`
`public Mage_Paypal_Model_Method_Agreement`	# `void( Varien_Object $payment )` Void payment Void payment Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `Mage_Paypal_Model_Method_Agreement` Overrides `Mage_Payment_Model_Method_Abstract::void()`
`public Mage_Paypal_Model_Method_Agreement`	# `capture( Varien_Object $payment, float $amount )` Capture payment Capture payment Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment `$amount` `float` $amount Returns `Mage_Paypal_Model_Method_Agreement` Overrides `Mage_Payment_Model_Method_Abstract::capture()`
`public Mage_Paypal_Model_Method_Agreement`	# `refund( Varien_Object $payment, float $amount )` Refund capture Refund capture Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment `$amount` `float` $amount Returns `Mage_Paypal_Model_Method_Agreement` Overrides `Mage_Payment_Model_Method_Abstract::refund()`
`public Mage_Paypal_Model_Method_Agreement`	# `cancel( Varien_Object $payment )` Cancel payment Cancel payment Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `Mage_Paypal_Model_Method_Agreement` Overrides `Mage_Payment_Model_Method_Abstract::cancel()`
`public boolean`	# `canReviewPayment( Mage_Payment_Model_Info $payment )` Whether payment can be reviewed Whether payment can be reviewed Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `boolean` Overrides `Mage_Payment_Model_Method_Abstract::canReviewPayment()`
`public boolean`	# `acceptPayment( Mage_Payment_Model_Info $payment )` Attempt to accept a pending payment Attempt to accept a pending payment Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `boolean` Throws `Mage_Core_Exception` Overrides `Mage_Payment_Model_Method_Abstract::acceptPayment()`
`public boolean`	# `denyPayment( Mage_Payment_Model_Info $payment )` Attempt to deny a pending payment Attempt to deny a pending payment Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `boolean` Throws `Mage_Core_Exception` Overrides `Mage_Payment_Model_Method_Abstract::denyPayment()`
`public array`	# `fetchTransactionInfo( Mage_Payment_Model_Info $payment, string $transactionId )` Fetch transaction details info Fetch transaction details info Parameters `$payment` `Mage_Payment_Model_Info` $payment `$transactionId` `string` $transactionId Returns `array` Overrides `Mage_Payment_Model_Method_Abstract::fetchTransactionInfo()`
`protected Mage_Paypal_Model_Method_Agreement`	# `_placeOrder( Mage_Sales_Model_Order_Payment $payment, float $amount )` Place an order with authorization or capture action Place an order with authorization or capture action Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment `$amount` `float` $amount Returns `Mage_Paypal_Model_Method_Agreement`
`protected`	# `_isAvailable( unknown_type $quote )` Parameters `$quote` `unknown_type` $quote
`public string`	# `getConfigPaymentAction( )` Payment action getter compatible with payment model Payment action getter compatible with payment model Returns `string` See Mage_Sales_Model_Payment::place() Overrides `Mage_Payment_Model_Method_Abstract::getConfigPaymentAction()`

Methods inherited from Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract
`assignData(), isAvailable()`

Methods inherited from Mage_Payment_Model_Method_Abstract
_debug(), _getHelper(), canAuthorize(), canCapture(), canCapturePartial(), canCreateBillingAgreement(), canEdit(), canFetchTransactionInfo(), canManageBillingAgreements(), canManageRecurringProfiles(), canOrder(), canRefund(), canRefundPartialPerInvoice(), canUseCheckout(), canUseForCountry(), canUseForCurrency(), canUseForMultishipping(), canUseInternal(), canVoid(), debugData(), getCode(), getConfigData(), getDebugFlag(), getFormBlockType(), getInfoBlockType(), getInfoInstance(), getTitle(), initialize(), isGateway(), isInitializeNeeded(), order(), prepareSave(), processBeforeRefund(), processCreditmemo(), processInvoice(), validate()

Constants inherited from Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract
`PAYMENT_INFO_REFERENCE_ID, TRANSPORT_BILLING_AGREEMENT_ID`

Constants inherited from Mage_Payment_Model_Method_Abstract
`ACTION_AUTHORIZE, ACTION_AUTHORIZE_CAPTURE, ACTION_ORDER, STATUS_APPROVED, STATUS_DECLINED, STATUS_ERROR, STATUS_SUCCESS, STATUS_UNKNOWN, STATUS_VOID`

Properties summary
`protected string`	`$_code`	`Mage_Paypal_Model_Config::METHOD_BILLING_AGREEMENT`	# Method code Method code
`protected boolean`	`$_canAuthorize`	`true`	# Method instance settings Method instance settings
`protected boolean`	`$_canCapture`	`true`	#
`protected boolean`	`$_canCapturePartial`	`true`	#
`protected boolean`	`$_canRefund`	`true`	#
`protected boolean`	`$_canRefundInvoicePartial`	`true`	#
`protected boolean`	`$_canVoid`	`true`	#
`protected boolean`	`$_canUseCheckout`	`false`	#
`protected boolean`	`$_canUseInternal`	`false`	#
`protected boolean`	`$_canFetchTransactionInfo`	`true`	#
`protected boolean`	`$_canReviewPayment`	`true`	#
`protected Mage_Paypal_Model_Pro`	`$_pro`	`null`	# Website Payments Pro instance Website Payments Pro instance

Properties inherited from Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract
`$_formBlockType, $_infoBlockType, $_isAvailable`

Properties inherited from Mage_Payment_Model_Method_Abstract
`$_canCancelInvoice, $_canCreateBillingAgreement, $_canManageRecurringProfiles, $_canOrder, $_canUseForMultishipping, $_debugReplacePrivateDataKeys, $_isGateway, $_isInitializeNeeded`

Packages

Classes

Exceptions

Class Mage_Paypal_Model_Method_Agreement

Parameters

Overrides

Parameters

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

See

Overrides