Location: PHPKode > scripts > paypal php > mcfedr-paypal-php-e907080/docs/paypal-php/libpaypal/PaypalNotification.html
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class PaypalNotification</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class PaypalNotification</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																			<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Describes a notification</p>
		<p class="notes">
			Located in <a class="field" href="_lib---libpaypal.php.html">/lib/libpaypal.php</a> (line <span class="field">805</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
								</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<img src="../../media/images/Constant.png" alt=" " />
					<a href="#CART" title="details" class="const-name">CART</a> = 					<span class="var-type"> 'cart'</span>

				</div>
								<div class="const-title">
					<img src="../../media/images/Constant.png" alt=" " />
					<a href="#MASSPAY" title="details" class="const-name">MASSPAY</a> = 					<span class="var-type"> 'masspay'</span>

				</div>
								<div class="const-title">
					<img src="../../media/images/Constant.png" alt=" " />
					<a href="#REFUND" title="details" class="const-name">REFUND</a> = 					<span class="var-type"> 'refund'</span>

				</div>
							</div>
		</div>
	</div>

	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																																																																																																																																																																																<div class="var-title">
					<span class="var-type">double</span>
					<a href="#$amount" title="details" class="var-name">$amount</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$business" title="details" class="var-name">$business</a>
				</div>
																<div class="var-title">
					<span class="var-type">bool</span>
					<a href="#$businessCorrect" title="details" class="var-name">$businessCorrect</a>
				</div>
																<div class="var-title">
					<span class="var-type"><a href="../../paypal-php/libpaypal/PaypalBuyer.html">PaypalBuyer</a></span>
					<a href="#$buyer" title="details" class="var-name">$buyer</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$currency" title="details" class="var-name">$currency</a>
				</div>
																<div class="var-title">
					<span class="var-type">bool</span>
					<a href="#$currencyCorrect" title="details" class="var-name">$currencyCorrect</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$custom" title="details" class="var-name">$custom</a>
				</div>
																<div class="var-title">
					<span class="var-type">int</span>
					<a href="#$date" title="details" class="var-name">$date</a>
				</div>
																<div class="var-title">
					<span class="var-type">double</span>
					<a href="#$fee" title="details" class="var-name">$fee</a>
				</div>
																<div class="var-title">
					<span class="var-type">double</span>
					<a href="#$handling" title="details" class="var-name">$handling</a>
				</div>
																<div class="var-title">
					<span class="var-type">int</span>
					<a href="#$invoiceId" title="details" class="var-name">$invoiceId</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$note" title="details" class="var-name">$note</a>
				</div>
																<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$notifications" title="details" class="var-name">$notifications</a>
				</div>
																<div class="var-title">
					<span class="var-type">bool</span>
					<a href="#$ok" title="details" class="var-name">$ok</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$parentTransactionId" title="details" class="var-name">$parentTransactionId</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$pendingReason" title="details" class="var-name">$pendingReason</a>
				</div>
																<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$products" title="details" class="var-name">$products</a>
				</div>
																<div class="var-title">
					<span class="var-type">bool</span>
					<a href="#$resent" title="details" class="var-name">$resent</a>
				</div>
																<div class="var-title">
					<span class="var-type">double</span>
					<a href="#$shipping" title="details" class="var-name">$shipping</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$status" title="details" class="var-name">$status</a>
				</div>
																<div class="var-title">
					<span class="var-type">double</span>
					<a href="#$total" title="details" class="var-name">$total</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$transactionId" title="details" class="var-name">$transactionId</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$transactionType" title="details" class="var-name">$transactionType</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$type" title="details" class="var-name">$type</a>
				</div>
											</div>
		</div>
	</div>


	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<span class="disabled">Vars</span>
						
			
												<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
								</div>
		<div class="info-box-body">
			<a name="var$amount" id="$amount"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">double</span>
			<span class="var-name">$amount</span>
						(line <span class="line-number">866</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The amount paid minus shipping and handling</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$business" id="$business"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$business</span>
						(line <span class="line-number">891</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Who was paid</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$businessCorrect" id="$businessCorrect"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">bool</span>
			<span class="var-name">$businessCorrect</span>
						(line <span class="line-number">896</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Was it the right person paid</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$buyer" id="$buyer"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../../paypal-php/libpaypal/PaypalBuyer.html">PaypalBuyer</a></span>
			<span class="var-name">$buyer</span>
						(line <span class="line-number">958</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Info about buyer</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$currency" id="$currency"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$currency</span>
						(line <span class="line-number">902</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Currency paid in</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$currencyCorrect" id="$currencyCorrect"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">bool</span>
			<span class="var-name">$currencyCorrect</span>
						(line <span class="line-number">908</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is this the currency expected</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$custom" id="$custom"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$custom</span>
						(line <span class="line-number">854</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The custom data you sent</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$date" id="$date"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$date</span>
						(line <span class="line-number">947</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Time the payment was made (unix timestamp)</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$fee" id="$fee"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">double</span>
			<span class="var-name">$fee</span>
						(line <span class="line-number">881</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The paypal fee (you received $amount-$fee)</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$handling" id="$handling"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">double</span>
			<span class="var-name">$handling</span>
						(line <span class="line-number">876</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Amount paid for handling</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$invoiceId" id="$invoiceId"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$invoiceId</span>
						(line <span class="line-number">849</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The invoice id you sent as part of this transaction</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$note" id="$note"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$note</span>
						(line <span class="line-number">886</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Note left by buyer (if you allowed him to leave it)</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$notifications" id="$notifications"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$notifications</span>
						(line <span class="line-number">971</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sub notifications, used by masspay</p>
	<ul class="tags">
				<li><span class="field">var:</span> <a href="../../paypal-php/libpaypal/PaypalNotification.html">PaypalNotification</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$ok" id="$ok"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">bool</span>
			<span class="var-name">$ok</span>
						(line <span class="line-number">810</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The business and currency are correct</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$parentTransactionId" id="$parentTransactionId"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$parentTransactionId</span>
						(line <span class="line-number">844</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The origonal transaction (for refunds)</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$pendingReason" id="$pendingReason"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$pendingReason</span>
						(line <span class="line-number">942</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">If $status == 'Pending' this is why</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$products" id="$products"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$products</span>
						(line <span class="line-number">965</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The product purchased in this transaction</p>
<p class="description"><p>Can be used to check the right amounts where paid and the cart is what you expected</p></p>
	<ul class="tags">
				<li><span class="field">var:</span> <a href="../../paypal-php/libpaypal/PaypalProduct.html">PaypalProduct</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$resent" id="$resent"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">bool</span>
			<span class="var-name">$resent</span>
						(line <span class="line-number">952</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Has this notification been sent before</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$shipping" id="$shipping"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">double</span>
			<span class="var-name">$shipping</span>
						(line <span class="line-number">871</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Amount paid for shipping</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$status" id="$status"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$status</span>
						(line <span class="line-number">937</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Status of payment</p>
<p class="description"><p>The status of the payment:  <strong>Canceled_Reversal:</strong> A reversal has been canceled. For example, you  won a dispute with the customer, and the funds for the transaction  that was reversed have been returned to you.  <strong>Completed:</strong> The payment has been completed,  and the funds have been added successfully to your account balance.  <strong>Created:</strong> A German ELV payment is made using Express Checkout.  <strong>Denied:</strong> You denied the payment.  This happens only if the payment was previously pending because of  possible reasons described for the pending_reason variable  or the Fraud_Management_Filters_x variable.  <strong>Expired:</strong> This authorization has expired and cannot be captured.  <strong>Failed:</strong> The payment has failed.  This happens only if the payment was made from your  customer’s bank account.  <strong>Pending:</strong> The payment is pending. See pending_reason for more information.  <strong>Refunded:</strong> You refunded the payment.  <strong>Reversed:</strong> A payment was reversed due to a chargeback or other type of  reversal. The funds have been removed from your account balance  and returned to the buyer. The reason for the reversal is  specified in the ReasonCode element.  <strong>Processed:</strong> A payment has been accepted.  <strong>Voided:</strong> This authorization has been voided.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$total" id="$total"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">double</span>
			<span class="var-name">$total</span>
						(line <span class="line-number">860</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The total amount paid</p>
<p class="description"><p>You should check this is what you expect it to be</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$transactionId" id="$transactionId"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$transactionId</span>
						(line <span class="line-number">839</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Paypals id for this transaction</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$transactionType" id="$transactionType"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$transactionType</span>
						(line <span class="line-number">834</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Type of transaction (paypal)</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$type" id="$type"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$type</span>
						(line <span class="line-number">816</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Either <a href="../../paypal-php/libpaypal/PaypalNotification.html#constREFUND">PaypalNotification::REFUND</a> or <a href="../../paypal-php/libpaypal/PaypalNotification.html#constCART">PaypalNotification::CART</a></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<span class="disabled">Constants</span>
						
			
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
												</div>
		<div class="info-box-body">
			<a name="constCART" id="CART"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">CART</span>
			 = <span class="const-default"> 'cart'</span>
			(line <span class="line-number">824</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">type for cart notification</p>
	
	
</div>
<a name="constMASSPAY" id="MASSPAY"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">MASSPAY</span>
			 = <span class="const-default"> 'masspay'</span>
			(line <span class="line-number">828</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">type for masspay notification</p>
	
	
</div>
<a name="constREFUND" id="REFUND"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">REFUND</span>
			 = <span class="const-default"> 'refund'</span>
			(line <span class="line-number">820</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">type for refund notification</p>
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Sun, 26 Jun 2011 00:44:57 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>
Return current item: paypal php