Class RefundDetail

Class RefundDetail

Invoicing refund information.

PayPal\Common\PayPalModel

Extended by

PayPal\Api\RefundDetail

Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/RefundDetail.php

Methods summary

`public`	# `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. Valid Values: ["PAYPAL", "EXTERNAL"] 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. Valid Values: ["PAYPAL", "EXTERNAL"] Parameters `$type` Returns $this
`public string`	# `getType( )` 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. 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. Returns string
`public`	# `setTransactionId( string $transaction_id )` The PayPal refund transaction ID. Required with the `PAYPAL` refund type. The PayPal refund transaction ID. Required with the `PAYPAL` refund type. Parameters `$transaction_id` Returns $this
`public string`	# `getTransactionId( )` The PayPal refund transaction ID. Required with the `PAYPAL` refund type. The PayPal refund transaction ID. Required with the `PAYPAL` refund type. Returns string
`public`	# `setDate( string $date )` Date on which the invoice was refunded. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST. Date on which the invoice was refunded. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST. Parameters `$date` Returns $this
`public string`	# `getDate( )` Date on which the invoice was refunded. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST. Date on which the invoice was refunded. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST. Returns string
`public`	# `setNote( string $note )` Optional note associated with the refund. Optional note associated with the refund. Parameters `$note` Returns $this
`public string`	# `getNote( )` Optional note associated with the refund. Optional note associated with the refund. Returns string
`public`	# `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. Amount to be recorded as refund against invoice. If this field is not passed, the total invoice paid amount is recorded as refund. Parameters `$amount` Returns $this
`public PayPal\Api\Currency`	# `getAmount( )` Amount to be recorded as refund against invoice. If this field is not passed, the total invoice paid amount is recorded as refund. Amount to be recorded as refund against invoice. If this field is not passed, the total invoice paid amount is recorded as refund. Returns `PayPal\Api\Currency`

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