PHP Class PayPal\Api\Error

Inheritance: extends PayPal\Common\PPModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
addDetail ( ErrorDetails $errorDetails ) Append Details to the list.
addLink ( PayPal\Api\Links $links ) Append Links to the list.
getCode ( ) : string PayPal internal error code.
getDebugId ( ) : string PayPal internal identifier used for correlation purposes.
getDetails ( ) : ErrorDetails[] Additional details of the error
getFmfDetails ( ) : FmfDetails Fraud filter details. Only supported when the payment_method is set to credit_card
getInformationLink ( ) : string URI for detailed information related to this error for the developer.
getLinks ( ) : PayPal\Api\Links[] Gets Links
getMessage ( ) : string Message describing the error.
getName ( ) : string Human readable, unique name of the error.
getProcessorResponse ( ) : PayPal\Api\ProcessorResponse response codes returned from a payment processor such as avs, cvv, etc. Only supported when the payment_method is set to credit_card.
getPurchaseUnitReferenceId ( ) : string Reference ID of the purchase_unit associated with this error
removeDetail ( ErrorDetails $errorDetails ) Remove Details from the list.
removeLink ( PayPal\Api\Links $links ) Remove Links from the list.
setCode ( string $code ) PayPal internal error code.
setDebugId ( string $debug_id ) PayPal internal identifier used for correlation purposes.
setDetails ( ErrorDetails[] $details ) Additional details of the error
setFmfDetails ( FmfDetails $fmf_details ) Fraud filter details. Only supported when the payment_method is set to credit_card
setInformationLink ( string $information_link ) URI for detailed information related to this error for the developer.
setLinks ( PayPal\Api\Links[] $links ) Sets Links
setMessage ( string $message ) Message describing the error.
setName ( string $name ) Human readable, unique name of the error.
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.
setPurchaseUnitReferenceId ( string $purchase_unit_reference_id ) Reference ID of the purchase_unit associated with this error

Method Details

addDetail() public method

Append Details to the list.
public addDetail ( ErrorDetails $errorDetails )
$errorDetails ErrorDetails

getCode() public method

PayPal internal error code.
Deprecation: Not publicly available
public getCode ( ) : string
return string

getDebugId() public method

PayPal internal identifier used for correlation purposes.
public getDebugId ( ) : string
return string

getDetails() public method

Additional details of the error
public getDetails ( ) : ErrorDetails[]
return ErrorDetails[]

getFmfDetails() public method

Fraud filter details. Only supported when the payment_method is set to credit_card
Deprecation: Not publicly available
public getFmfDetails ( ) : FmfDetails
return FmfDetails

getMessage() public method

Message describing the error.
public getMessage ( ) : string
return string

getName() public method

Human readable, unique name of the error.
public getName ( ) : string
return string

getProcessorResponse() public method

response codes returned from a payment processor such as avs, cvv, etc. Only supported when the payment_method is set to credit_card.
Deprecation: Not publicly available
public getProcessorResponse ( ) : PayPal\Api\ProcessorResponse
return PayPal\Api\ProcessorResponse

getPurchaseUnitReferenceId() public method

Reference ID of the purchase_unit associated with this error
Deprecation: Not publicly available
public getPurchaseUnitReferenceId ( ) : string
return string

removeDetail() public method

Remove Details from the list.
public removeDetail ( ErrorDetails $errorDetails )
$errorDetails ErrorDetails

setCode() public method

PayPal internal error code.
Deprecation: Not publicly available
public setCode ( string $code )
$code string

setDebugId() public method

PayPal internal identifier used for correlation purposes.
public setDebugId ( string $debug_id )
$debug_id string

setDetails() public method

Additional details of the error
public setDetails ( ErrorDetails[] $details )
$details ErrorDetails[]

setFmfDetails() public method

Fraud filter details. Only supported when the payment_method is set to credit_card
Deprecation: Not publicly available
public setFmfDetails ( FmfDetails $fmf_details )
$fmf_details FmfDetails

setMessage() public method

Message describing the error.
public setMessage ( string $message )
$message string

setName() public method

Human readable, unique name of the error.
public setName ( string $name )
$name string

setProcessorResponse() public method

response codes returned from a payment processor such as avs, cvv, etc. Only supported when the payment_method is set to credit_card.
Deprecation: Not publicly available
public setProcessorResponse ( PayPal\Api\ProcessorResponse $processor_response )
$processor_response PayPal\Api\ProcessorResponse

setPurchaseUnitReferenceId() public method

Reference ID of the purchase_unit associated with this error
Deprecation: Not publicly available
public setPurchaseUnitReferenceId ( string $purchase_unit_reference_id )
$purchase_unit_reference_id string