Public Member Functions
	getPaymentInfo (\Magento\Payment\Model\InfoInterface $payment, $labelValuesOnly=false)

	getPublicPaymentInfo (\Magento\Payment\Model\InfoInterface $payment, $labelValuesOnly=false)

	importToPayment ($from, \Magento\Payment\Model\InfoInterface $payment)

&	exportFromPayment (\Magento\Payment\Model\InfoInterface $payment, $to, array $map=null)

Static Public Member Functions
static	isPaymentReviewRequired (\Magento\Payment\Model\InfoInterface $payment)

static	isFraudReviewAllowed (\Magento\Payment\Model\InfoInterface $payment)

static	isPaymentCompleted (\Magento\Payment\Model\InfoInterface $payment)

static	isPaymentSuccessful (\Magento\Payment\Model\InfoInterface $payment)

static	isPaymentFailed (\Magento\Payment\Model\InfoInterface $payment)

static	explainPendingReason ($code)

static	explainReasonCode ($code)

static	isReversalDisputable ($code)

static	getCaseTypeLabel ($key)

Data Fields
const	PAYER_ID = 'payer_id'

const	PAYER_EMAIL = 'email'

const	PAYER_STATUS = 'payer_status'

const	ADDRESS_ID = 'address_id'

const	ADDRESS_STATUS = 'address_status'

const	PROTECTION_EL = 'protection_eligibility'

const	FRAUD_FILTERS = 'collected_fraud_filters'

const	CORRELATION_ID = 'correlation_id'

const	AVS_CODE = 'avs_result'

const	AVSADDR = 'avsaddr'

const	AVSZIP = 'avszip'

const	IAVS = 'iavs'

const	CVV2MATCH = 'cvv2match'

const	CVV_2_MATCH = 'cvv_2_check_result'

const	BUYER_TAX_ID = 'buyer_tax_id'

const	BUYER_TAX_ID_TYPE = 'buyer_tax_id_type'

const	PAYMENT_STATUS = 'payment_status'

const	PENDING_REASON = 'pending_reason'

const	IS_FRAUD = 'is_fraud_detected'

const	PAYMENT_STATUS_GLOBAL = 'paypal_payment_status'

const	PENDING_REASON_GLOBAL = 'paypal_pending_reason'

const	IS_FRAUD_GLOBAL = 'paypal_is_fraud_detected'

const	BUYER_TAX_ID_TYPE_CPF = 'BR_CPF'

const	BUYER_TAX_ID_TYPE_CNPJ = 'BR_CNPJ'

const	PAYMENTSTATUS_NONE = 'none'

const	PAYMENTSTATUS_COMPLETED = 'completed'

const	PAYMENTSTATUS_DENIED = 'denied'

const	PAYMENTSTATUS_EXPIRED = 'expired'

const	PAYMENTSTATUS_FAILED = 'failed'

const	PAYMENTSTATUS_INPROGRESS = 'in_progress'

const	PAYMENTSTATUS_PENDING = 'pending'

const	PAYMENTSTATUS_REFUNDED = 'refunded'

const	PAYMENTSTATUS_REFUNDEDPART = 'partially_refunded'

const	PAYMENTSTATUS_REVERSED = 'reversed'

const	PAYMENTSTATUS_UNREVERSED = 'canceled_reversal'

const	PAYMENTSTATUS_PROCESSED = 'processed'

const	PAYMENTSTATUS_VOIDED = 'voided'

const	PAYMENTSTATUS_REVIEW = 'paymentreview'

const	TXN_TYPE_ADJUSTMENT = 'adjustment'

const	TXN_TYPE_NEW_CASE = 'new_case'

const	PAYMENT_REASON_CODE_REFUND = 'refund'

const	ORDER_STATUS_REVERSED = 'paypal_reversed'

const	ORDER_STATUS_CANCELED_REVERSAL = 'paypal_canceled_reversal'

const	PAYPAL_PAYER_ID = 'paypal_payer_id'

const	PAYPAL_PAYER_EMAIL = 'paypal_payer_email'

const	PAYPAL_PAYER_STATUS = 'paypal_payer_status'

const	PAYPAL_ADDRESS_ID = 'paypal_address_id'

const	PAYPAL_ADDRESS_STATUS = 'paypal_address_status'

const	PAYPAL_PROTECTION_ELIGIBILITY = 'paypal_protection_eligibility'

const	PAYPAL_FRAUD_FILTERS = 'paypal_fraud_filters'

const	PAYPAL_CORRELATION_ID = 'paypal_correlation_id'

const	PAYPAL_AVS_CODE = 'paypal_avs_code'

const	PAYPAL_CVV_2_MATCH = 'paypal_cvv_2_match'

const	ITEM_LABELS = 'item labels'

const	PAYPAL_AVSADDR = 'avsaddr'

const	PAYPAL_AVSZIP = 'avszip'

const	PAYPAL_IAVS = 'iavs'

const	PAYPAL_CVV2MATCH = 'cvv2match'

