Class Mage_Paypal_Model_Pro

PayPal Website Payments Pro implementation for payment method instaces This model was created because right now PayPal Direct and PayPal Express payment methods cannot have same abstract

Direct known subclasses

Mage_PaypalUk_Model_Pro

Package: Mage\Paypal
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Located at code/core/Mage/Paypal/Model/Pro.php

Methods summary
`public`	# `setMethod( string $code, integer\|null $storeId = null )` Payment method code setter. Also instantiates/updates config Payment method code setter. Also instantiates/updates config Parameters `$code` `string` $code `$storeId` `integer\|null` $storeId
`public`	# `setConfig( Mage_Paypal_Model_Config $instace, integer $storeId = null )` Config instance setter Config instance setter Parameters `$instace` `Mage_Paypal_Model_Config` $instace `$storeId` `integer` $storeId
`public Mage_Paypal_Model_Config`	# `getConfig( )` Config instance getter Config instance getter Returns `Mage_Paypal_Model_Config`
`public Mage_Paypal_Model_Api_Nvp`	# `getApi( )` API instance getter Sets current store id to current config instance and passes it to API API instance getter Sets current store id to current config instance and passes it to API Returns `Mage_Paypal_Model_Api_Nvp`
`public Mage_Paypal_Model_Pro`	# `resetApi( )` Destroy existing NVP Api object Destroy existing NVP Api object Returns `Mage_Paypal_Model_Pro`
`public Mage_Paypal_Model_Info`	# `getInfo( )` Instantiate and return info model Instantiate and return info model Returns `Mage_Paypal_Model_Info`
`public Mage_Paypal_Model_Pro`	# `importPaymentInfo( Varien_Object $from, Mage_Payment_Model_Info $to )` Transfer transaction/payment information from API instance to order payment Transfer transaction/payment information from API instance to order payment Parameters `$from` `Mage_Paypal_Model_Api_Abstract` $from `$to` `Mage_Payment_Model_Info` $to Returns `Mage_Paypal_Model_Pro`
`public`	# `void( Varien_Object $payment )` Void transaction Void transaction Parameters `$payment` `Varien_Object` $payment
`public false\|null`	# `capture( Varien_Object $payment, float $amount )` Attempt to capture payment Will return false if the payment is not supposed to be captured Attempt to capture payment Will return false if the payment is not supposed to be captured Parameters `$payment` `Varien_Object` $payment `$amount` `float` $amount Returns `false\|null`
`public`	# `refund( Varien_Object $payment, float $amount )` Refund a capture transaction Refund a capture transaction Parameters `$payment` `Varien_Object` $payment `$amount` `float` $amount
`public`	# `cancel( Varien_Object $payment )` Cancel payment Cancel payment Parameters `$payment` `Varien_Object` $payment
`public boolean`	# `canReviewPayment( Mage_Payment_Model_Info $payment )` Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `boolean`
`public boolean`	# `reviewPayment( Mage_Payment_Model_Info $payment, string $action )` Perform the payment review Perform the payment review Parameters `$payment` `Mage_Payment_Model_Info` $payment `$action` `string` $action Returns `boolean`
`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`
`public`	# `validateRecurringProfile( Mage_Payment_Model_Recurring_Profile $profile )` Validate RP data Validate RP data Parameters `$profile` `Mage_Payment_Model_Recurring_Profile` $profile Throws `Mage_Core_Exception`
`public`	# `submitRecurringProfile( Mage_Payment_Model_Recurring_Profile $profile, Mage_Payment_Model_Info $paymentInfo )` Submit RP to the gateway Submit RP to the gateway Parameters `$profile` `Mage_Payment_Model_Recurring_Profile` $profile `$paymentInfo` `Mage_Payment_Model_Info` $paymentInfo Throws `Mage_Core_Exception`
`public`	# `getRecurringProfileDetails( string $referenceId, Varien_Object $result )` Fetch RP details Fetch RP details Parameters `$referenceId` `string` $referenceId `$result` `Varien_Object` $result
`public`	# `updateRecurringProfile( Mage_Payment_Model_Recurring_Profile $profile )` Update RP data Update RP data Parameters `$profile` `Mage_Payment_Model_Recurring_Profile` $profile
`public`	# `updateRecurringProfileStatus( Mage_Payment_Model_Recurring_Profile $profile )` Manage status Manage status Parameters `$profile` `Mage_Payment_Model_Recurring_Profile` $profile
`protected`	# `_importCaptureResultToPayment( Mage_Paypal_Model_Api_Nvp $api, Mage_Sales_Model_Order_Payment $payment )` Import capture results to payment Import capture results to payment Parameters `$api` `Mage_Paypal_Model_Api_Nvp` `$payment` `Mage_Sales_Model_Order_Payment`
`protected`	# `_importRefundResultToPayment( Mage_Paypal_Model_Api_Nvp $api, Mage_Sales_Model_Order_Payment $payment, boolean $canRefundMore )` Import refund results to payment Import refund results to payment Parameters `$api` `Mage_Paypal_Model_Api_Nvp` `$payment` `Mage_Sales_Model_Order_Payment` `$canRefundMore` `boolean` $canRefundMore
`protected string`	# `_getParentTransactionId( Varien_Object $payment )` Parent transaction id getter Parent transaction id getter Parameters `$payment` `Varien_Object` $payment Returns `string`

Constants summary
`string`	`PAYMENT_REVIEW_ACCEPT`	`'accept'`	# Possible payment review actions (for FMF only) Possible payment review actions (for FMF only)
`string`	`PAYMENT_REVIEW_DENY`	`'deny'`	#

Properties summary
`protected Mage_Paypal_Model_Config`	`$_config`	`null`	# Config instance Config instance
`protected Mage_Paypal_Model_Api_Nvp`	`$_api`	`null`	# API instance API instance
`protected Mage_Paypal_Model_Info`	`$_infoInstance`	`null`	# PayPal info object PayPal info object
`protected string`	`$_apiType`	`'paypal/api_nvp'`	# API model type API model type
`protected string`	`$_configType`	`'paypal/config'`	# Config model type Config model type

Packages

Classes

Exceptions

Class Mage_Paypal_Model_Pro

Direct known subclasses

Parameters

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Throws

Parameters

Throws

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns