PHP Class PayPal\Api\RefundRequest

A refund transaction.
Inheritance: extends PayPal\Common\PayPalModel
Afficher le fichier Open project: paypal/rest-api-sdk-php Class Usage Examples

Méthodes publiques

Méthode Description
getAmount ( ) : Amount Details including both refunded amount (to payer) and refunded fee (to payee).
getDescription ( ) : string Description of what is being refunded for. Character length and limitations: 255 single-byte alphanumeric characters.
getInvoiceNumber ( ) : string The invoice number that is used to track this payment. Character length and limitations: 127 single-byte alphanumeric characters.
getReason ( ) : string Reason description for the Sale transaction being refunded.
getRefundAdvice ( ) : boolean Flag to indicate that the buyer was already given store credit for a given transaction.
getRefundSource ( ) : string Type of PayPal funding source (balance or eCheck) that can be used for auto refund.
setAmount ( Amount $amount ) Details including both refunded amount (to payer) and refunded fee (to payee).
setDescription ( string $description ) Description of what is being refunded for. Character length and limitations: 255 single-byte alphanumeric characters.
setInvoiceNumber ( string $invoice_number ) The invoice number that is used to track this payment. Character length and limitations: 127 single-byte alphanumeric characters.
setReason ( string $reason ) Reason description for the Sale transaction being refunded.
setRefundAdvice ( boolean $refund_advice ) Flag to indicate that the buyer was already given store credit for a given transaction.
setRefundSource ( string $refund_source ) Type of PayPal funding source (balance or eCheck) that can be used for auto refund.

Method Details

getAmount() public méthode

Details including both refunded amount (to payer) and refunded fee (to payee).
public getAmount ( ) : Amount
Résultat Amount

getDescription() public méthode

Description of what is being refunded for. Character length and limitations: 255 single-byte alphanumeric characters.
public getDescription ( ) : string
Résultat string

getInvoiceNumber() public méthode

The invoice number that is used to track this payment. Character length and limitations: 127 single-byte alphanumeric characters.
public getInvoiceNumber ( ) : string
Résultat string

getReason() public méthode

Reason description for the Sale transaction being refunded.
public getReason ( ) : string
Résultat string

getRefundAdvice() public méthode

Flag to indicate that the buyer was already given store credit for a given transaction.
public getRefundAdvice ( ) : boolean
Résultat boolean

getRefundSource() public méthode

Type of PayPal funding source (balance or eCheck) that can be used for auto refund.
public getRefundSource ( ) : string
Résultat string

setAmount() public méthode

Details including both refunded amount (to payer) and refunded fee (to payee).
public setAmount ( Amount $amount )
$amount Amount

setDescription() public méthode

Description of what is being refunded for. Character length and limitations: 255 single-byte alphanumeric characters.
public setDescription ( string $description )
$description string

setInvoiceNumber() public méthode

The invoice number that is used to track this payment. Character length and limitations: 127 single-byte alphanumeric characters.
public setInvoiceNumber ( string $invoice_number )
$invoice_number string

setReason() public méthode

Reason description for the Sale transaction being refunded.
public setReason ( string $reason )
$reason string

setRefundAdvice() public méthode

Flag to indicate that the buyer was already given store credit for a given transaction.
public setRefundAdvice ( boolean $refund_advice )
$refund_advice boolean

setRefundSource() public méthode

Valid Values: ["INSTANT_FUNDING_SOURCE", "ECHECK", "UNRESTRICTED"]
public setRefundSource ( string $refund_source )
$refund_source string