Protected Member Functions
	_getFullInfo (array $keys, \Magento\Payment\Model\InfoInterface $payment, $labelValuesOnly)

	_getLabel ($key)

	_getValue ($value, $key)

	_getAvsLabel ($value)

	_getCvv2Label ($value)

	_getBuyerIdTypeValue ($code)

Protected Attributes
	$_paymentMap

	$_systemMap

	$_paymentPublicMap = ['paypal_payer_email', self::BUYER_TAX_ID, self::BUYER_TAX_ID_TYPE]

	$_paymentMapFull = []

	$_labelCodesCache = []

Detailed Description

PayPal payment information model

Aware of all PayPal payment methods Collects and provides access to PayPal-specific payment data Provides business logic information about payment flow

Definition at line 16 of file Info.php.

Member Function Documentation

◆ _getAvsLabel()

_getAvsLabel ( $value )

protected

Attempt to convert AVS check result code into label

Parameters

string $value

Returns: string &cmd=_render-content&content_ID=developer/e_howto_api_nvp_AVSResponseCodes

Definition at line 680 of file Info.php.

     {
         if (!isset($this->_labelCodesCache[self::PAYPAL_AVS_CODE])) {
             $this->_labelCodesCache[self::PAYPAL_AVS_CODE] = [
                 'A' => __('Matched Address only (no ZIP)'), // Visa, MasterCard, Discover and American Express
                 'B' => __('Matched Address only (no ZIP) International'), // international "A"
                 'N' => __('No Details matched'),
                 'C' => __('No Details matched. International'), // international "N"
                 'X' => __('Exact Match.'),
                 'D' => __('Exact Match. Address and Postal Code. International'), // international "X"
                 'F' => __('Exact Match. Address and Postal Code. UK-specific'), // UK-specific "X"
                 'E' => __('N/A. Not allowed for MOTO (Internet/Phone) transactions'),
                 'G' => __('N/A. Global Unavailable'),
                 'I' => __('N/A. International Unavailable'),
                 'Z' => __('Matched five-digit ZIP only (no Address)'),
                 'P' => __('Matched Postal Code only (no Address)'), // international "Z"
                 'R' => __('N/A. Retry'),
                 'S' => __('N/A. Service not Supported'),
                 'U' => __('N/A. Unavailable'),
                 'W' => __('Matched whole nine-digit ZIP (no Address)'),
                 'Y' => __('Yes. Matched Address and five-digit ZIP'),
                 '0' => __('All the address information matched'), // Maestro and Solo
                 '1' => __('None of the address information matched'),
                 '2' => __('Part of the address information matched'),
                 '3' => __('N/A. The merchant did not provide AVS information'),
                 '4' => __('N/A. Address not checked, or acquirer had no response. Service not available'),
             ];
         }
         return isset($this->_labelCodesCache[self::PAYPAL_AVS_CODE][$value])
             ? $this->_labelCodesCache[self::PAYPAL_AVS_CODE][$value]
             : $value;
     }

◆ _getBuyerIdTypeValue()

_getBuyerIdTypeValue ( $code )

protected

Retrieve buyer id type value based on code received from PayPal (Brazil only)

Parameters

string $code

Returns: string

Definition at line 751 of file Info.php.

     {
         if (!isset($this->_labelCodesCache[self::BUYER_TAX_ID_TYPE])) {
             $this->_labelCodesCache[self::BUYER_TAX_ID_TYPE] = [
                 self::BUYER_TAX_ID_TYPE_CNPJ => __('CNPJ'),
                 self::BUYER_TAX_ID_TYPE_CPF => __('CPF'),
             ];
         }
         return isset($this->_labelCodesCache[self::BUYER_TAX_ID_TYPE][$code])
             ? $this->_labelCodesCache[self::BUYER_TAX_ID_TYPE][$code]
             : '';
     }

◆ _getCvv2Label()

_getCvv2Label ( $value )

protected

Attempt to convert CVV2 check result code into label

Parameters

string $value

Returns: string &cmd=_render-content&content_ID=developer/e_howto_api_nvp_AVSResponseCodes

Definition at line 720 of file Info.php.

     {
         if (!isset($this->_labelCodesCache[self::PAYPAL_CVV_2_MATCH])) {
             $this->_labelCodesCache[self::PAYPAL_CVV_2_MATCH] = [
                 // Visa, MasterCard, Discover and American Express
                 'M' => __('Matched (CVV2CSC)'),
                 'N' => __('No match'),
                 'P' => __('N/A. Not processed'),
                 'S' => __('N/A. Service not supported'),
                 'U' => __('N/A. Service not available'),
                 'X' => __('N/A. No response'),
                 'Y' => __('Matched (CVV2CSC)'),
                 // Maestro and Solo
                 '0' => __('Matched (CVV2)'),
                 '1' => __('No match'),
                 '2' => __('N/A. The merchant has not implemented CVV2 code handling'),
                 '3' => __('N/A. Merchant has indicated that CVV2 is not present on card'),
                 '4' => __('N/A. Service not available'),
             ];
         }
         return isset($this->_labelCodesCache[self::PAYPAL_CVV_2_MATCH][$value])
             ? $this->_labelCodesCache[self::PAYPAL_CVV_2_MATCH][$value]
             : $value;
     }

◆ _getFullInfo()

