Overview
  • Namespace
  • Class

Namespaces

  • PayPal
    • Api
    • Auth
    • Cache
    • Common
    • Converter
    • Core
    • Exception
    • Handler
    • Log
    • Rest
    • Security
    • Transport
    • Validation

Classes

  • PayPal\Api\Address
  • PayPal\Api\Agreement
  • PayPal\Api\AgreementDetails
  • PayPal\Api\AgreementStateDescriptor
  • PayPal\Api\AgreementTransaction
  • PayPal\Api\AgreementTransactions
  • PayPal\Api\AlternatePayment
  • PayPal\Api\Amount
  • PayPal\Api\Authorization
  • PayPal\Api\BankAccount
  • PayPal\Api\BankAccountsList
  • PayPal\Api\BankToken
  • PayPal\Api\BaseAddress
  • PayPal\Api\Billing
  • PayPal\Api\BillingAgreementToken
  • PayPal\Api\BillingInfo
  • PayPal\Api\CancelNotification
  • PayPal\Api\Capture
  • PayPal\Api\CarrierAccount
  • PayPal\Api\CarrierAccountToken
  • PayPal\Api\CartBase
  • PayPal\Api\ChargeModel
  • PayPal\Api\Cost
  • PayPal\Api\CountryCode
  • PayPal\Api\CreateProfileResponse
  • PayPal\Api\Credit
  • PayPal\Api\CreditCard
  • PayPal\Api\CreditCardHistory
  • PayPal\Api\CreditCardList
  • PayPal\Api\CreditCardToken
  • PayPal\Api\CreditFinancingOffered
  • PayPal\Api\Currency
  • PayPal\Api\CurrencyConversion
  • PayPal\Api\CustomAmount
  • PayPal\Api\DetailedRefund
  • PayPal\Api\Details
  • PayPal\Api\Error
  • PayPal\Api\ErrorDetails
  • PayPal\Api\ExtendedBankAccount
  • PayPal\Api\ExternalFunding
  • PayPal\Api\FileAttachment
  • PayPal\Api\FlowConfig
  • PayPal\Api\FmfDetails
  • PayPal\Api\FundingDetail
  • PayPal\Api\FundingInstrument
  • PayPal\Api\FundingOption
  • PayPal\Api\FundingSource
  • PayPal\Api\FuturePayment
  • PayPal\Api\HyperSchema
  • PayPal\Api\Image
  • PayPal\Api\Incentive
  • PayPal\Api\InputFields
  • PayPal\Api\InstallmentInfo
  • PayPal\Api\InstallmentOption
  • PayPal\Api\Invoice
  • PayPal\Api\InvoiceAddress
  • PayPal\Api\InvoiceItem
  • PayPal\Api\InvoiceNumber
  • PayPal\Api\InvoiceSearchResponse
  • PayPal\Api\Item
  • PayPal\Api\ItemList
  • PayPal\Api\Links
  • PayPal\Api\Measurement
  • PayPal\Api\MerchantInfo
  • PayPal\Api\MerchantPreferences
  • PayPal\Api\Metadata
  • PayPal\Api\NameValuePair
  • PayPal\Api\Notification
  • PayPal\Api\OpenIdAddress
  • PayPal\Api\OpenIdError
  • PayPal\Api\OpenIdSession
  • PayPal\Api\OpenIdTokeninfo
  • PayPal\Api\OpenIdUserinfo
  • PayPal\Api\Order
  • PayPal\Api\OverrideChargeModel
  • PayPal\Api\Participant
  • PayPal\Api\Patch
  • PayPal\Api\PatchRequest
  • PayPal\Api\Payee
  • PayPal\Api\Payer
  • PayPal\Api\PayerInfo
  • PayPal\Api\Payment
  • PayPal\Api\PaymentCard
  • PayPal\Api\PaymentCardToken
  • PayPal\Api\PaymentDefinition
  • PayPal\Api\PaymentDetail
  • PayPal\Api\PaymentExecution
  • PayPal\Api\PaymentHistory
  • PayPal\Api\PaymentInstruction
  • PayPal\Api\PaymentOptions
  • PayPal\Api\PaymentSummary
  • PayPal\Api\PaymentTerm
  • PayPal\Api\Payout
  • PayPal\Api\PayoutBatch
  • PayPal\Api\PayoutBatchHeader
  • PayPal\Api\PayoutItem
  • PayPal\Api\PayoutItemDetails
  • PayPal\Api\PayoutSenderBatchHeader
  • PayPal\Api\Phone
  • PayPal\Api\Plan
  • PayPal\Api\PlanList
  • PayPal\Api\PotentialPayerInfo
  • PayPal\Api\Presentation
  • PayPal\Api\PrivateLabelCard
  • PayPal\Api\ProcessorResponse
  • PayPal\Api\RecipientBankingInstruction
  • PayPal\Api\RedirectUrls
  • PayPal\Api\Refund
  • PayPal\Api\RefundDetail
  • PayPal\Api\RefundRequest
  • PayPal\Api\RelatedResources
  • PayPal\Api\Sale
  • PayPal\Api\Search
  • PayPal\Api\ShippingAddress
  • PayPal\Api\ShippingCost
  • PayPal\Api\ShippingInfo
  • PayPal\Api\Tax
  • PayPal\Api\Template
  • PayPal\Api\TemplateData
  • PayPal\Api\Templates
  • PayPal\Api\TemplateSettings
  • PayPal\Api\TemplateSettingsMetadata
  • PayPal\Api\Terms
  • PayPal\Api\Transaction
  • PayPal\Api\TransactionBase
  • PayPal\Api\Transactions
  • PayPal\Api\VerifyWebhookSignature
  • PayPal\Api\VerifyWebhookSignatureResponse
  • PayPal\Api\Webhook
  • PayPal\Api\WebhookEvent
  • PayPal\Api\WebhookEventList
  • PayPal\Api\WebhookEventType
  • PayPal\Api\WebhookEventTypeList
  • PayPal\Api\WebhookList
  • PayPal\Api\WebProfile
  • PayPal\Auth\OAuthTokenCredential
  • PayPal\Cache\AuthorizationCache
  • PayPal\Common\ArrayUtil
  • PayPal\Common\PayPalModel
  • PayPal\Common\PayPalResourceModel
  • PayPal\Common\PayPalUserAgent
  • PayPal\Common\ReflectionUtil
  • PayPal\Converter\FormatConverter
  • PayPal\Core\PayPalConfigManager
  • PayPal\Core\PayPalConstants
  • PayPal\Core\PayPalCredentialManager
  • PayPal\Core\PayPalHttpConfig
  • PayPal\Core\PayPalHttpConnection
  • PayPal\Core\PayPalLoggingManager
  • PayPal\Handler\OauthHandler
  • PayPal\Handler\RestHandler
  • PayPal\Log\PayPalDefaultLogFactory
  • PayPal\Log\PayPalLogger
  • PayPal\Rest\ApiContext
  • PayPal\Security\Cipher
  • PayPal\Transport\PayPalRestCall
  • PayPal\Validation\ArgumentValidator
  • PayPal\Validation\JsonValidator
  • PayPal\Validation\NumericValidator
  • PayPal\Validation\UrlValidator

