PHP Class PayPal\Api\RefundDetail

Invoicing refund information.
Inheritance: extends PayPal\Common\PayPalModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
getAmount ( ) : PayPal\Api\Currency Amount to be recorded as refund against invoice. If this field is not passed, the total invoice paid amount is recorded as refund.
getDate ( ) : string Date on which the invoice was refunded. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
getNote ( ) : string Optional note associated with the refund.
getTransactionId ( ) : string The PayPal refund transaction ID. Required with the PAYPAL refund type.
getType ( ) : string The PayPal refund type. Indicates whether refund was paid in invoicing flow through PayPal or externally. In the case of mark-as-refunded API, the supported refund type is EXTERNAL. For backward compatability, the PAYPAL refund type is still supported.
setAmount ( PayPal\Api\Currency $amount ) Amount to be recorded as refund against invoice. If this field is not passed, the total invoice paid amount is recorded as refund.
setDate ( string $date ) Date on which the invoice was refunded. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
setNote ( string $note ) Optional note associated with the refund.
setTransactionId ( string $transaction_id ) The PayPal refund transaction ID. Required with the PAYPAL refund type.
setType ( string $type ) The PayPal refund type. Indicates whether refund was paid in invoicing flow through PayPal or externally. In the case of mark-as-refunded API, the supported refund type is EXTERNAL. For backward compatability, the PAYPAL refund type is still supported.

Method Details

getAmount() public method

Amount to be recorded as refund against invoice. If this field is not passed, the total invoice paid amount is recorded as refund.
public getAmount ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

getDate() public method

Date on which the invoice was refunded. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
public getDate ( ) : string
return string

getNote() public method

Optional note associated with the refund.
public getNote ( ) : string
return string

getTransactionId() public method

The PayPal refund transaction ID. Required with the PAYPAL refund type.
public getTransactionId ( ) : string
return string

getType() public method

The PayPal refund type. Indicates whether refund was paid in invoicing flow through PayPal or externally. In the case of mark-as-refunded API, the supported refund type is EXTERNAL. For backward compatability, the PAYPAL refund type is still supported.
public getType ( ) : string
return string

setAmount() public method

Amount to be recorded as refund against invoice. If this field is not passed, the total invoice paid amount is recorded as refund.
public setAmount ( PayPal\Api\Currency $amount )
$amount PayPal\Api\Currency

setDate() public method

Date on which the invoice was refunded. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
public setDate ( string $date )
$date string

setNote() public method

Optional note associated with the refund.
public setNote ( string $note )
$note string

setTransactionId() public method

The PayPal refund transaction ID. Required with the PAYPAL refund type.
public setTransactionId ( string $transaction_id )
$transaction_id string

setType() public method

Valid Values: ["PAYPAL", "EXTERNAL"]
public setType ( string $type )
$type string