_getFullInfo	(	array	$keys,
		\Magento\Payment\Model\InfoInterface	$payment,
			$labelValuesOnly
	)

protected

Render info item

Parameters

array	$keys
\Magento\Payment\Model\InfoInterface	$payment
bool	$labelValuesOnly

Returns: array

Definition at line 556 of file Info.php.

     {
         $result = [];
         foreach ($keys as $key) {
             if (!isset($this->_paymentMapFull[$key])) {
                 $this->_paymentMapFull[$key] = [];
             }
             if (!isset($this->_paymentMapFull[$key]['label'])) {
                 if (!$payment->hasAdditionalInformation($key)) {
                     $this->_paymentMapFull[$key]['label'] = false;
                     $this->_paymentMapFull[$key]['value'] = false;
                 } else {
                     $value = $payment->getAdditionalInformation($key);
                     $this->_paymentMapFull[$key]['label'] = (string)$this->_getLabel($key);
                     $this->_paymentMapFull[$key]['value'] = $this->_getValue($value, $key);
                 }
             }
             if (!empty($this->_paymentMapFull[$key]['value'])) {
                 if ($labelValuesOnly) {
                     $value = $this->_paymentMapFull[$key]['value'];
                     $value = is_array($value) ? array_map('__', $value) : __($value);
                     $result[$this->_paymentMapFull[$key]['label']] = $value;
                 } else {
                     $result[$key] = $this->_paymentMapFull[$key];
                 }
             }
         }
         return $result;
     }

◆ _getLabel()

_getLabel ( $key )

protected

Render info item labels

Parameters

string $key

Returns: string

Definition at line 592 of file Info.php.

     {
         if (!isset($this->_labelCodesCache[self::ITEM_LABELS])) {
             $this->_labelCodesCache[self::ITEM_LABELS] = [
                 self::PAYPAL_PAYER_ID => __('Payer ID'),
                 self::PAYPAL_PAYER_EMAIL => __('Payer Email'),
                 self::PAYPAL_PAYER_STATUS => __('Payer Status'),
                 self::PAYPAL_ADDRESS_ID => __('Payer Address ID'),
                 self::PAYPAL_ADDRESS_STATUS => __('Payer Address Status'),
                 self::PAYPAL_PROTECTION_ELIGIBILITY => __('Merchant Protection Eligibility'),
                 self::PAYPAL_FRAUD_FILTERS => __('Triggered Fraud Filters'),
                 self::PAYPAL_CORRELATION_ID => __('Last Correlation ID'),
                 self::PAYPAL_AVS_CODE => __('Address Verification System Response'),
                 self::PAYPAL_CVV_2_MATCH => __('CVV2 Check Result by PayPal'),
                 self::PAYPAL_CVV2MATCH => __('CVV2 Check Result by PayPal'),
                 self::PAYPAL_AVSADDR => __('AVS Street Match'),
                 self::PAYPAL_AVSZIP => __('AVS zip'),
                 self::PAYPAL_IAVS => __('International AVS response'),
                 self::BUYER_TAX_ID => __('Buyer\'s Tax ID'),
                 self::BUYER_TAX_ID_TYPE => __('Buyer\'s Tax ID Type'),
             ];
         }
         return isset($this->_labelCodesCache[self::ITEM_LABELS][$key])
             ? $this->_labelCodesCache[self::ITEM_LABELS][$key]
             : '';
     }

◆ _getValue()

_getValue	(	$value,
		$key
	)

protected

Apply a filter upon value getting

Parameters

string	$value
string	$key

Returns: string @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 644 of file Info.php.

     {
         $label = '';
         $outputValue = implode(', ', (array) $value);
         switch ($key) {
             case self::PAYPAL_IAVS:
             case self::PAYPAL_AVSZIP:
             case self::PAYPAL_AVSADDR:
             case self::PAYPAL_AVS_CODE:
                 $label = $this->_getAvsLabel($outputValue);
                 break;
             case self::PAYPAL_CVV2MATCH:
             case self::PAYPAL_CVV_2_MATCH:
                 $label = $this->_getCvv2Label($outputValue);
                 break;
             case self::PAYPAL_FRAUD_FILTERS:
                 if (is_array($value)) {
                     return $value;
                 }
                 break;
             case self::BUYER_TAX_ID_TYPE:
                 $outputValue = $this->_getBuyerIdTypeValue($outputValue);
                 // fall-through intentional
             default:
                 return $outputValue;
         }
         return sprintf('#%s%s', $outputValue, $outputValue == $label ? '' : ': ' . $label);
     }

◆ explainPendingReason()

static explainPendingReason ( $code )

static

Explain pending payment reason code

Parameters

string $code

Returns: \Magento\Framework\Phrase &cmd=_render-content&content_ID=developer/e_howto_html_IPNandPDTVariables https://cms.paypal.com/us/cgi-bin/?&cmd=_render-content&content_ID=developer/e_howto_api_nvp_r_GetTransactionDetails (PHPMD.CyclomaticComplexity)

