PHP Class PayPal\Api\Details

Additional details of the payment amount.
Inheritance: extends PayPal\Common\PayPalModel
Mostra file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
getFee ( ) : string Fee charged by PayPal. In case of a refund, this is the fee amount refunded to the original receipient of the payment.
getGiftWrap ( ) : string Amount being charged as gift wrap fee.
getHandlingFee ( ) : string Amount being charged for the handling fee. Only supported when the payment_method is set to paypal.
getInsurance ( ) : string Amount being charged for the insurance fee. Only supported when the payment_method is set to paypal.
getShipping ( ) : string Amount charged for shipping. 10 characters max with support for 2 decimal places.
getShippingDiscount ( ) : string Amount being discounted for the shipping fee. Only supported when the payment_method is set to paypal.
getSubtotal ( ) : string Amount of the subtotal of the items. **Required** if line items are specified. 10 characters max, with support for 2 decimal places.
getTax ( ) : string Amount charged for tax. 10 characters max with support for 2 decimal places.
setFee ( string | double $fee ) Fee charged by PayPal. In case of a refund, this is the fee amount refunded to the original receipient of the payment.
setGiftWrap ( string | double $gift_wrap ) Amount being charged as gift wrap fee.
setHandlingFee ( string | double $handling_fee ) Amount being charged for the handling fee. Only supported when the payment_method is set to paypal.
setInsurance ( string | double $insurance ) Amount being charged for the insurance fee. Only supported when the payment_method is set to paypal.
setShipping ( string | double $shipping ) Amount charged for shipping. 10 characters max with support for 2 decimal places.
setShippingDiscount ( string | double $shipping_discount ) Amount being discounted for the shipping fee. Only supported when the payment_method is set to paypal.
setSubtotal ( string | double $subtotal ) Amount of the subtotal of the items. **Required** if line items are specified. 10 characters max, with support for 2 decimal places.
setTax ( string | double $tax ) Amount charged for tax. 10 characters max with support for 2 decimal places.

Method Details

getFee() public method

Fee charged by PayPal. In case of a refund, this is the fee amount refunded to the original receipient of the payment.
public getFee ( ) : string
return string

getGiftWrap() public method

Amount being charged as gift wrap fee.
public getGiftWrap ( ) : string
return string

getHandlingFee() public method

Amount being charged for the handling fee. Only supported when the payment_method is set to paypal.
public getHandlingFee ( ) : string
return string

getInsurance() public method

Amount being charged for the insurance fee. Only supported when the payment_method is set to paypal.
public getInsurance ( ) : string
return string

getShipping() public method

Amount charged for shipping. 10 characters max with support for 2 decimal places.
public getShipping ( ) : string
return string

getShippingDiscount() public method

Amount being discounted for the shipping fee. Only supported when the payment_method is set to paypal.
public getShippingDiscount ( ) : string
return string

getSubtotal() public method

Amount of the subtotal of the items. **Required** if line items are specified. 10 characters max, with support for 2 decimal places.
public getSubtotal ( ) : string
return string

getTax() public method

Amount charged for tax. 10 characters max with support for 2 decimal places.
public getTax ( ) : string
return string

setFee() public method

Fee charged by PayPal. In case of a refund, this is the fee amount refunded to the original receipient of the payment.
public setFee ( string | double $fee )
$fee string | double

setGiftWrap() public method

Amount being charged as gift wrap fee.
public setGiftWrap ( string | double $gift_wrap )
$gift_wrap string | double

setHandlingFee() public method

Amount being charged for the handling fee. Only supported when the payment_method is set to paypal.
public setHandlingFee ( string | double $handling_fee )
$handling_fee string | double

setInsurance() public method

Amount being charged for the insurance fee. Only supported when the payment_method is set to paypal.
public setInsurance ( string | double $insurance )
$insurance string | double

setShipping() public method

Amount charged for shipping. 10 characters max with support for 2 decimal places.
public setShipping ( string | double $shipping )
$shipping string | double

setShippingDiscount() public method

Amount being discounted for the shipping fee. Only supported when the payment_method is set to paypal.
public setShippingDiscount ( string | double $shipping_discount )
$shipping_discount string | double

setSubtotal() public method

Amount of the subtotal of the items. **Required** if line items are specified. 10 characters max, with support for 2 decimal places.
public setSubtotal ( string | double $subtotal )
$subtotal string | double

setTax() public method

Amount charged for tax. 10 characters max with support for 2 decimal places.
public setTax ( string | double $tax )
$tax string | double