Class Mage_Paypal_Model_Api_Nvp

Description
Description | Descendents | Vars (details) | Methods (details) Constants (details)

NVP API wrappers model

Located in /Paypal/Model/Api/Nvp.php (line 31) 

Varien_Object
   |
   --Mage_Paypal_Model_Api_Abstract
      |
      --Mage_Paypal_Model_Api_Nvp
Direct descendents
Description | Descendents | Vars (details) | Methods (details) Constants (details)
Class Description
Mage_PaypalUk_Model_Api_Nvp NVP API wrappers model
Class Constant Summary
Description | Descendants | Constants (details) Vars (details) | | Methods (details)
CALLBACK_RESPONSE = 'CallbackResponse'
DO_CAPTURE = 'DoCapture'
DO_DIRECT_PAYMENT = 'DoDirectPayment'
DO_EXPRESS_CHECKOUT_PAYMENT = 'DoExpressCheckoutPayment'
DO_VOID = 'DoVoid'
GET_EXPRESS_CHECKOUT_DETAILS = 'GetExpressCheckoutDetails'
PENDING_TRANSACTION_ACCEPT = 'Accept'
PENDING_TRANSACTION_DENY = 'Deny'
REFUND_TRANSACTION = 'RefundTransaction'
SET_EXPRESS_CHECKOUT = 'SetExpressCheckout'
Variable Summary
Description | Descendents | Vars (details) | Methods (details) Constants (details)
array $_billingAddressMap
array $_billingAgreementCustomerDetailsRequest
mixed $_billingAgreementCustomerDetailsResponse
array $_callbackRequestMap
array $_callErrors
array $_callWarnings
string $_captureTypeComplete
mixed $_captureTypeNotcomplete
array $_createBillingAgreementRequest
mixed $_createBillingAgreementResponse
array $_createRecurringPaymentsProfileRequest
mixed $_createRecurringPaymentsProfileResponse
array $_customerBillingAgreementRequest
mixed $_customerBillingAgreementResponse
array $_debugReplacePrivateDataKeys
array $_doCaptureRequest
mixed $_doCaptureResponse
array $_doDirectPaymentRequest
mixed $_doDirectPaymentResponse
array $_doExpressCheckoutPaymentRequest
mixed $_doExpressCheckoutPaymentResponse
array $_doReauthorizationRequest
mixed $_doReauthorizationResponse
array $_doReferenceTransactionRequest
mixed $_doReferenceTransactionResponse
array $_doVoidRequest
array $_eachCallRequest
array $_exportToRequestFilters
array $_getExpressCheckoutDetailsRequest
array $_getPalDetailsResponse
array $_getRecurringPaymentsProfileDetailsRequest
mixed $_getRecurringPaymentsProfileDetailsResponse
array $_getTransactionDetailsRequest
mixed $_getTransactionDetailsResponse
array $_globalMap
mixed $_importFromRequestFilters
mixed $_lineItemExportItemsFormat
array $_lineItemTotalExportMap
mixed $_managePendingTransactionStatusRequest
mixed $_managePendingTransactionStatusResponse
array $_manageRecurringPaymentsProfileStatusRequest
array $_paymentInformationResponse
bool $_rawResponseNeeded
array $_refundTransactionRequest
mixed $_refundTransactionResponse
array $_requiredResponseParams
array $_setExpressCheckoutRequest
mixed $_setExpressCheckoutResponse
array $_shippingAddressMap
array $_shippingOptionsExportItemsFormat
array $_supportedCcTypes
array $_updateBillingAgreementRequest
mixed $_updateBillingAgreementResponse
Method Summary
Description | Descendents | Constants (details) Vars (details) | Methods (details)
array call (string $methodName,  $request)
void callCreateBillingAgreement ()
void callCreateRecurringPaymentsProfile ()
void callDoCapture ()
void callDoDirectPayment ()
void callDoExpressCheckoutPayment ()
void callDoReauthorization ()
void callDoReferenceTransaction ()
void callDoVoid ()
void callGetBillingAgreementCustomerDetails ()
void callGetExpressCheckoutDetails ()
void callGetPalDetails ()
void callGetRecurringPaymentsProfileDetails ( $result)
void callGetTransactionDetails ()
void callManagePendingTransactionStatus ()
void callManageRecurringPaymentsProfileStatus ()
void callRefundTransaction ()
void callSetCustomerBillingAgreement ()
void callSetExpressCheckout ()
void callUpdateBillingAgreement ()
string formatShippingOptionsCallback ()
string getApiEndpoint ()
string getBillingAgreementType ()
bool getIsFraudDetected ()
string getVersion ()
Varien_Object prepareShippingOptionsCallbackAddress ( $request)
Mage_Paypal_Model_Api_Nvp setRawResponseNeeded (bool $flag)
array _addMethodToRequest (string $methodName, array $request)
void _analyzeRecurringProfileStatus (string $value,  $result)
void _applyCountryWorkarounds ( &$request, array $request)
void _applyStreetAndRegionWorkarounds ( $address)
array _deformatNVP (string $nvpstr)
void _exportAddressses (array $data)
true|null _exportLineItems ( &$request, [int $i = 0], array $request)
string _filterBillFailedLater (string $value)
string _filterBillingAgreementStatus (string $value)
string _filterCcType (string $value)
string _filterInitialAmountMayFail (string $value)
string|null _filterPaymentReviewAction (string $value)
string|null _filterPaymentStatusFromNvpToInfo (string $value)
string _filterPeriodUnit (string $value)
string|null _filterRecurringProfileActionToNvp (string $value)
mixed _filterToBool (mixed $value)
string _getCaptureCompleteType (Varien_Object $payment)
void _handleCallErrors (array $response)
array _importAddress ( $address,  $to)
array _importAddresses ( $to)
bool| _isCallSuccessful (array $response)
array _prepareEachCallRequest (string $methodName)
void _prepareExpressCheckoutCallRequest ( &$requestFields, &array $requestFields)
bool _validateResponse (string $method, array $response)
Variables
Description | Descendents | Vars (details) Constants (details) | Methods (details)
array $_billingAddressMap = array (
'BUSINESS' => 'company',
'NOTETEXT' => 'customer_notes',
'EMAIL' => 'email',
'FIRSTNAME' => 'firstname',
'LASTNAME' => 'lastname',
'MIDDLENAME' => 'middlename',
'SALUTATION' => 'prefix',
'SUFFIX' => 'suffix',

'COUNTRYCODE' => 'country_id', // iso-3166 two-character code
'STATE' => 'region',
'CITY' => 'city',
'STREET' => 'street',
'STREET2' => 'street2',
'ZIP' => 'postcode',
'PHONENUM' => 'telephone',
) (line 346)