Definition at line 435 of file Info.php.

     {
         switch ($code) {
             case 'address':
                 return __('This customer didn\'t include a confirmed address.');
             case 'authorization':
             case 'order':
                 return __('The payment is authorized but not settled.');
             case 'echeck':
                 return __('The payment eCheck is not cleared.');
             case 'intl':
                 return __('The merchant holds a non-U.S. account and doesn\'t have a withdrawal mechanism.');
             case 'multi-currency':
                 // break is intentionally omitted
             case 'multi_currency':
                 // break is intentionally omitted
             case 'multicurrency':
                 return __('The payment currency doesn\'t match any of the merchant\'s balances currency.');
             case 'paymentreview':
                 return __('The payment is pending while it is being reviewed by PayPal for risk.');
             case 'unilateral':
                 return __(
                     'The payment is pending because it was made to an email address that '
                     . 'is not yet registered or confirmed.'
                 );
             case 'verify':
                 return __('The merchant account is not yet verified.');
             case 'upgrade':
                 return __(
                     'The payment was made via credit card.'
                     . ' In order to receive funds merchant must upgrade account to Business or Premier status.'
                 );
             case 'none':
                 // break is intentionally omitted
             case 'other':
                 // break is intentionally omitted
             default:
                 return __('Sorry, but something went wrong. Please contact PayPal customer service.');
         }
     }

◆ explainReasonCode()

static explainReasonCode ( $code )

static

Explain the refund or chargeback reason code

Parameters

string $code

Returns: string &cmd=_render-content&content_ID=developer/e_howto_html_IPNandPDTVariables https://cms.paypal.com/us/cgi-bin/?&cmd=_render-content&content_ID=developer/e_howto_api_nvp_r_GetTransactionDetails

Definition at line 484 of file Info.php.

     {
         $comments = [
             'chargeback' => __('A reversal has occurred on this transaction due to a chargeback by your customer.'),
             'guarantee' => __(
                 'A reversal has occurred on this transaction due to your customer triggering a money-back guarantee.'
             ),
             'buyer-complaint' => __(
                 'A reversal has occurred on this transaction due to a'
                 . ' complaint about the transaction from your customer.'
             ),
             'buyer_complaint' => __(
                 'A reversal has occurred on this transaction due to a'
                 . ' complaint about the transaction from your customer.'
             ),
             'refund' => __(
                 'A reversal has occurred on this transaction because you have given the customer a refund.'
             ),
             'adjustment_reversal' => __('Reversal of an adjustment.'),
             'admin_fraud_reversal' => __('Transaction reversal due to fraud detected by PayPal administrators.'),
             'admin_reversal' => __('Transaction reversal by PayPal administrators.'),
             'chargeback_reimbursement' => __('Reimbursement for a chargeback.'),
             'chargeback_settlement' => __('Settlement of a chargeback.'),
             'unauthorized_spoof' => __(
                 'A reversal has occurred on this transaction because of a'
                 . ' customer dispute suspecting unauthorized spoof.'
             ),
             'non_receipt' => __('Buyer claims that he did not receive goods or service.'),
             'not_as_described' => __(
                 'Buyer claims that the goods or service received differ from'
                 . ' merchant’s description of the goods or service.'
             ),
             'unauthorized' => __('Buyer claims that he/she did not authorize transaction.'),
             'adjustment_reimburse' => __('A case that has been resolved and close requires a reimbursement.'),
             'duplicate' => __('Buyer claims that a possible duplicate payment was made to the merchant.'),
             'merchandise' => __('Buyer claims that the received merchandise is unsatisfactory, defective, or damaged.'),
         ];
         return isset($comments[$code])
             ? $comments[$code]
             : __('Unknown reason. Please contact PayPal customer service.');
     }

◆ exportFromPayment()

& exportFromPayment	(	\Magento\Payment\Model\InfoInterface	$payment,
			$to,
		array	$map = `null`
	)

Grab data from payment and map it into target

Parameters

\Magento\Payment\Model\InfoInterface	$payment
array \| \Magento\Framework\DataObject \| callback	$to
array \| null	$map

Returns: array|\Magento\Framework\DataObject

Definition at line 321 of file Info.php.

     {
         $fullMap = array_merge($this->_paymentMap, $this->_systemMap);
         \Magento\Framework\DataObject\Mapper::accumulateByMap(
             [$payment, 'getAdditionalInformation'],
             $to,
             $map ? $map : array_flip($fullMap)
         );
         return $to;
     }

◆ getCaseTypeLabel()

static getCaseTypeLabel ( $key )

static

Get case type label

Parameters

string $key

Returns: string

Definition at line 625 of file Info.php.

     {
         $labels = [
             'chargeback' => __('Chargeback'),
             'complaint' => __('Complaint'),
             'dispute' => __('Dispute'),
         ];
         $value = isset($labels[$key]) ? $labels[$key] : '';
         return $value;
     }

◆ getPaymentInfo()

getPaymentInfo	(	\Magento\Payment\Model\InfoInterface	$payment,
			$labelValuesOnly = `false`
	)

All available payment info getter

Parameters

\Magento\Payment\Model\InfoInterface	$payment
bool	$labelValuesOnly

Returns: array

