Class Mage_PaypalUk_Model_Api_Nvp

NVP API wrappers model

Varien_Object

Mage_PaypalUk_Model_Api_Nvp

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

Methods summary
`public string`	# `getApiEndpoint( )` API endpoint getter API endpoint getter Returns `string` Overrides `Mage_Paypal_Model_Api_Nvp::getApiEndpoint()`
`public string`	# `getPartner( )` Return PaypalUk partner based on config data Return PaypalUk partner based on config data Returns `string`
`public string`	# `getUser( )` Return PaypalUk user based on config data Return PaypalUk user based on config data Returns `string`
`public string`	# `getPassword( )` Return PaypalUk password based on config data Return PaypalUk password based on config data Returns `string`
`public string`	# `getVendor( )` Return PaypalUk vendor based on config data Return PaypalUk vendor based on config data Returns `string`
`public string`	# `getTender( )` Return PaypalUk tender based on config data Return PaypalUk tender based on config data Returns `string`
`public string`	# `getPaypalTransactionId( )` Override transaction id getting to process payflow accounts not assigned to paypal side Override transaction id getting to process payflow accounts not assigned to paypal side Returns `string`
`protected array`	# `_addMethodToRequest( string $methodName, array $request )` Add method to request array Add method to request array Parameters `$methodName` `string` $methodName `$request` `array` $request Returns `array` Overrides `Mage_Paypal_Model_Api_Nvp::_addMethodToRequest()`
`protected string`	# `_getPaypalUkActionName( string $methodName )` Return Payflow Edition Return Payflow Edition Parameters `$methodName` `string` Returns `string` \| null
`protected string`	# `_mapPaypalMethodName( string\| $methodName )` Map paypal method names Map paypal method names Parameters `$methodName` `string\|` $methodName Returns `string`
`protected boolean\|`	# `_isCallSuccessful( array $response )` Catch success calls and collect warnings Catch success calls and collect warnings Parameters `$response` `array` Returns `boolean\|` success flag Overrides `Mage_Paypal_Model_Api_Nvp::_isCallSuccessful()`
`protected`	# `_handleCallErrors( array $response )` Handle logical errors Handle logical errors Parameters `$response` `array` Overrides `Mage_Paypal_Model_Api_Nvp::_handleCallErrors()`
`protected string`	# `_buildQuery( array $request )` Build query string without urlencoding from request Build query string without urlencoding from request Parameters `$request` `array` $request Returns `string` Overrides `Mage_Paypal_Model_Api_Abstract::_buildQuery()`
`protected mixed`	# `getRequestId( )` Generate Request ID Generate Request ID Returns `mixed`
`public`	# `callGetTransactionDetails( )` "GetTransactionDetails" method does not exists in PaypalUK "GetTransactionDetails" method does not exists in PaypalUK Overrides `Mage_Paypal_Model_Api_Nvp::callGetTransactionDetails()`
`protected`	# `_importFraudFiltersResult( array $from, array $collectedWarnings )` Get FMF results from response, if any Get FMF results from response, if any Parameters `$from` `array` $from `$collectedWarnings` `array` $collectedWarnings
`protected array`	# `_prepareEachCallRequest( string $methodName )` Return each call request fields (PayFlow edition doesn't support Unilateral payments) Return each call request fields (PayFlow edition doesn't support Unilateral payments) Parameters `$methodName` `string` $methodName Current method name Returns `array` Overrides `Mage_Paypal_Model_Api_Nvp::_prepareEachCallRequest()`
`protected array`	# `_prepareExpressCheckoutCallRequest( array & $requestFields )` Overwrite parent logic, simply return input data (PayFlow edition doesn't support Unilateral payments) Overwrite parent logic, simply return input data (PayFlow edition doesn't support Unilateral payments) Parameters `$requestFields` `array` $requestFields Standard set of values Returns `array` Overrides `Mage_Paypal_Model_Api_Nvp::_prepareExpressCheckoutCallRequest()`
`protected`	# `_applyCountryWorkarounds( array & $request )` Adopt specified request array to be compatible with Paypal Puerto Rico should be as state of USA and not as a country Adopt specified request array to be compatible with Paypal Puerto Rico should be as state of USA and not as a country Parameters `$request` `array` $request Overrides `Mage_Paypal_Model_Api_Nvp::_applyCountryWorkarounds()`