Map for billing address import/export

  • access: protected
Redefined in descendants as:
array $_billingAgreementCustomerDetailsRequest = array('TOKEN') (line 440)

Billing Agreement details request/response map

  • access: protected
mixed $_billingAgreementCustomerDetailsResponse = array('EMAIL', 'PAYERID', 'PAYERSTATUS', 'SHIPTOCOUNTRYCODE', 'PAYERBUSINESS') (line 441)
  • access: protected
array $_callbackRequestMap = array(
'SHIPTOCOUNTRY' => 'country_id',
'SHIPTOSTATE' => 'region',
'SHIPTOCITY' => 'city',
'SHIPTOSTREET' => 'street',
'SHIPTOSTREET2' => 'street2',
'SHIPTOZIP' => 'postcode'
) (line 384)

Map for callback request

  • access: protected
array $_callErrors = array() (line 506)

Error codes recollected after each API call

  • access: protected
array $_callWarnings = array() (line 499)

Warning codes recollected after each API call

  • access: protected
string $_captureTypeComplete = 'Complete' (line 55)

Capture types (make authorization close or remain open)

  • access: protected
Redefined in descendants as:
mixed $_captureTypeNotcomplete = 'NotComplete' (line 56)
  • access: protected
Redefined in descendants as:
array $_createBillingAgreementRequest = array('TOKEN') (line 447)

Create Billing Agreement request/response map

  • access: protected
mixed $_createBillingAgreementResponse = array('BILLINGAGREEMENTID') (line 448)
  • access: protected
array $_createRecurringPaymentsProfileRequest = array(
'TOKEN', 'SUBSCRIBERNAME', 'PROFILESTARTDATE', 'PROFILEREFERENCE', 'DESC', 'MAXFAILEDPAYMENTS', 'AUTOBILLAMT',
'BILLINGPERIOD', 'BILLINGFREQUENCY', 'TOTALBILLINGCYCLES', 'AMT', 'TRIALBILLINGPERIOD', 'TRIALBILLINGFREQUENCY',
'TRIALTOTALBILLINGCYCLES', 'TRIALAMT', 'CURRENCYCODE', 'SHIPPINGAMT', 'TAXAMT', 'INITAMT', 'FAILEDINITAMTACTION'
) (line 317)

CreateRecurringPaymentsProfile request/response map

  • access: protected
mixed $_createRecurringPaymentsProfileResponse = array(
'PROFILEID', 'PROFILESTATUS'
) (line 322)
  • access: protected
array $_customerBillingAgreementRequest = array('RETURNURL', 'CANCELURL', 'BILLINGTYPE') (line 433)

init Billing Agreement request/response map

  • access: protected
mixed $_customerBillingAgreementResponse = array('TOKEN') (line 434)
  • access: protected
array $_debugReplacePrivateDataKeys = array(
'ACCT', 'EXPDATE', 'CVV2', 'CARDISSUE', 'CARDSTART', 'CREDITCARDTYPE', 'USER', 'PWD', 'SIGNATURE'
) (line 474)

Fields that should be replaced in debug with '***'

  • access: protected
Redefinition of:
Mage_Paypal_Model_Api_Abstract::$_debugReplacePrivateDataKeys
Fields that should be replaced in debug with '***'
Redefined in descendants as:
array $_doCaptureRequest = array('AUTHORIZATIONID', 'COMPLETETYPE', 'AMT', 'CURRENCYCODE', 'NOTE', 'INVNUM',) (line 274)