Definition at line 268 of file Info.php.

     {
         // collect paypal-specific info
         $result = $this->_getFullInfo(array_values($this->_paymentMap), $payment, $labelValuesOnly);
 
         // add last_trans_id
         $label = __('Last Transaction ID');
         $value = $payment->getLastTransId();
         if ($labelValuesOnly) {
             $result[(string)$label] = $value;
         } else {
             $result['last_trans_id'] = ['label' => $label, 'value' => $value];
         }
 
         return $result;
     }

◆ getPublicPaymentInfo()

getPublicPaymentInfo	(	\Magento\Payment\Model\InfoInterface	$payment,
			$labelValuesOnly = `false`
	)

Public payment info getter

Parameters

\Magento\Payment\Model\InfoInterface	$payment
bool	$labelValuesOnly

Returns: array

Definition at line 292 of file Info.php.

     {
         return $this->_getFullInfo($this->_paymentPublicMap, $payment, $labelValuesOnly);
     }

◆ importToPayment()

importToPayment	(		$from,
		\Magento\Payment\Model\InfoInterface	$payment
	)

Grab data from source and map it into payment

Parameters

array \| \Magento\Framework\DataObject \| callback	$from
\Magento\Payment\Model\InfoInterface	$payment

Returns: void

Definition at line 304 of file Info.php.

     {
         $fullMap = array_merge($this->_paymentMap, $this->_systemMap);
         if (is_object($from)) {
             $from = [$from, 'getDataUsingMethod'];
         }
         \Magento\Framework\DataObject\Mapper::accumulateByMap($from, [$payment, 'setAdditionalInformation'], $fullMap);
     }

◆ isFraudReviewAllowed()

static isFraudReviewAllowed ( \Magento\Payment\Model\InfoInterface $payment )

static

Check whether fraud order review detected and can be reviewed

Parameters

\Magento\Payment\Model\InfoInterface $payment

Returns: bool

Definition at line 354 of file Info.php.

     {
         return self::isPaymentReviewRequired(
             $payment
         ) && 1 == $payment->getAdditionalInformation(
             self::IS_FRAUD_GLOBAL
         );
     }

◆ isPaymentCompleted()

static isPaymentCompleted ( \Magento\Payment\Model\InfoInterface $payment )

static

Check whether the payment is completed

Parameters

\Magento\Payment\Model\InfoInterface $payment

Returns: bool

Definition at line 369 of file Info.php.

     {
         $paymentStatus = $payment->getAdditionalInformation(self::PAYMENT_STATUS_GLOBAL);
         return self::PAYMENTSTATUS_COMPLETED === $paymentStatus;
     }

◆ isPaymentFailed()

static isPaymentFailed ( \Magento\Payment\Model\InfoInterface $payment )

static

Check whether the payment was processed unsuccessfully or failed

Parameters

\Magento\Payment\Model\InfoInterface $payment

Returns: bool

Definition at line 411 of file Info.php.

     {
         $paymentStatus = $payment->getAdditionalInformation(self::PAYMENT_STATUS_GLOBAL);
         return in_array(
             $paymentStatus,
             [
                 self::PAYMENTSTATUS_DENIED,
                 self::PAYMENTSTATUS_EXPIRED,
                 self::PAYMENTSTATUS_FAILED,
                 self::PAYMENTSTATUS_REVERSED,
                 self::PAYMENTSTATUS_VOIDED
             ]
         );
     }

◆ isPaymentReviewRequired()

static isPaymentReviewRequired ( \Magento\Payment\Model\InfoInterface $payment )

static

Check whether the payment is in review state

Parameters

\Magento\Payment\Model\InfoInterface $payment

Returns: bool

Definition at line 338 of file Info.php.

     {
         $paymentStatus = $payment->getAdditionalInformation(self::PAYMENT_STATUS_GLOBAL);
         if (self::PAYMENTSTATUS_PENDING === $paymentStatus) {
             $pendingReason = $payment->getAdditionalInformation(self::PENDING_REASON_GLOBAL);
             return !in_array($pendingReason, ['authorization', 'order']);
         }
         return false;
     }

◆ isPaymentSuccessful()

static isPaymentSuccessful ( \Magento\Payment\Model\InfoInterface $payment )

static

Check whether the payment was processed successfully

Parameters

\Magento\Payment\Model\InfoInterface $payment

Returns: bool

Definition at line 381 of file Info.php.

     {
         $paymentStatus = $payment->getAdditionalInformation(self::PAYMENT_STATUS_GLOBAL);
         if (in_array(
             $paymentStatus,
             [
                 self::PAYMENTSTATUS_COMPLETED,
                 self::PAYMENTSTATUS_INPROGRESS,
                 self::PAYMENTSTATUS_REFUNDED,
                 self::PAYMENTSTATUS_REFUNDEDPART,
                 self::PAYMENTSTATUS_UNREVERSED,
                 self::PAYMENTSTATUS_PROCESSED
             ]
         )
         ) {
             return true;
         }
         $pendingReason = $payment->getAdditionalInformation(self::PENDING_REASON_GLOBAL);
         return self::PAYMENTSTATUS_PENDING === $paymentStatus && in_array(
             $pendingReason,
             ['authorization', 'order']
         );
     }

