Overview

Namespaces

  • mcfedr
    • Paypal
      • Exceptions
      • Notifications
      • Products
  • PHP

Classes

  • AdaptivePaymentNotification
  • CartChangeNotification
  • CartNotification
  • MasspayNotification
  • MasspayNotifications
  • Notification
  • PaymentNotification
  • SubscriptionNotification
  • Overview
  • Namespace
  • Class
  • Tree

Class AdaptivePaymentNotification

Describes a notification

mcfedr\Paypal\Notifications\Notification
Extended by mcfedr\Paypal\Notifications\PaymentNotification
Extended by mcfedr\Paypal\Notifications\AdaptivePaymentNotification
Namespace: mcfedr\Paypal\Notifications
Located at mcfedr/Paypal/Notifications/AdaptivePaymentNotification.php
Methods summary
public
# __construct( mixed $vars )

Overrides

mcfedr\Paypal\Notifications\PaymentNotification::__construct()
protected boolean
# isBusinessCorrect( mcfedr\Paypal\Authentication $authentication )

Check that the notification matches the expected business

Check that the notification matches the expected business

Parameters

$authentication
mcfedr\Paypal\Authentication
$authentication

Returns

boolean

Throws

mcfedr\Paypal\Exceptions\NotificationBusinessInvalidException

Overrides

mcfedr\Paypal\Notifications\Notification::isBusinessCorrect()
protected boolean
# isCurrencyCorrect( mcfedr\Paypal\Settings $settings )

Check the correct currency was used

Check the correct currency was used

Parameters

$settings
mcfedr\Paypal\Settings
$settings

Returns

boolean

Throws

NotificationCurrencyInvalidException

Overrides

mcfedr\Paypal\Notifications\Notification::isCurrencyCorrect()
Methods inherited from mcfedr\Paypal\Notifications\Notification
isOK()
Constants inherited from mcfedr\Paypal\Notifications\Notification
ADAPTIVE, CART, MASSPAY, MASSPAYS, REFUND, SUBSCRIPTION, TXT_ADAPTIVE_ADJUSTMENT, TXT_ADAPTIVE_CREATE, TXT_CART, TXT_MASSPAY, TXT_SUBSCRIPTION_CANCEL, TXT_SUBSCRIPTION_EXPIRE, TXT_SUBSCRIPTION_FAILED, TXT_SUBSCRIPTION_MODIFY, TXT_SUBSCRIPTION_PAYMENT, TXT_SUBSCRIPTION_START, TXT_WEB_ACCEPT
Properties summary
public string $status
#

Status of Payment

Status of Payment

public string $actionType
#

Whether the Pay API is used with or without the SetPaymentOptions and ExecutePayment API operations. Possible values are: PAY – If you are not using the SetPaymentOptions and ExecutePayment API operations CREATE – If you are using the SetPaymentOptions and ExecutePayment API operations

Whether the Pay API is used with or without the SetPaymentOptions and ExecutePayment API operations. Possible values are: PAY – If you are not using the SetPaymentOptions and ExecutePayment API operations CREATE – If you are using the SetPaymentOptions and ExecutePayment API operations

public boolean $reverseAllParallelPaymentsOnError
#

Whether the payment request specified to reverse parallel payments if an error occurs. Possible values are: true – Each parallel payment is reversed if an error occurs false – Only incomplete payments are reversed (default)

Whether the payment request specified to reverse parallel payments if an error occurs. Possible values are: true – Each parallel payment is reversed if an error occurs false – Only incomplete payments are reversed (default)

public string $payKey
#

The pay key that identifies this payment. This is a token that is assigned by the Pay API after a PayRequest message is received and can be used in other Adaptive Payments APIs as well as the cancelURL and returnURL to identify this payment. The pay key is valid for 3 hours.

The pay key that identifies this payment. This is a token that is assigned by the Pay API after a PayRequest message is received and can be used in other Adaptive Payments APIs as well as the cancelURL and returnURL to identify this payment. The pay key is valid for 3 hours.

public string $feesPayer
#

The payer of PayPal fees. Possible values are: SENDER – Sender pays all fees (for personal, implicit simple/parallel payments; do not use for chained or unilateral payments) PRIMARYRECEIVER – Primary receiver pays all fees (chained payments only) EACHRECEIVER – Each receiver pays their own fee (default, personal and unilateral payments) SECONDARYONLY – Secondary receivers pay all fees (use only for chained payments with one secondary receiver)

The payer of PayPal fees. Possible values are: SENDER – Sender pays all fees (for personal, implicit simple/parallel payments; do not use for chained or unilateral payments) PRIMARYRECEIVER – Primary receiver pays all fees (chained payments only) EACHRECEIVER – Each receiver pays their own fee (default, personal and unilateral payments) SECONDARYONLY – Secondary receivers pay all fees (use only for chained payments with one secondary receiver)

public string $preapprovalKey
#

The preapproval key returned after a PreapprovalRequest, or the preapproval key that identifies the preapproval key sent with a PayRequest.

The preapproval key returned after a PreapprovalRequest, or the preapproval key that identifies the preapproval key sent with a PayRequest.

public string $reasonCode
#

Whether this transaction is a chargeback, partial, or reversal. Possible values are: Chargeback Settlement – Transaction is a chargeback Admin reversal – Transaction was reversed by PayPal administrators Refund – Transaction was partially or fully refunded

Whether this transaction is a chargeback, partial, or reversal. Possible values are: Chargeback Settlement – Transaction is a chargeback Admin reversal – Transaction was reversed by PayPal administrators Refund – Transaction was partially or fully refunded

public string $trackingId
#

The tracking ID that was specified for this payment in the PaymentDetailsRequest message.

The tracking ID that was specified for this payment in the PaymentDetailsRequest message.

Properties inherited from mcfedr\Paypal\Notifications\PaymentNotification
$buyer, $note, $pendingReason
Properties inherited from mcfedr\Paypal\Notifications\Notification
$amount, $business, $currency, $custom, $date, $fee, $invoiceId, $parentTransactionId, $resent, $sandbox, $total, $transactionId, $transactionType, $type
Paypal API documentation generated by ApiGen 2.8.0