DoCapture request/response map

  • access: protected
Redefined in descendants as:
mixed $_doCaptureResponse = array('TRANSACTIONID', 'CURRENCYCODE', 'AMT', 'PAYMENTSTATUS', 'PENDINGREASON',) (line 275)
  • access: protected
Redefined in descendants as:
array $_doDirectPaymentRequest = array(
'PAYMENTACTION', 'IPADDRESS', 'RETURNFMFDETAILS',
'AMT', 'CURRENCYCODE', 'INVNUM', 'NOTIFYURL', 'EMAIL', 'ITEMAMT', 'SHIPPINGAMT', 'TAXAMT',
'CREDITCARDTYPE', 'ACCT', 'EXPDATE', 'CVV2', 'STARTDATE', 'ISSUENUMBER',
'AUTHSTATUS3DS', 'MPIVENDOR3DS', 'CAVV', 'ECI3DS', 'XID',
) (line 251)

DoDirectPayment request/response map

  • access: protected
Redefined in descendants as:
mixed $_doDirectPaymentResponse = array(
'TRANSACTIONID', 'AMT', 'AVSCODE', 'CVV2MATCH', 'VPAS', 'ECISUBMITTED3DS'
) (line 257)
  • access: protected
Redefined in descendants as:
array $_doExpressCheckoutPaymentRequest = array(
'TOKEN', 'PAYERID', 'PAYMENTACTION', 'AMT', 'CURRENCYCODE', 'IPADDRESS', 'BUTTONSOURCE', 'NOTIFYURL',
'RETURNFMFDETAILS', 'SUBJECT', 'ITEMAMT', 'SHIPPINGAMT', 'TAXAMT',
) (line 239)

DoExpressCheckoutPayment request/response map

  • access: protected
Redefined in descendants as:
mixed $_doExpressCheckoutPaymentResponse = array(
'TRANSACTIONID', 'AMT', 'PAYMENTSTATUS', 'PENDINGREASON', 'REDIRECTREQUIRED', 'SUCCESSPAGEREDIRECTREQUESTED',
) (line 243)
  • access: protected
Redefined in descendants as:
array $_doReauthorizationRequest = array('AUTHORIZATIONID', 'AMT', 'CURRENCYCODE') (line 265)

DoReauthorization request/response map

  • access: protected
mixed $_doReauthorizationResponse = array(
'AUTHORIZATIONID', 'PAYMENTSTATUS', 'PENDINGREASON', 'PROTECTIONELIGIBILITY'
) (line 266)
  • access: protected
array $_doReferenceTransactionRequest = array('REFERENCEID', 'PAYMENTACTION', 'AMT', 'ITEMAMT', 'SHIPPINGAMT', 'TAXAMT',) (line 466)

Do Reference Transaction request/response map

  • access: protected
mixed $_doReferenceTransactionResponse = array('BILLINGAGREEMENTID', 'TRANSACTIONID') (line 467)
  • access: protected
array $_doVoidRequest = array('AUTHORIZATIONID', 'NOTE',) (line 281)

DoVoid request map

  • access: protected
Redefined in descendants as:
array $_eachCallRequest = array('VERSION', 'USER', 'PWD', 'SIGNATURE', 'BUTTONSOURCE',) (line 215)

Request map for each API call

  • access: protected
Redefined in descendants as:
array $_exportToRequestFilters = array(
'AMT' => '_filterAmount',
'ITEMAMT' => '_filterAmount',
'TRIALAMT' => '_filterAmount',
'SHIPPINGAMT' => '_filterAmount',
'TAXAMT' => '_filterAmount',
'INITAMT' => '_filterAmount',
'CREDITCARDTYPE' => '_filterCcType',
// 'PROFILESTARTDATE' => '_filterToPaypalDate',
'AUTOBILLAMT' => '_filterBillFailedLater',
'BILLINGPERIOD' => '_filterPeriodUnit',
'TRIALBILLINGPERIOD' => '_filterPeriodUnit',
'FAILEDINITAMTACTION' => '_filterInitialAmountMayFail',
'BILLINGAGREEMENTSTATUS' => '_filterBillingAgreementStatus',
'NOSHIPPING' => '_filterInt',
) (line 188)

Filter callbacks for preparing internal amounts to NVP request

  • access: protected
Redefinition of:
Mage_Paypal_Model_Api_Abstract::$_exportToRequestFilters
Filter callbacks for exporting $this data to API call
array $_getExpressCheckoutDetailsRequest = array('TOKEN', 'SUBJECT',) (line 233)

GetExpressCheckoutDetails request/response map

  • access: protected
Redefined in descendants as:
array $_getPalDetailsResponse = array('PAL') (line 310)

GetPalDetails response map

  • access: protected
array $_getRecurringPaymentsProfileDetailsRequest = array('PROFILEID') (line 339)

Request/response for GetRecurringPaymentsProfileDetails

  • access: protected