◆ isReversalDisputable()

static isReversalDisputable ( $code )

static

Whether a reversal/refund can be disputed with PayPal

Parameters

string $code

Returns: bool;

Definition at line 532 of file Info.php.

     {
         $listOfDisputeCodes = [
             'none' => true,
             'other' => true,
             'chargeback' => true,
             'buyer-complaint' => true,
             'adjustment_reversal' => true,
             'guarantee' => false,
             'refund' => false,
             'chargeback_reimbursement' => false,
             'chargeback_settlement' => false,
         ];
         return isset($listOfDisputeCodes[$code]) ? $listOfDisputeCodes[$code] : false;
     }

Field Documentation

◆ $_labelCodesCache

$_labelCodesCache = []

protected

Definition at line 184 of file Info.php.

◆ $_paymentMap

$_paymentMap

protected

Initial value:

= [
        self::PAYER_ID => self::PAYPAL_PAYER_ID,
        self::PAYER_EMAIL => self::PAYPAL_PAYER_EMAIL,
        self::PAYER_STATUS => self::PAYPAL_PAYER_STATUS,
        self::ADDRESS_ID => self::PAYPAL_ADDRESS_ID,
        self::ADDRESS_STATUS => self::PAYPAL_ADDRESS_STATUS,
        self::PROTECTION_EL => self::PAYPAL_PROTECTION_ELIGIBILITY,
        self::FRAUD_FILTERS => self::PAYPAL_FRAUD_FILTERS,
        self::CORRELATION_ID => self::PAYPAL_CORRELATION_ID,
        self::AVS_CODE => self::PAYPAL_AVS_CODE,
        self::CVV_2_MATCH => self::PAYPAL_CVV_2_MATCH,
        self::BUYER_TAX_ID => self::BUYER_TAX_ID,
        self::BUYER_TAX_ID_TYPE => self::BUYER_TAX_ID_TYPE,
        self::AVSADDR => self::PAYPAL_AVSADDR,
        self::AVSZIP => self::PAYPAL_AVSZIP,
        self::IAVS => self::PAYPAL_IAVS,
        self::CVV2MATCH => self::PAYPAL_CVV2MATCH
    ]

Definition at line 80 of file Info.php.

◆ $_paymentMapFull

$_paymentMapFull = []

protected

Definition at line 177 of file Info.php.

◆ $_paymentPublicMap

$_paymentPublicMap = ['paypal_payer_email', self::BUYER_TAX_ID, self::BUYER_TAX_ID_TYPE]

protected

Definition at line 170 of file Info.php.

◆ $_systemMap

$_systemMap

protected

Initial value:

= [
        self::PAYMENT_STATUS => self::PAYMENT_STATUS_GLOBAL,
        self::PENDING_REASON => self::PENDING_REASON_GLOBAL,
        self::IS_FRAUD => self::IS_FRAUD_GLOBAL,
    ]

Definition at line 104 of file Info.php.

◆ ADDRESS_ID

const ADDRESS_ID = 'address_id'

Definition at line 29 of file Info.php.

◆ ADDRESS_STATUS

const ADDRESS_STATUS = 'address_status'

Definition at line 31 of file Info.php.

◆ AVS_CODE

const AVS_CODE = 'avs_result'

Definition at line 39 of file Info.php.

◆ AVSADDR

const AVSADDR = 'avsaddr'

Definition at line 41 of file Info.php.

◆ AVSZIP

const AVSZIP = 'avszip'

Definition at line 43 of file Info.php.

◆ BUYER_TAX_ID

const BUYER_TAX_ID = 'buyer_tax_id'

Definition at line 52 of file Info.php.

◆ BUYER_TAX_ID_TYPE

const BUYER_TAX_ID_TYPE = 'buyer_tax_id_type'

Definition at line 54 of file Info.php.

◆ BUYER_TAX_ID_TYPE_CNPJ

const BUYER_TAX_ID_TYPE_CNPJ = 'BR_CNPJ'

Definition at line 73 of file Info.php.

◆ BUYER_TAX_ID_TYPE_CPF

const BUYER_TAX_ID_TYPE_CPF = 'BR_CPF'

Possible buyer's tax id types (Brazil only)

Definition at line 71 of file Info.php.

◆ CORRELATION_ID

const CORRELATION_ID = 'correlation_id'

Definition at line 37 of file Info.php.

◆ CVV2MATCH

const CVV2MATCH = 'cvv2match'

Definition at line 47 of file Info.php.

◆ CVV_2_MATCH

const CVV_2_MATCH = 'cvv_2_check_result'

Definition at line 49 of file Info.php.

◆ FRAUD_FILTERS

const FRAUD_FILTERS = 'collected_fraud_filters'

Definition at line 35 of file Info.php.

◆ IAVS

const IAVS = 'iavs'

Definition at line 45 of file Info.php.

◆ IS_FRAUD

const IS_FRAUD = 'is_fraud_detected'

Definition at line 60 of file Info.php.

◆ IS_FRAUD_GLOBAL

const IS_FRAUD_GLOBAL = 'paypal_is_fraud_detected'

