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 Error

Class Error

Details of an Error

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

Methods summary

public
# setName( string $name )

Human readable, unique name of the error.

Human readable, unique name of the error.

Parameters

$name

Returns


$this
public string
# getName( )

Human readable, unique name of the error.

Human readable, unique name of the error.

Returns

string
public
# setPurchaseUnitReferenceId( string $purchase_unit_reference_id )

Reference ID of the purchase_unit associated with this error

Reference ID of the purchase_unit associated with this error

Deprecated

Not publicly available

Parameters

$purchase_unit_reference_id

Returns


$this
public string
# getPurchaseUnitReferenceId( )

Reference ID of the purchase_unit associated with this error

Reference ID of the purchase_unit associated with this error

Deprecated

Not publicly available

Returns

string
public
# setCode( string $code )

PayPal internal error code.

PayPal internal error code.

Deprecated

Not publicly available

Parameters

$code

Returns


$this
public string
# getCode( )

PayPal internal error code.

PayPal internal error code.

Deprecated

Not publicly available

Returns

string
public
# setDebugId( string $debug_id )

PayPal internal identifier used for correlation purposes.

PayPal internal identifier used for correlation purposes.

Parameters

$debug_id

Returns


$this
public string
# getDebugId( )

PayPal internal identifier used for correlation purposes.

PayPal internal identifier used for correlation purposes.

Returns

string
public
# setMessage( string $message )

Message describing the error.

Message describing the error.

Parameters

$message

Returns


$this
public string
# getMessage( )

Message describing the error.

Message describing the error.

Returns

string
public
# setInformationLink( string $information_link )

URI for detailed information related to this error for the developer.

URI for detailed information related to this error for the developer.

Parameters

$information_link

Returns


$this
public string
# getInformationLink( )

URI for detailed information related to this error for the developer.

URI for detailed information related to this error for the developer.

Returns

string
public
# setDetails( PayPal\Api\ErrorDetails[] $details )

Additional details of the error

Additional details of the error

Parameters

$details

Returns


$this
public PayPal\Api\ErrorDetails[]
# getDetails( )

Additional details of the error

Additional details of the error

Returns

PayPal\Api\ErrorDetails[]
public
# addDetail( PayPal\Api\ErrorDetails $errorDetails )

Append Details to the list.

Append Details to the list.

Parameters

$errorDetails

Returns


$this
public
# removeDetail( PayPal\Api\ErrorDetails $errorDetails )

Remove Details from the list.

Remove Details from the list.

Parameters

$errorDetails

Returns


$this
public
# setProcessorResponse( PayPal\Api\ProcessorResponse $processor_response )

response codes returned from a payment processor such as avs, cvv, etc. Only supported when the payment_method is set to credit_card.

response codes returned from a payment processor such as avs, cvv, etc. Only supported when the payment_method is set to credit_card.

Deprecated

Not publicly available

Parameters

$processor_response

Returns


$this
public PayPal\Api\ProcessorResponse
# getProcessorResponse( )

response codes returned from a payment processor such as avs, cvv, etc. Only supported when the payment_method is set to credit_card.

response codes returned from a payment processor such as avs, cvv, etc. Only supported when the payment_method is set to credit_card.

Deprecated

Not publicly available

Returns

PayPal\Api\ProcessorResponse
public
# setFmfDetails( PayPal\Api\FmfDetails $fmf_details )

Fraud filter details. Only supported when the payment_method is set to credit_card

Fraud filter details. Only supported when the payment_method is set to credit_card

Deprecated

Not publicly available

Parameters

$fmf_details

Returns


$this
public PayPal\Api\FmfDetails
# getFmfDetails( )

Fraud filter details. Only supported when the payment_method is set to credit_card

Fraud filter details. Only supported when the payment_method is set to credit_card

Deprecated

Not publicly available

Returns

PayPal\Api\FmfDetails
public
# setLinks( PayPal\Api\Links[] $links )

Sets Links

Sets Links

Parameters

$links

Returns


$this
public PayPal\Api\Links[]
# getLinks( )

Gets Links

Gets Links

Returns

PayPal\Api\Links[]
public
# addLink( PayPal\Api\Links $links )

Append Links to the list.

Append Links to the list.

Parameters

$links

Returns


$this
public
# removeLink( PayPal\Api\Links $links )

Remove Links from the list.

Remove Links from the list.

Parameters

$links

Returns


$this

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