mixed $_getRecurringPaymentsProfileDetailsResponse = array('STATUS', /* TODO: lot of other stuff */) (line 340)
  • access: protected
array $_getTransactionDetailsRequest = array('TRANSACTIONID') (line 287)

GetTransactionDetailsRequest

  • access: protected
Redefined in descendants as:
mixed $_getTransactionDetailsResponse = array(
'PAYERID', 'FIRSTNAME', 'LASTNAME', 'TRANSACTIONID', 'PARENTTRANSACTIONID', 'CURRENCYCODE', 'AMT',
'PAYMENTSTATUS', 'PENDINGREASON',
) (line 288)
  • access: protected
Redefined in descendants as:
array $_globalMap = array(
// each call
'VERSION' => 'version',
'USER' => 'api_username',
'PWD' => 'api_password',
'SIGNATURE' => 'api_signature',
'BUTTONSOURCE' => 'build_notation_code',

// for Unilateral payments
'SUBJECT' => 'business_account',

// commands
'PAYMENTACTION' => 'payment_action',
'RETURNURL' => 'return_url',
'CANCELURL' => 'cancel_url',
'INVNUM' => 'inv_num',
'TOKEN' => 'token',
'CORRELATIONID' => 'correlation_id',
'SOLUTIONTYPE' => 'solution_type',
'GIROPAYCANCELURL' => 'giropay_cancel_url',
'GIROPAYSUCCESSURL' => 'giropay_success_url',
'BANKTXNPENDINGURL' => 'giropay_bank_txn_pending_url',
'IPADDRESS' => 'ip_address',
'NOTIFYURL' => 'notify_url',
'RETURNFMFDETAILS' => 'fraud_management_filters_enabled',
'NOTE' => 'note',
'REFUNDTYPE' => 'refund_type',
'ACTION' => 'action',
'REDIRECTREQUIRED' => 'redirect_required',
'SUCCESSPAGEREDIRECTREQUESTED' => 'redirect_requested',
// style settings
'PAGESTYLE' => 'page_style',
'HDRIMG' => 'hdrimg',
'HDRBORDERCOLOR' => 'hdrbordercolor',
'HDRBACKCOLOR' => 'hdrbackcolor',
'PAYFLOWCOLOR' => 'payflowcolor',
'LOCALECODE' => 'locale_code',
'PAL' => 'pal',

// transaction info
'TRANSACTIONID' => 'transaction_id',
'AUTHORIZATIONID' => 'authorization_id',
'REFUNDTRANSACTIONID' => 'refund_transaction_id',
'COMPLETETYPE' => 'complete_type',
'AMT' => 'amount',
'ITEMAMT' => 'subtotal_amount',
'GROSSREFUNDAMT' => 'refunded_amount', // possible mistake, check with API reference

// payment/billing info
'CURRENCYCODE' => 'currency_code',
'PAYMENTSTATUS' => 'payment_status',
'PENDINGREASON' => 'pending_reason',
'PROTECTIONELIGIBILITY' => 'protection_eligibility',
'PAYERID' => 'payer_id',
'PAYERSTATUS' => 'payer_status',
'ADDRESSID' => 'address_id',
'ADDRESSSTATUS' => 'address_status',
'EMAIL' => 'email',
// backwards compatibility
'FIRSTNAME' => 'firstname',
'LASTNAME' => 'lastname',

// shipping rate
'SHIPPINGOPTIONNAME' => 'shipping_rate_code',
'NOSHIPPING' => 'suppress_shipping',

// paypal direct credit card information
'CREDITCARDTYPE' => 'credit_card_type',
'ACCT' => 'credit_card_number',
'EXPDATE' => 'credit_card_expiration_date',
'CVV2' => 'credit_card_cvv2',
'STARTDATE' => 'maestro_solo_issue_date', // MMYYYY, always six chars, including leading zero
'ISSUENUMBER' => 'maestro_solo_issue_number',
'CVV2MATCH' => 'cvv2_check_result',
'AVSCODE' => 'avs_result',
// cardinal centinel
'AUTHSTATUS3DS' => 'centinel_authstatus',
'MPIVENDOR3DS' => 'centinel_mpivendor',
'CAVV' => 'centinel_cavv',
'ECI3DS' => 'centinel_eci',
'XID' => 'centinel_xid',
'VPAS' => 'centinel_vpas_result',
'ECISUBMITTED3DS' => 'centinel_eci_result',

// recurring payment profiles
//'TOKEN' => 'token',
'SUBSCRIBERNAME' =>'subscriber_name',
'PROFILESTARTDATE' => 'start_datetime',
'PROFILEREFERENCE' => 'internal_reference_id',
'DESC' => 'schedule_description',
'MAXFAILEDPAYMENTS' => 'suspension_threshold',
'AUTOBILLAMT' => 'bill_failed_later',
'BILLINGPERIOD' => 'period_unit',
'BILLINGFREQUENCY' => 'period_frequency',
'TOTALBILLINGCYCLES' => 'period_max_cycles',
//'AMT' => 'billing_amount', // have to use 'amount', see above
'TRIALBILLINGPERIOD' => 'trial_period_unit',
'TRIALBILLINGFREQUENCY' => 'trial_period_frequency',
'TRIALTOTALBILLINGCYCLES' => 'trial_period_max_cycles',
'TRIALAMT' => 'trial_billing_amount',
// 'CURRENCYCODE' => 'currency_code',
'SHIPPINGAMT' => 'shipping_amount',
'TAXAMT' => 'tax_amount',
'INITAMT' => 'init_amount',
'FAILEDINITAMTACTION' => 'init_may_fail',
'PROFILEID' => 'recurring_profile_id',
'PROFILESTATUS' => 'recurring_profile_status',
'STATUS' => 'status',

'BILLINGAGREEMENTID' => 'billing_agreement_id',
'REFERENCEID' => 'reference_id',
'BILLINGAGREEMENTSTATUS' => 'billing_agreement_status',
'BILLINGTYPE' => 'billing_type',
'SREET' => 'street',
'CITY' => 'city',
'STATE' => 'state',
'COUNTRYCODE' => 'countrycode',
'ZIP' => 'zip',
'PAYERBUSINESS' => 'payer_business',
) (line 62)