Definition at line 66 of file Info.php.

◆ ITEM_LABELS

const ITEM_LABELS = 'item labels'

Item labels key for label codes cache

Definition at line 239 of file Info.php.

◆ ORDER_STATUS_CANCELED_REVERSAL

const ORDER_STATUS_CANCELED_REVERSAL = 'paypal_canceled_reversal'

PayPal order status for Canceled Reversal payment status

Definition at line 163 of file Info.php.

◆ ORDER_STATUS_REVERSED

const ORDER_STATUS_REVERSED = 'paypal_reversed'

PayPal order status for Reverse payment status

Definition at line 158 of file Info.php.

◆ PAYER_EMAIL

const PAYER_EMAIL = 'email'

Definition at line 25 of file Info.php.

◆ PAYER_ID

const PAYER_ID = 'payer_id'

Definition at line 23 of file Info.php.

◆ PAYER_STATUS

const PAYER_STATUS = 'payer_status'

Definition at line 27 of file Info.php.

◆ PAYMENT_REASON_CODE_REFUND

const PAYMENT_REASON_CODE_REFUND = 'refund'

PayPal payment reason code when payment_status is Reversed, Refunded, or Canceled_Reversal.

Definition at line 153 of file Info.php.

◆ PAYMENT_STATUS

const PAYMENT_STATUS = 'payment_status'

Definition at line 56 of file Info.php.

◆ PAYMENT_STATUS_GLOBAL

const PAYMENT_STATUS_GLOBAL = 'paypal_payment_status'

Definition at line 62 of file Info.php.

◆ PAYMENTSTATUS_COMPLETED

const PAYMENTSTATUS_COMPLETED = 'completed'

Definition at line 117 of file Info.php.

◆ PAYMENTSTATUS_DENIED

const PAYMENTSTATUS_DENIED = 'denied'

Definition at line 119 of file Info.php.

◆ PAYMENTSTATUS_EXPIRED

const PAYMENTSTATUS_EXPIRED = 'expired'

Definition at line 121 of file Info.php.

◆ PAYMENTSTATUS_FAILED

const PAYMENTSTATUS_FAILED = 'failed'

Definition at line 123 of file Info.php.

◆ PAYMENTSTATUS_INPROGRESS

const PAYMENTSTATUS_INPROGRESS = 'in_progress'

Definition at line 125 of file Info.php.

◆ PAYMENTSTATUS_NONE

const PAYMENTSTATUS_NONE = 'none'

Definition at line 115 of file Info.php.

◆ PAYMENTSTATUS_PENDING

const PAYMENTSTATUS_PENDING = 'pending'

Definition at line 127 of file Info.php.

◆ PAYMENTSTATUS_PROCESSED

const PAYMENTSTATUS_PROCESSED = 'processed'

Definition at line 137 of file Info.php.

◆ PAYMENTSTATUS_REFUNDED

const PAYMENTSTATUS_REFUNDED = 'refunded'

Definition at line 129 of file Info.php.

◆ PAYMENTSTATUS_REFUNDEDPART

const PAYMENTSTATUS_REFUNDEDPART = 'partially_refunded'

Definition at line 131 of file Info.php.

◆ PAYMENTSTATUS_REVERSED

const PAYMENTSTATUS_REVERSED = 'reversed'

Definition at line 133 of file Info.php.

◆ PAYMENTSTATUS_REVIEW

const PAYMENTSTATUS_REVIEW = 'paymentreview'

Definition at line 141 of file Info.php.

◆ PAYMENTSTATUS_UNREVERSED

const PAYMENTSTATUS_UNREVERSED = 'canceled_reversal'

Definition at line 135 of file Info.php.

◆ PAYMENTSTATUS_VOIDED

const PAYMENTSTATUS_VOIDED = 'voided'

Definition at line 139 of file Info.php.

◆ PAYPAL_ADDRESS_ID

const PAYPAL_ADDRESS_ID = 'paypal_address_id'

Paypal address id code key

Definition at line 204 of file Info.php.

◆ PAYPAL_ADDRESS_STATUS

const PAYPAL_ADDRESS_STATUS = 'paypal_address_status'

Paypal address status code key

Definition at line 209 of file Info.php.

◆ PAYPAL_AVS_CODE

const PAYPAL_AVS_CODE = 'paypal_avs_code'

Paypal avs code key

Definition at line 229 of file Info.php.

◆ PAYPAL_AVSADDR

const PAYPAL_AVSADDR = 'avsaddr'

Paypal avs street code key

Definition at line 244 of file Info.php.

◆ PAYPAL_AVSZIP

const PAYPAL_AVSZIP = 'avszip'

Paypal avs zip code key

Definition at line 249 of file Info.php.

◆ PAYPAL_CORRELATION_ID

const PAYPAL_CORRELATION_ID = 'paypal_correlation_id'

Paypal correlation id code key

Definition at line 224 of file Info.php.

◆ PAYPAL_CVV2MATCH

const PAYPAL_CVV2MATCH = 'cvv2match'

Paypal cvv2 code key

Definition at line 259 of file Info.php.

◆ PAYPAL_CVV_2_MATCH