Methods inherited from Mage_Paypal_Model_Api_Nvp
_analyzeRecurringProfileStatus(), _applyStreetAndRegionWorkarounds(), _deformatNVP(), _exportAddressses(), _exportLineItems(), _filterBillFailedLater(), _filterBillingAgreementStatus(), _filterCcType(), _filterInitialAmountMayFail(), _filterPaymentReviewAction(), _filterPaymentStatusFromNvpToInfo(), _filterPeriodUnit(), _filterRecurringProfileActionToNvp(), _filterToBool(), _getCaptureCompleteType(), _importAddresses(), _validateResponse(), call(), callCreateBillingAgreement(), callCreateRecurringPaymentsProfile(), callDoAuthorization(), callDoCapture(), callDoDirectPayment(), callDoExpressCheckoutPayment(), callDoReauthorization(), callDoReferenceTransaction(), callDoVoid(), callGetBillingAgreementCustomerDetails(), callGetExpressCheckoutDetails(), callGetPalDetails(), callGetRecurringPaymentsProfileDetails(), callManagePendingTransactionStatus(), callManageRecurringPaymentsProfileStatus(), callRefundTransaction(), callSetCustomerBillingAgreement(), callSetExpressCheckout(), callUpdateBillingAgreement(), formatShippingOptionsCallback(), getBillingAgreementType(), getIsFraudDetected(), getVersion(), prepareShippingOptionsCallbackAddress(), setRawResponseNeeded()

Methods inherited from Mage_Paypal_Model_Api_Abstract
_debug(), _exportShippingOptions(), _exportToRequest(), _filterAmount(), _filterBool(), _filterInt(), _filterQty(), _getDataOrConfig(), _importFromResponse(), _importStreetFromAddress(), _lookupRegionCodeFromAddress(), addRecurringPaymentProfiles(), export(), getApiCertificate(), getApiPassword(), getApiSignature(), getApiUsername(), getBuildNotationCode(), getBusinessAccount(), getDebugFlag(), getFraudManagementFiltersEnabled(), getHdrbackcolor(), getHdrbordercolor(), getHdrimg(), getLocaleCode(), getPageStyle(), getPayflowcolor(), getPaymentAction(), getProxyHost(), getProxyPort(), getUseCertAuthentication(), getUseProxy(), import(), setConfigObject(), setPaypalCart()

Constants summary
`mixed`	`TRXTYPE_AUTH_ONLY`	`'A'`	# Transaction types declaration Transaction types declaration
`mixed`	`TRXTYPE_SALE`	`'S'`	#
`mixed`	`TRXTYPE_CREDIT`	`'C'`	#
`mixed`	`TRXTYPE_DELAYED_CAPTURE`	`'D'`	#
`mixed`	`TRXTYPE_DELAYED_VOID`	`'V'`	#
`mixed`	`TENDER_CC`	`'C'`	# Tender definition Tender definition
`mixed`	`TENDER_PAYPAL`	`'P'`	#
`string`	`EXPRESS_SET`	`'S'`	# Express Checkout Actions Express Checkout Actions
`string`	`EXPRESS_GET`	`'G'`	#
`string`	`EXPRESS_DO_PAYMENT`	`'D'`	#
`mixed`	`RESPONSE_CODE_APPROVED`	`0`	# Response codes definition Response codes definition
`mixed`	`RESPONSE_CODE_FRAUD`	`126`	#

Constants inherited from Mage_Paypal_Model_Api_Nvp
`CALLBACK_RESPONSE, DO_AUTHORIZATION, DO_CAPTURE, DO_DIRECT_PAYMENT, DO_EXPRESS_CHECKOUT_PAYMENT, DO_VOID, GET_EXPRESS_CHECKOUT_DETAILS, PENDING_TRANSACTION_ACCEPT, PENDING_TRANSACTION_DENY, REFUND_TRANSACTION, SET_EXPRESS_CHECKOUT`