Interfaces

  • PayPal\Handler\IPayPalHandler
  • PayPal\Log\PayPalLogFactory
  • PayPal\Rest\IResource

Exceptions

  • PayPal\Exception\PayPalConfigurationException
  • PayPal\Exception\PayPalConnectionException
  • PayPal\Exception\PayPalInvalidCredentialException
  • PayPal\Exception\PayPalMissingCredentialException
  1 <?php
  2 
  3 namespace PayPal\Api;
  4 
  5 use PayPal\Common\PayPalModel;
  6 
  7 /**
  8  * Class AgreementTransaction
  9  *
 10  * A resource representing an agreement_transaction that is returned during a transaction search.
 11  *
 12  * @package PayPal\Api
 13  *
 14  * @property string transaction_id
 15  * @property string status
 16  * @property string transaction_type
 17  * @property \PayPal\Api\Currency amount
 18  * @property \PayPal\Api\Currency fee_amount
 19  * @property \PayPal\Api\Currency net_amount
 20  * @property string payer_email
 21  * @property string payer_name
 22  * @property string time_stamp
 23  * @property string time_zone
 24  */
 25 class AgreementTransaction extends PayPalModel
 26 {
 27     /**
 28      * Id corresponding to this transaction.
 29      *
 30      * @param string $transaction_id
 31      * 
 32      * @return $this
 33      */
 34     public function setTransactionId($transaction_id)
 35     {
 36         $this->transaction_id = $transaction_id;
 37         return $this;
 38     }
 39 
 40     /**
 41      * Id corresponding to this transaction.
 42      *
 43      * @return string
 44      */
 45     public function getTransactionId()
 46     {
 47         return $this->transaction_id;
 48     }
 49 
 50     /**
 51      * State of the subscription at this time.
 52      *
 53      * @param string $status
 54      * 
 55      * @return $this
 56      */
 57     public function setStatus($status)
 58     {
 59         $this->status = $status;
 60         return $this;
 61     }
 62 
 63     /**
 64      * State of the subscription at this time.
 65      *
 66      * @return string
 67      */
 68     public function getStatus()
 69     {
 70         return $this->status;
 71     }
 72 
 73     /**
 74      * Type of transaction, usually Recurring Payment.
 75      *
 76      * @param string $transaction_type
 77      * 
 78      * @return $this
 79      */
 80     public function setTransactionType($transaction_type)
 81     {
 82         $this->transaction_type = $transaction_type;
 83         return $this;
 84     }
 85 
 86     /**
 87      * Type of transaction, usually Recurring Payment.
 88      *
 89      * @return string
 90      */
 91     public function getTransactionType()
 92     {
 93         return $this->transaction_type;
 94     }
 95 
 96     /**
 97      * Amount for this transaction.
 98      *
 99      * @param \PayPal\Api\Currency $amount
100      * 
101      * @return $this
102      */
103     public function setAmount($amount)
104     {
105         $this->amount = $amount;
106         return $this;
107     }
108 
109     /**
110      * Amount for this transaction.
111      *
112      * @return \PayPal\Api\Currency
113      */
114     public function getAmount()
115     {
116         return $this->amount;
117     }
118 
119     /**
120      * Fee amount for this transaction.
121      *
122      * @param \PayPal\Api\Currency $fee_amount
123      * 
124      * @return $this
125      */
126     public function setFeeAmount($fee_amount)
127     {
128         $this->fee_amount = $fee_amount;
129         return $this;
130     }
131 
132     /**
133      * Fee amount for this transaction.
134      *
135      * @return \PayPal\Api\Currency
136      */
137     public function getFeeAmount()
138     {
139         return $this->fee_amount;
140     }
141 
142     /**
143      * Net amount for this transaction.
144      *
145      * @param \PayPal\Api\Currency $net_amount
146      * 
147      * @return $this
148      */
149     public function setNetAmount($net_amount)
150     {
151         $this->net_amount = $net_amount;
152         return $this;
153     }
154 
155     /**
156      * Net amount for this transaction.
157      *
158      * @return \PayPal\Api\Currency
159      */
160     public function getNetAmount()
161     {
162         return $this->net_amount;
163     }
164 
165     /**
166      * Email id of payer.
167      *
168      * @param string $payer_email
169      * 
170      * @return $this
171      */
172     public function setPayerEmail($payer_email)
173     {
174         $this->payer_email = $payer_email;
175         return $this;
176     }
177 
178     /**
179      * Email id of payer.
180      *
181      * @return string
182      */
183     public function getPayerEmail()
184     {
185         return $this->payer_email;
186     }
187 
188     /**
189      * Business name of payer.
190      *
191      * @param string $payer_name
192      * 
193      * @return $this
194      */
195     public function setPayerName($payer_name)
196     {
197         $this->payer_name = $payer_name;
198         return $this;
199     }
200 
201     /**
202      * Business name of payer.
203      *
204      * @return string
205      */
206     public function getPayerName()
207     {
208         return $this->payer_name;
209     }
210 
211     /**
212      * Time at which this transaction happened.
213      *
214      * @param string $time_stamp
215      * 
216      * @return $this
217      */
218     public function setTimeStamp($time_stamp)
219     {
220         $this->time_stamp = $time_stamp;
221         return $this;
222     }
223 
224     /**
225      * Time at which this transaction happened.
226      *
227      * @return string
228      */
229     public function getTimeStamp()
230     {
231         return $this->time_stamp;
232     }
233 
234     /**
235      * Time zone of time_updated field.
236      *
237      * @param string $time_zone
238      * 
239      * @return $this
240      */
241     public function setTimeZone($time_zone)
242     {
243         $this->time_zone = $time_zone;
244         return $this;
245     }
246 
247     /**
248      * Time zone of time_updated field.
249      *
250      * @return string
251      */
252     public function getTimeZone()
253     {
254         return $this->time_zone;
255     }
256 
257 }
258 
API documentation generated by ApiGen