Global public interface map

  • access: protected
Redefinition of:
Mage_Paypal_Model_Api_Abstract::$_globalMap
Global private to public interface map
Redefined in descendants as:
mixed $_importFromRequestFilters = array(
'REDIRECTREQUIRED' => '_filterToBool',
'SUCCESSPAGEREDIRECTREQUESTED' => '_filterToBool',
'PAYMENTSTATUS' => '_filterPaymentStatusFromNvpToInfo',
) (line 205)
  • access: protected
Redefinition of:
Mage_Paypal_Model_Api_Abstract::$_importFromRequestFilters
Filter callbacks for importing API result to $this data
mixed $_lineItemExportItemsFormat = array(
'id' => 'L_NUMBER%d',
'name' => 'L_NAME%d',
'qty' => 'L_QTY%d',
'amount' => 'L_AMT%d',
) (line 411)
  • access: protected
Redefinition of:
Mage_Paypal_Model_Api_Abstract::$_lineItemExportItemsFormat
Line items export to request mapping settings
Redefined in descendants as:
array $_lineItemTotalExportMap = array(
Mage_Paypal_Model_Cart::TOTAL_SUBTOTAL => 'ITEMAMT',
Mage_Paypal_Model_Cart::TOTAL_TAX => 'TAXAMT',
Mage_Paypal_Model_Cart::TOTAL_SHIPPING => 'SHIPPINGAMT',
) (line 406)

Line items export mapping settings

  • access: protected
Redefinition of:
Mage_Paypal_Model_Api_Abstract::$_lineItemTotalExportMap
Redefined in descendants as:
mixed $_managePendingTransactionStatusRequest = array('TRANSACTIONID', 'ACTION') (line 303)

ManagePendingTransactionStatus request/response map

  • access: protected
mixed $_managePendingTransactionStatusResponse = array('TRANSACTIONID', 'STATUS') (line 304)
  • access: protected
array $_manageRecurringPaymentsProfileStatusRequest = array('PROFILEID', 'ACTION') (line 331)

Request/response for ManageRecurringPaymentsProfileStatus map

  • access: protected
array $_paymentInformationResponse = array(
'PAYERID', 'PAYERSTATUS', 'CORRELATIONID', 'ADDRESSID', 'ADDRESSSTATUS',
'PAYMENTSTATUS', 'PENDINGREASON', 'PROTECTIONELIGIBILITY', 'EMAIL', 'SHIPPINGOPTIONNAME'
) (line 397)

Payment information response specifically to be collected after some requests

  • access: protected
Redefined in descendants as:
bool $_rawResponseNeeded = false (line 513)

Whether to return raw response information after each call

  • access: protected
array $_refundTransactionRequest = array('TRANSACTIONID', 'REFUNDTYPE', 'CURRENCYCODE', 'NOTE',) (line 297)

RefundTransaction request/response map

  • access: protected
Redefined in descendants as:
mixed $_refundTransactionResponse = array('REFUNDTRANSACTIONID', 'GROSSREFUNDAMT',) (line 298)
  • access: protected
Redefined in descendants as:
array $_requiredResponseParams = array(
self::DO_DIRECT_PAYMENT => array('ACK', 'CORRELATIONID', 'AMT')) (line 490)

Required fields in the response

  • access: protected
Redefined in descendants as:
array $_setExpressCheckoutRequest = array(
'PAYMENTACTION', 'AMT', 'CURRENCYCODE', 'RETURNURL', 'CANCELURL', 'INVNUM', 'SOLUTIONTYPE', 'NOSHIPPING',
'GIROPAYCANCELURL', 'GIROPAYSUCCESSURL', 'BANKTXNPENDINGURL',
'PAGESTYLE', 'HDRIMG', 'HDRBORDERCOLOR', 'HDRBACKCOLOR', 'PAYFLOWCOLOR', 'LOCALECODE',
'BILLINGTYPE', 'SUBJECT', 'ITEMAMT', 'SHIPPINGAMT', 'TAXAMT',
) (line 221)