const PAYPAL_CVV_2_MATCH = 'paypal_cvv_2_match'

Paypal cvv2 code key

Definition at line 234 of file Info.php.

◆ PAYPAL_FRAUD_FILTERS

const PAYPAL_FRAUD_FILTERS = 'paypal_fraud_filters'

Paypal fraud filters code key

Definition at line 219 of file Info.php.

◆ PAYPAL_IAVS

const PAYPAL_IAVS = 'iavs'

Paypal avs international code key

Definition at line 254 of file Info.php.

◆ PAYPAL_PAYER_EMAIL

const PAYPAL_PAYER_EMAIL = 'paypal_payer_email'

Paypal payer email code key

Definition at line 194 of file Info.php.

◆ PAYPAL_PAYER_ID

const PAYPAL_PAYER_ID = 'paypal_payer_id'

Paypal payer id code key

Definition at line 189 of file Info.php.

◆ PAYPAL_PAYER_STATUS

const PAYPAL_PAYER_STATUS = 'paypal_payer_status'

Paypal payer status code key

Definition at line 199 of file Info.php.

◆ PAYPAL_PROTECTION_ELIGIBILITY

const PAYPAL_PROTECTION_ELIGIBILITY = 'paypal_protection_eligibility'

Paypal protection eligibility code key

Definition at line 214 of file Info.php.

◆ PENDING_REASON

const PENDING_REASON = 'pending_reason'

Definition at line 58 of file Info.php.

◆ PENDING_REASON_GLOBAL

const PENDING_REASON_GLOBAL = 'paypal_pending_reason'

Definition at line 64 of file Info.php.

◆ PROTECTION_EL

const PROTECTION_EL = 'protection_eligibility'

Definition at line 33 of file Info.php.

◆ TXN_TYPE_ADJUSTMENT

const TXN_TYPE_ADJUSTMENT = 'adjustment'

PayPal payment transaction type

Definition at line 146 of file Info.php.

◆ TXN_TYPE_NEW_CASE

const TXN_TYPE_NEW_CASE = 'new_case'

Definition at line 148 of file Info.php.

The documentation for this class was generated from the following file:

vendor/magento/module-paypal/Model/Info.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _getAvsLabel()

◆ _getBuyerIdTypeValue()

◆ _getCvv2Label()

◆ _getFullInfo()

◆ _getLabel()

◆ _getValue()

◆ explainPendingReason()

◆ explainReasonCode()

◆ exportFromPayment()

◆ getCaseTypeLabel()

◆ getPaymentInfo()

◆ getPublicPaymentInfo()

◆ importToPayment()

◆ isFraudReviewAllowed()

◆ isPaymentCompleted()

◆ isPaymentFailed()

◆ isPaymentReviewRequired()

◆ isPaymentSuccessful()

◆ isReversalDisputable()

Field Documentation

◆ $_labelCodesCache

◆ $_paymentMap

◆ $_paymentMapFull

◆ $_paymentPublicMap

◆ $_systemMap

◆ ADDRESS_ID

◆ ADDRESS_STATUS

◆ AVS_CODE

◆ AVSADDR

◆ AVSZIP

◆ BUYER_TAX_ID

◆ BUYER_TAX_ID_TYPE

◆ BUYER_TAX_ID_TYPE_CNPJ

◆ BUYER_TAX_ID_TYPE_CPF

◆ CORRELATION_ID

◆ CVV2MATCH

◆ CVV_2_MATCH

◆ FRAUD_FILTERS

◆ IAVS

◆ IS_FRAUD

◆ IS_FRAUD_GLOBAL

◆ ITEM_LABELS

◆ ORDER_STATUS_CANCELED_REVERSAL

◆ ORDER_STATUS_REVERSED

◆ PAYER_EMAIL

◆ PAYER_ID

◆ PAYER_STATUS

◆ PAYMENT_REASON_CODE_REFUND

◆ PAYMENT_STATUS

◆ PAYMENT_STATUS_GLOBAL

◆ PAYMENTSTATUS_COMPLETED

◆ PAYMENTSTATUS_DENIED

◆ PAYMENTSTATUS_EXPIRED

◆ PAYMENTSTATUS_FAILED

◆ PAYMENTSTATUS_INPROGRESS

◆ PAYMENTSTATUS_NONE

◆ PAYMENTSTATUS_PENDING

◆ PAYMENTSTATUS_PROCESSED

◆ PAYMENTSTATUS_REFUNDED

◆ PAYMENTSTATUS_REFUNDEDPART

◆ PAYMENTSTATUS_REVERSED

◆ PAYMENTSTATUS_REVIEW

◆ PAYMENTSTATUS_UNREVERSED

◆ PAYMENTSTATUS_VOIDED

◆ PAYPAL_ADDRESS_ID

◆ PAYPAL_ADDRESS_STATUS

◆ PAYPAL_AVS_CODE

◆ PAYPAL_AVSADDR

◆ PAYPAL_AVSZIP

◆ PAYPAL_CORRELATION_ID

◆ PAYPAL_CVV2MATCH

◆ PAYPAL_CVV_2_MATCH

◆ PAYPAL_FRAUD_FILTERS