Properties summary
`protected string`	`$_captureTypeComplete`	`'Y'`	# Capture types (make authorization close or remain open) Capture types (make authorization close or remain open)
`protected string`	`$_captureTypeNotcomplete`	`'N'`	#
`protected array`	`$_globalMap`	array( // each call 'PARTNER' => 'partner', 'VENDOR' => 'vendor', 'USER' => 'user', 'PWD' => 'password', 'BUTTONSOURCE' => 'build_notation_code', 'TENDER' => 'tender', // commands 'RETURNURL' => 'return_url', 'CANCELURL' => 'cancel_url', 'INVNUM' => 'inv_num', 'TOKEN' => 'token', 'CORRELATIONID' => 'correlation_id', 'CUSTIP' => 'ip_address', 'NOTIFYURL' => 'notify_url', 'NOTE' => 'note', // style settings 'PAGESTYLE' => 'page_style', 'HDRIMG' => 'hdrimg', 'HDRBORDERCOLOR' => 'hdrbordercolor', 'HDRBACKCOLOR' => 'hdrbackcolor', 'PAYFLOWCOLOR' => 'payflowcolor', 'LOCALECODE' => 'locale_code', // transaction info 'PPREF' => 'paypal_transaction_id', //We need to store paypal trx id for correct IPN working 'PNREF' => 'transaction_id', 'ORIGID' => 'authorization_id', 'CAPTURECOMPLETE' => 'complete_type', 'AMT' => 'amount', 'AVSADDR' => 'address_verification', 'AVSZIP' => 'postcode_verification', // payment/billing info 'CURRENCY' => 'currency_code', 'PENDINGREASON' => 'pending_reason', 'PAYERID' => 'payer_id', 'PAYERSTATUS' => 'payer_status', 'EMAIL' => 'email', // backwards compatibility 'FIRSTNAME' => 'firstname', 'LASTNAME' => 'lastname', // paypal direct credit card information 'ACCT' => 'credit_card_number', 'EXPDATE' => 'credit_card_expiration_date', 'CVV2' => 'credit_card_cvv2', 'CARDSTART' => 'maestro_solo_issue_date', // MMYY, including leading zero 'CARDISSUE' => 'maestro_solo_issue_number', 'CVV2MATCH' => 'cvv2_check_result', // cardinal centinel 'AUTHSTATUS3DS' => 'centinel_authstatus', 'MPIVENDOR3DS' => 'centinel_mpivendor', 'CAVV' => 'centinel_cavv', 'ECI' => 'centinel_eci', 'XID' => 'centinel_xid', 'VPAS' => 'centinel_vpas_result', 'ECISUBMITTED3DS' => 'centinel_eci_result', )	# Global public interface map Global public interface map
`protected array`	`$_debugReplacePrivateDataKeys`	`array( 'ACCT', 'EXPDATE', 'CVV2', 'PARTNER', 'USER', 'VENDOR', 'PWD', )`	# Fields that should be replaced in debug with '*' Fields that should be replaced in debug with '*'
`protected array`	`$_doDirectPaymentRequest`	`array( 'ACCT', 'EXPDATE', 'CVV2', 'CURRENCY', 'EMAIL', 'TENDER', 'NOTIFYURL', 'AMT', 'CUSTIP', 'INVNUM', 'CARDISSUE', 'CARDSTART', 'AUTHSTATUS3DS', 'MPIVENDOR3DS', 'CAVV', 'ECI', 'XID',//cardinal centinel params 'TAXAMT', 'FREIGHTAMT' )`	# DoDirectPayment request/response map DoDirectPayment request/response map
`protected array`	`$_doDirectPaymentResponse`	`array( 'PNREF', 'PPREF', 'CORRELATIONID', 'CVV2MATCH', 'AVSADDR', 'AVSZIP', 'PENDINGREASON' )`	#
`protected array`	`$_doCaptureRequest`	`array('ORIGID', 'CAPTURECOMPLETE', 'AMT', 'TENDER', 'NOTE', 'INVNUM')`	# DoCapture request/response map DoCapture request/response map
`protected array`	`$_doCaptureResponse`	`array('PNREF', 'PPREF')`	#
`protected array`	`$_doVoidRequest`	`array('ORIGID', 'NOTE', 'TENDER')`	# DoVoid request map DoVoid request map
`protected array`	`$_eachCallRequest`	`array('PARTNER', 'USER', 'VENDOR', 'PWD', 'BUTTONSOURCE')`	# Request map for each API call Request map for each API call
`protected array`	`$_refundTransactionRequest`	`array('ORIGID', 'TENDER')`	# RefundTransaction request/response map RefundTransaction request/response map
`protected array`	`$_refundTransactionResponse`	`array('PNREF', 'PPREF')`	#
`protected array`	`$_setExpressCheckoutRequest`	`array( 'TENDER', 'AMT', 'CURRENCY', 'RETURNURL', 'CANCELURL', 'INVNUM', 'PAGESTYLE', 'HDRIMG', 'HDRBORDERCOLOR', 'HDRBACKCOLOR', 'PAYFLOWCOLOR', 'LOCALECODE', )`	# SetExpressCheckout request/response map SetExpressCheckout request/response map
`protected array`	`$_setExpressCheckoutResponse`	`array('REPMSG', 'TOKEN')`	#
`protected array`	`$_getExpressCheckoutDetailsRequest`	`array('TENDER', 'TOKEN')`	# GetExpressCheckoutDetails request/response map GetExpressCheckoutDetails request/response map
`protected array`	`$_doExpressCheckoutPaymentRequest`	`array( 'TENDER', 'TOKEN', 'PAYERID', 'AMT', 'CURRENCY', 'CUSTIP', 'BUTTONSOURCE', 'NOTIFYURL', )`	# DoExpressCheckoutPayment request/response map DoExpressCheckoutPayment request/response map
`protected array`	`$_doExpressCheckoutPaymentResponse`	`array( 'PNREF', 'PPREF', 'REPMSG', 'AMT', 'PENDINGREASON', 'CVV2MATCH', 'AVSADDR', 'AVSZIP', 'CORRELATIONID' )`	#
`protected array`	`$_getTransactionDetailsRequest`	`array('ORIGID', 'TENDER')`	# GetTransactionDetailsRequest GetTransactionDetailsRequest
`protected array`	`$_getTransactionDetailsResponse`	`array( 'PAYERID', 'FIRSTNAME', 'LASTNAME', 'TRANSACTIONID', 'PARENTTRANSACTIONID', 'CURRENCYCODE', 'AMT', 'PAYMENTSTATUS' )`	#
`protected array`	`$_shippingAddressMap`	`array( 'SHIPTOCOUNTRY' => 'country_id', 'SHIPTOSTATE' => 'region', 'SHIPTOCITY' => 'city', 'SHIPTOSTREET' => 'street', 'SHIPTOSTREET2' => 'street2', 'SHIPTOZIP' => 'postcode', 'SHIPTOPHONENUM' => 'telephone', // does not supported by PaypalUk )`	# Map for shipping address import/export (extends billing address mapper) Map for shipping address import/export (extends billing address mapper)
`protected 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', )`	# Map for billing address import/export Map for billing address import/export
`protected array`	`$_billingAddressMapRequest`	`array( 'country_id' => 'COUNTRY', )`	# Map for billing address to do request to PayPalUk Map for billing address to do request to PayPalUk
`protected array`	`$_lineItemTotalExportMap`	`array( Mage_Paypal_Model_Cart::TOTAL_TAX => 'TAXAMT', Mage_Paypal_Model_Cart::TOTAL_SHIPPING => 'FREIGHTAMT', )`	# Line items export mapping settings Line items export mapping settings
`protected array`	`$_lineItemExportItemsFormat`	`array( 'name' => 'L_NAME%d', 'qty' => 'L_QTY%d', 'amount' => 'L_COST%d', )`	# Line items export to request mapping settings Line items export to request mapping settings
`protected array`	`$_paymentInformationResponse`	`array( 'PAYERID', 'CORRELATIONID', 'ADDRESSID', 'ADDRESSSTATUS', 'PAYMENTSTATUS', 'PENDINGREASON', 'PROTECTIONELIGIBILITY', 'EMAIL', )`	# Payment information response specifically to be collected after some requests Payment information response specifically to be collected after some requests
`protected array`	`$_requiredResponseParams`	`array( self::DO_DIRECT_PAYMENT => array('RESULT', 'PNREF', 'PPREF') )`	# Required fields in the response Required fields in the response

Properties inherited from Mage_Paypal_Model_Api_Nvp
$_billingAgreementCustomerDetailsRequest, $_billingAgreementCustomerDetailsResponse, $_callErrors, $_callWarnings, $_callbackRequestMap, $_createBillingAgreementRequest, $_createBillingAgreementResponse, $_createRecurringPaymentsProfileRequest, $_createRecurringPaymentsProfileResponse, $_customerBillingAgreementRequest, $_customerBillingAgreementResponse, $_doAuthorizationRequest, $_doAuthorizationResponse, $_doReauthorizationRequest, $_doReauthorizationResponse, $_doReferenceTransactionRequest, $_doReferenceTransactionResponse, $_exportToRequestFilters, $_getPalDetailsResponse, $_getRecurringPaymentsProfileDetailsRequest, $_getRecurringPaymentsProfileDetailsResponse, $_importFromRequestFilters, $_managePendingTransactionStatusRequest, $_managePendingTransactionStatusResponse, $_manageRecurringPaymentsProfileStatusRequest, $_rawResponseNeeded, $_shippingOptionsExportItemsFormat, $_supportedCcTypes, $_updateBillingAgreementRequest, $_updateBillingAgreementResponse

Properties inherited from Mage_Paypal_Model_Api_Abstract
`$_cart, $_config, $_lineItemExportItemsFilters, $_recurringPaymentProfiles`

Packages

Classes

Class Mage_PaypalUk_Model_Api_Nvp

Returns

Overrides

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Overrides

Parameters

Returns

Overrides

Returns

Overrides

Parameters

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Overrides