SetExpressCheckout request/response map

  • access: protected
Redefined in descendants as:
mixed $_setExpressCheckoutResponse = array('TOKEN') (line 227)
  • access: protected
Redefined in descendants as:
array $_shippingAddressMap = array(
'SHIPTOCOUNTRYCODE' => 'country_id',
'SHIPTOSTATE' => 'region',
'SHIPTOCITY' => 'city',
'SHIPTOSTREET' => 'street',
'SHIPTOSTREET2' => 'street2',
'SHIPTOZIP' => 'postcode',
'SHIPTOPHONENUM' => 'telephone',
// 'SHIPTONAME' will be treated manually in address import/export methods
) (line 369)

Map for shipping address import/export (extends billing address mapper)

  • access: protected
Redefined in descendants as:
array $_shippingOptionsExportItemsFormat = array(
'is_default' => 'L_SHIPPINGOPTIONISDEFAULT%d',
'amount' => 'L_SHIPPINGOPTIONAMOUNT%d',
'code' => 'L_SHIPPINGOPTIONNAME%d',
'name' => 'L_SHIPPINGOPTIONLABEL%d',
) (line 422)

Shipping options export to request mapping settings

  • access: protected
Redefinition of:
Mage_Paypal_Model_Api_Abstract::$_shippingOptionsExportItemsFormat
Shipping options export to request mapping settings
array $_supportedCcTypes = array(
'VI' => 'Visa', 'MC' => 'MasterCard', 'DI' => 'Discover', 'AE' => 'Amex', 'SM' => 'Maestro', 'SO' => 'Solo') (line 482)

Map of credit card types supported by this API

  • access: protected
array $_updateBillingAgreementRequest = array(
'REFERENCEID', 'BILLINGAGREEMENTDESCRIPTION', 'BILLINGAGREEMENTSTATUS', 'BILLINGAGREEMENTCUSTOM'
) (line 454)

Update Billing Agreement request/response map

  • access: protected
mixed $_updateBillingAgreementResponse = array(
'REFERENCEID', 'BILLINGAGREEMENTDESCRIPTION', 'BILLINGAGREEMENTSTATUS', 'BILLINGAGREEMENTCUSTOM'
) (line 457)
  • access: protected

Inherited Variables

Inherited from Mage_Paypal_Model_Api_Abstract

Mage_Paypal_Model_Api_Abstract::$_cart
 Mage_Paypal_Model_Api_Abstract::$_config
 Mage_Paypal_Model_Api_Abstract::$_lineItemExportItemsFilters
 Mage_Paypal_Model_Api_Abstract::$_recurringPaymentProfiles
Methods
Description | Descendents | Vars (details) Constants (details) Methods (details)
call (line 877)

Do the API call

  • throws: Mage_Core_Exception
  • access: public
array call (string $methodName,  $request)
  • string $methodName
  • array $request
callCreateBillingAgreement (line 757)

Create Billing Agreement call

  • access: public
void callCreateBillingAgreement ()
callCreateRecurringPaymentsProfile (line 785)

CreateRecurringPaymentsProfile call

  • access: public
void callCreateRecurringPaymentsProfile ()
callDoCapture (line 660)

DoCapture call

void callDoCapture ()
callDoDirectPayment (line 613)

Process a credit card payment

  • access: public
void callDoDirectPayment ()
callDoExpressCheckoutPayment (line 598)

DoExpressCheckout call

void callDoExpressCheckoutPayment ()
callDoReauthorization (line 649)

Made additional request to paypal to get autharization id

  • access: public
void callDoReauthorization ()
callDoReferenceTransaction (line 628)

Do Reference Transaction call

void callDoReferenceTransaction ()
callDoVoid (line 673)

DoVoid call

void callDoVoid ()
callGetBillingAgreementCustomerDetails (line 746)

Get Billing Agreement Customer Details call

void callGetBillingAgreementCustomerDetails ()
callGetExpressCheckoutDetails (line 585)

GetExpressCheckoutDetails call

void callGetExpressCheckoutDetails ()
callGetPalDetails (line 723)

getPalDetails call

void callGetPalDetails ()
callGetRecurringPaymentsProfileDetails (line 818)

GetRecurringPaymentsProfileDetails call

  • access: public
void callGetRecurringPaymentsProfileDetails ( $result)
  • Varien_Object $result
callGetTransactionDetails (line 683)

GetTransactionDetails

void callGetTransactionDetails ()
Redefined in descendants as:
callManagePendingTransactionStatus (line 708)

ManagePendingTransactionStatus

void callManagePendingTransactionStatus ()
callManageRecurringPaymentsProfileStatus (line 796)

ManageRecurringPaymentsProfileStatus call

  • access: public
void callManageRecurringPaymentsProfileStatus ()
callRefundTransaction (line 694)

RefundTransaction call

