PHP Class PayPal\Api\RefundDetail

Invoicing refund information.
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 ( ) : 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 méthode

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
Résultat PayPal\Api\Currency

getDate() public méthode

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

getNote() public méthode

Optional note associated with the refund.
public getNote ( ) : string
Résultat string

getTransactionId() public méthode

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

getType() public méthode

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
Résultat string

setAmount() public méthode

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 méthode

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 méthode

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

setTransactionId() public méthode

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

setType() public méthode

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