Overview
  • Namespace
  • Class

Namespaces

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

Classes

  • Address
  • Agreement
  • AgreementDetails
  • AgreementStateDescriptor
  • AgreementTransaction
  • AgreementTransactions
  • AlternatePayment
  • Amount
  • Authorization
  • BankAccount
  • BankAccountsList
  • BankToken
  • BaseAddress
  • Billing
  • BillingAgreementToken
  • BillingInfo
  • CancelNotification
  • Capture
  • CarrierAccount
  • CarrierAccountToken
  • CartBase
  • ChargeModel
  • Cost
  • CountryCode
  • CreateProfileResponse
  • Credit
  • CreditCard
  • CreditCardHistory
  • CreditCardList
  • CreditCardToken
  • CreditFinancingOffered
  • Currency
  • CurrencyConversion
  • CustomAmount
  • DetailedRefund
  • Details
  • Error
  • ErrorDetails
  • ExtendedBankAccount
  • ExternalFunding
  • FileAttachment
  • FlowConfig
  • FmfDetails
  • FundingDetail
  • FundingInstrument
  • FundingOption
  • FundingSource
  • FuturePayment
  • HyperSchema
  • Image
  • Incentive
  • InputFields
  • InstallmentInfo
  • InstallmentOption
  • Invoice
  • InvoiceAddress
  • InvoiceItem
  • InvoiceNumber
  • InvoiceSearchResponse
  • Item
  • ItemList
  • Links
  • Measurement
  • MerchantInfo
  • MerchantPreferences
  • Metadata
  • NameValuePair
  • Notification
  • OpenIdAddress
  • OpenIdError
  • OpenIdSession
  • OpenIdTokeninfo
  • OpenIdUserinfo
  • Order
  • OverrideChargeModel
  • Participant
  • Patch
  • PatchRequest
  • Payee
  • Payer
  • PayerInfo
  • Payment
  • PaymentCard
  • PaymentCardToken
  • PaymentDefinition
  • PaymentDetail
  • PaymentExecution
  • PaymentHistory
  • PaymentInstruction
  • PaymentOptions
  • PaymentSummary
  • PaymentTerm
  • Payout
  • PayoutBatch
  • PayoutBatchHeader
  • PayoutItem
  • PayoutItemDetails
  • PayoutSenderBatchHeader
  • Phone
  • Plan
  • PlanList
  • PotentialPayerInfo
  • Presentation
  • PrivateLabelCard
  • ProcessorResponse
  • RecipientBankingInstruction
  • RedirectUrls
  • Refund
  • RefundDetail
  • RefundRequest
  • RelatedResources
  • Sale
  • Search
  • ShippingAddress
  • ShippingCost
  • ShippingInfo
  • Tax
  • Template
  • TemplateData
  • Templates
  • TemplateSettings
  • TemplateSettingsMetadata
  • Terms
  • Transaction
  • TransactionBase
  • Transactions
  • VerifyWebhookSignature
  • VerifyWebhookSignatureResponse
  • Webhook
  • WebhookEvent
  • WebhookEventList
  • WebhookEventType
  • WebhookEventTypeList
  • WebhookList
  • WebProfile

Class Details

Class Details

Additional details of the payment amount.

PayPal\Common\PayPalModel
Extended by PayPal\Api\Details
Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/Details.php

Methods summary

public
# setSubtotal( string|float $subtotal )

Amount of the subtotal of the items. Required if line items are specified. 10 characters max, with support for 2 decimal places.

Amount of the subtotal of the items. Required if line items are specified. 10 characters max, with support for 2 decimal places.

Parameters

$subtotal

Returns


$this
public string
# getSubtotal( )

Amount of the subtotal of the items. Required if line items are specified. 10 characters max, with support for 2 decimal places.

Amount of the subtotal of the items. Required if line items are specified. 10 characters max, with support for 2 decimal places.

Returns

string
public
# setShipping( string|float $shipping )

Amount charged for shipping. 10 characters max with support for 2 decimal places.

Amount charged for shipping. 10 characters max with support for 2 decimal places.

Parameters

$shipping

Returns


$this
public string
# getShipping( )

Amount charged for shipping. 10 characters max with support for 2 decimal places.

Amount charged for shipping. 10 characters max with support for 2 decimal places.

Returns

string
public
# setTax( string|float $tax )

Amount charged for tax. 10 characters max with support for 2 decimal places.

Amount charged for tax. 10 characters max with support for 2 decimal places.

Parameters

$tax

Returns


$this
public string
# getTax( )

Amount charged for tax. 10 characters max with support for 2 decimal places.

Amount charged for tax. 10 characters max with support for 2 decimal places.

Returns

string
public
# setHandlingFee( string|float $handling_fee )

Amount being charged for the handling fee. Only supported when the payment_method is set to paypal.

Amount being charged for the handling fee. Only supported when the payment_method is set to paypal.

Parameters

$handling_fee

Returns


$this
public string
# getHandlingFee( )

Amount being charged for the handling fee. Only supported when the payment_method is set to paypal.

Amount being charged for the handling fee. Only supported when the payment_method is set to paypal.

Returns

string
public
# setShippingDiscount( string|float $shipping_discount )

Amount being discounted for the shipping fee. Only supported when the payment_method is set to paypal.

Amount being discounted for the shipping fee. Only supported when the payment_method is set to paypal.

Parameters

$shipping_discount

Returns


$this
public string
# getShippingDiscount( )

Amount being discounted for the shipping fee. Only supported when the payment_method is set to paypal.

Amount being discounted for the shipping fee. Only supported when the payment_method is set to paypal.

Returns

string
public
# setInsurance( string|float $insurance )

Amount being charged for the insurance fee. Only supported when the payment_method is set to paypal.

Amount being charged for the insurance fee. Only supported when the payment_method is set to paypal.

Parameters

$insurance

Returns


$this
public string
# getInsurance( )

Amount being charged for the insurance fee. Only supported when the payment_method is set to paypal.

Amount being charged for the insurance fee. Only supported when the payment_method is set to paypal.

Returns

string
public
# setGiftWrap( string|float $gift_wrap )

Amount being charged as gift wrap fee.

Amount being charged as gift wrap fee.

Parameters

$gift_wrap

Returns


$this
public string
# getGiftWrap( )

Amount being charged as gift wrap fee.

Amount being charged as gift wrap fee.

Returns

string
public
# setFee( string|float $fee )

Fee charged by PayPal. In case of a refund, this is the fee amount refunded to the original receipient of the payment.

Fee charged by PayPal. In case of a refund, this is the fee amount refunded to the original receipient of the payment.

Parameters

$fee

Returns


$this
public string
# getFee( )

Fee charged by PayPal. In case of a refund, this is the fee amount refunded to the original receipient of the payment.

Fee charged by PayPal. In case of a refund, this is the fee amount refunded to the original receipient of the payment.

Returns

string

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel

$credential

API documentation generated by ApiGen