void callRefundTransaction ()
callSetCustomerBillingAgreement (line 734)

Set Customer BillingA greement call

void callSetCustomerBillingAgreement ()
callSetExpressCheckout (line 551)

SetExpressCheckout call

void callSetExpressCheckout ()
callUpdateBillingAgreement (line 768)

Billing Agreement Update call

  • access: public
void callUpdateBillingAgreement ()
formatShippingOptionsCallback (line 846)

Prepare response for shipping options callback

  • access: public
string formatShippingOptionsCallback ()
getApiEndpoint (line 520)

API endpoint getter

  • access: public
string getApiEndpoint ()
Redefined in descendants as:
getBillingAgreementType (line 541)

Retrieve billing agreement type

  • access: public
string getBillingAgreementType ()
getIsFraudDetected (line 641)

Check whether the last call was returned with fraud warning

  • access: public
bool getIsFraudDetected ()
getVersion (line 531)

Return Paypal Api version

  • access: public
string getVersion ()
prepareShippingOptionsCallbackAddress (line 832)

Import callback request array into $this public data

  • access: public
Varien_Object prepareShippingOptionsCallbackAddress ( $request)
  • array $request
setRawResponseNeeded (line 949)

Setter for 'raw response needed' flag

  • access: public
Mage_Paypal_Model_Api_Nvp setRawResponseNeeded (bool $flag)
  • bool $flag
_addMethodToRequest (line 863)

Add method to request array

  • access: protected
array _addMethodToRequest (string $methodName, array $request)
  • string $methodName
  • array $request
Redefined in descendants as:
_analyzeRecurringProfileStatus (line 1325)

Check the obtained RP status in NVP format and specify the profile state

  • access: protected
void _analyzeRecurringProfileStatus (string $value,  $result)
  • string $value
  • Varien_Object $result
_applyCountryWorkarounds (line 1129)

Adopt specified request array to be compatible with Paypal Puerto Rico should be as state of USA and not as a country

  • access: protected
void _applyCountryWorkarounds ( &$request, array $request)
  • array $request
  • &$request
Redefined in descendants as:
_applyStreetAndRegionWorkarounds (line 1102)

Adopt specified address object to be compatible with Magento

  • access: protected
void _applyStreetAndRegionWorkarounds ( $address)
  • Varien_Object $address
_deformatNVP (line 1030)

Parse an NVP response string into an associative array

  • access: protected
array _deformatNVP (string $nvpstr)
  • string $nvpstr
_exportAddressses (line 1073)

Create billing and shipping addresses basing on response data

  • access: protected
void _exportAddressses (array $data)
  • array $data
_exportLineItems (line 1060)

NVP doesn't support passing discount total as a separate amount - add it as a line item

  • access: protected
true|null _exportLineItems ( &$request, [int $i = 0], array $request)
  • array $request
  • int $i
  • array &$request
Redefinition of:
Mage_Paypal_Model_Api_Abstract::_exportLineItems()
Prepare line items request
_filterBillFailedLater (line 1216)

Filter for 'AUTOBILLAMT'

  • access: protected
string _filterBillFailedLater (string $value)
  • string $value
_filterBillingAgreementStatus (line 1255)

Filter for billing agreement status

  • access: protected
string _filterBillingAgreementStatus (string $value)
  • string $value
_filterCcType (line 1186)

Filter for credit card type

  • access: protected
string _filterCcType (string $value)
  • string $value
_filterInitialAmountMayFail (line 1244)

Filter for 'FAILEDINITAMTACTION'

  • access: protected
string _filterInitialAmountMayFail (string $value)
  • string $value
_filterPaymentReviewAction (line 1294)

Convert payment review action to NVP-compatible value

  • access: protected
string|null _filterPaymentReviewAction (string $value)
  • string $value
_filterPaymentStatusFromNvpToInfo (line 1269)

Convert payment status from NVP format to paypal/info model format

  • access: protected
string|null _filterPaymentStatusFromNvpToInfo (string $value)
  • string $value
_filterPeriodUnit (line 1227)

Filter for 'BILLINGPERIOD' and 'TRIALBILLINGPERIOD'

  • access: protected
string _filterPeriodUnit (string $value)
  • string $value
_filterRecurringProfileActionToNvp (line 1310)

Convert RP management action to NVP format

  • access: protected
string|null _filterRecurringProfileActionToNvp (string $value)
  • string $value
_filterToBool (line 1200)

Filter for true/false values (converts to boolean)

  • access: protected
mixed _filterToBool (mixed $value)
  • mixed $value
_getCaptureCompleteType (line 1356)

Return capture type

  • access: protected
string _getCaptureCompleteType (Varien_Object $payment)
  • Varien_Object $payment
_handleCallErrors (line 960)

Handle logical errors

  • access: protected
void _handleCallErrors (array $response)
  • array $response
Redefined in descendants as:
_importAddress (line 1146)

Prepare request data basing on provided address

  • deprecated: after 1.4.2.0-beta1, use _importAddresses() instead
  • access: protected
array _importAddress ( $address,  $to)
  • Varien_Object $address
  • array $to
_importAddresses (line 1158)

Prepare request data basing on provided addresses

  • access: protected
array _importAddresses ( $to)
  • array $to
_isCallSuccessful (line 990)

Catch success calls and collect warnings

  • return: success flag
  • access: protected
bool| _isCallSuccessful (array $response)
  • array $response
Redefined in descendants as:
_prepareEachCallRequest (line 1369)

Return each call request without unused fields in case of Express Checkout Unilateral payments

  • access: protected
array _prepareEachCallRequest (string $methodName)
  • string $methodName: Current method name
Redefined in descendants as:
_prepareExpressCheckoutCallRequest (line 1385)

Check the EC request against unilateral payments mode and remove the SUBJECT if needed

  • access: protected
void _prepareExpressCheckoutCallRequest ( &$requestFields, &array $requestFields)
  • &array $requestFields
  • &$requestFields
Redefined in descendants as:
_validateResponse (line 1013)

Validate response array.

  • access: protected
bool _validateResponse (string $method, array $response)
  • string $method
  • array $response

Inherited Methods

Inherited From Mage_Paypal_Model_Api_Abstract

Mage_Paypal_Model_Api_Abstract::addRecurringPaymentProfiles()
Mage_Paypal_Model_Api_Abstract::export()
Mage_Paypal_Model_Api_Abstract::getApiCertificate()
Mage_Paypal_Model_Api_Abstract::getApiPassword()
Mage_Paypal_Model_Api_Abstract::getApiSignature()
Mage_Paypal_Model_Api_Abstract::getApiUsername()
Mage_Paypal_Model_Api_Abstract::getBuildNotationCode()
Mage_Paypal_Model_Api_Abstract::getBusinessAccount()
Mage_Paypal_Model_Api_Abstract::getDebug()
Mage_Paypal_Model_Api_Abstract::getDebugFlag()
Mage_Paypal_Model_Api_Abstract::getFraudManagementFiltersEnabled()
Mage_Paypal_Model_Api_Abstract::getHdrbackcolor()
Mage_Paypal_Model_Api_Abstract::getHdrbordercolor()
Mage_Paypal_Model_Api_Abstract::getHdrimg()
Mage_Paypal_Model_Api_Abstract::getLocaleCode()
Mage_Paypal_Model_Api_Abstract::getPageStyle()
Mage_Paypal_Model_Api_Abstract::getPayflowcolor()
Mage_Paypal_Model_Api_Abstract::getPaymentAction()
Mage_Paypal_Model_Api_Abstract::getProxyHost()
Mage_Paypal_Model_Api_Abstract::getProxyPort()
Mage_Paypal_Model_Api_Abstract::getUseCertAuthentication()
Mage_Paypal_Model_Api_Abstract::getUseProxy()
Mage_Paypal_Model_Api_Abstract::import()
Mage_Paypal_Model_Api_Abstract::setConfigObject()
Mage_Paypal_Model_Api_Abstract::setPaypalCart()
Mage_Paypal_Model_Api_Abstract::_buildQuery()
Mage_Paypal_Model_Api_Abstract::_debug()
Mage_Paypal_Model_Api_Abstract::_exportLineItems()
Mage_Paypal_Model_Api_Abstract::_exportShippingOptions()
Mage_Paypal_Model_Api_Abstract::_exportToRequest()
Mage_Paypal_Model_Api_Abstract::_filterAmount()
Mage_Paypal_Model_Api_Abstract::_filterBool()
Mage_Paypal_Model_Api_Abstract::_filterInt()
Mage_Paypal_Model_Api_Abstract::_filterQty()
Mage_Paypal_Model_Api_Abstract::_getDataOrConfig()
Mage_Paypal_Model_Api_Abstract::_importFromResponse()
Mage_Paypal_Model_Api_Abstract::_importStreetFromAddress()
Mage_Paypal_Model_Api_Abstract::_lookupRegionCodeFromAddress()
Class Constants
Description | Descendants | Constants (details) Vars (details) | Methods (details)
CALLBACK_RESPONSE = 'CallbackResponse' (line 43)
DO_CAPTURE = 'DoCapture' (line 37)
DO_DIRECT_PAYMENT = 'DoDirectPayment' (line 36)

Paypal methods definition

DO_EXPRESS_CHECKOUT_PAYMENT = 'DoExpressCheckoutPayment' (line 42)
DO_VOID = 'DoVoid' (line 38)
GET_EXPRESS_CHECKOUT_DETAILS = 'GetExpressCheckoutDetails' (line 41)
PENDING_TRANSACTION_ACCEPT = 'Accept' (line 48)

Paypal ManagePendingTransactionStatus actions

PENDING_TRANSACTION_DENY = 'Deny' (line 49)
REFUND_TRANSACTION = 'RefundTransaction' (line 39)
SET_EXPRESS_CHECKOUT = 'SetExpressCheckout' (line 40)

Documentation generated on Fri, 11 Feb 2011 17:09:01 +0200 by phpDocumentor 1.4.3