Class CartBase

Base properties of a cart resource

PayPal\Common\PayPalModel

PayPal\Api\CartBase

Direct known subclasses

PayPal\Api\TransactionBase

Indirect known subclasses

PayPal\Api\Transaction

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

Methods summary

`public`	# `setReferenceId( string $reference_id )` Merchant identifier to the purchase unit. Optional parameter Merchant identifier to the purchase unit. Optional parameter Parameters `$reference_id` Returns $this
`public string`	# `getReferenceId( )` Merchant identifier to the purchase unit. Optional parameter Merchant identifier to the purchase unit. Optional parameter Returns string
`public`	# `setAmount( PayPal\Api\Amount $amount )` Amount being collected. Amount being collected. Parameters `$amount` Returns $this
`public PayPal\Api\Amount`	# `getAmount( )` Amount being collected. Amount being collected. Returns `PayPal\Api\Amount`
`public`	# `setPayee( PayPal\Api\Payee $payee )` Recipient of the funds in this transaction. Recipient of the funds in this transaction. Parameters `$payee` Returns $this
`public PayPal\Api\Payee`	# `getPayee( )` Recipient of the funds in this transaction. Recipient of the funds in this transaction. Returns `PayPal\Api\Payee`
`public`	# `setDescription( string $description )` Description of what is being paid for. Description of what is being paid for. Parameters `$description` Returns $this
`public string`	# `getDescription( )` Description of what is being paid for. Description of what is being paid for. Returns string
`public`	# `setNoteToPayee( string $note_to_payee )` Note to the recipient of the funds in this transaction. Note to the recipient of the funds in this transaction. Parameters `$note_to_payee` Returns $this
`public string`	# `getNoteToPayee( )` Note to the recipient of the funds in this transaction. Note to the recipient of the funds in this transaction. Returns string
`public`	# `setCustom( string $custom )` free-form field for the use of clients free-form field for the use of clients Parameters `$custom` Returns $this
`public string`	# `getCustom( )` free-form field for the use of clients free-form field for the use of clients Returns string
`public`	# `setInvoiceNumber( string $invoice_number )` invoice number to track this payment invoice number to track this payment Parameters `$invoice_number` Returns $this
`public string`	# `getInvoiceNumber( )` invoice number to track this payment invoice number to track this payment Returns string
`public`	# `setPurchaseOrder( string $purchase_order )` purchase order is number or id specific to this payment purchase order is number or id specific to this payment Parameters `$purchase_order` Returns $this
`public string`	# `getPurchaseOrder( )` purchase order is number or id specific to this payment purchase order is number or id specific to this payment Returns string
`public`	# `setSoftDescriptor( string $soft_descriptor )` Soft descriptor used when charging this funding source. If length exceeds max length, the value will be truncated Soft descriptor used when charging this funding source. If length exceeds max length, the value will be truncated Parameters `$soft_descriptor` Returns $this
`public string`	# `getSoftDescriptor( )` Soft descriptor used when charging this funding source. If length exceeds max length, the value will be truncated Soft descriptor used when charging this funding source. If length exceeds max length, the value will be truncated Returns string
`public`	# `setSoftDescriptorCity( string $soft_descriptor_city )` Soft descriptor city used when charging this funding source. If length exceeds max length, the value will be truncated. Only supported when the `payment_method` is set to `credit_card` Soft descriptor city used when charging this funding source. If length exceeds max length, the value will be truncated. Only supported when the `payment_method` is set to `credit_card` Deprecated Not publicly available Parameters `$soft_descriptor_city` Returns $this
`public string`	# `getSoftDescriptorCity( )` Soft descriptor city used when charging this funding source. If length exceeds max length, the value will be truncated. Only supported when the `payment_method` is set to `credit_card` Soft descriptor city used when charging this funding source. If length exceeds max length, the value will be truncated. Only supported when the `payment_method` is set to `credit_card` Deprecated Not publicly available Returns string
`public`	# `setPaymentOptions( PayPal\Api\PaymentOptions $payment_options )` Payment options requested for this purchase unit Payment options requested for this purchase unit Parameters `$payment_options` Returns $this
`public PayPal\Api\PaymentOptions`	# `getPaymentOptions( )` Payment options requested for this purchase unit Payment options requested for this purchase unit Returns `PayPal\Api\PaymentOptions`
`public`	# `setItemList( PayPal\Api\ItemList $item_list )` List of items being paid for. List of items being paid for. Parameters `$item_list` Returns $this
`public PayPal\Api\ItemList`	# `getItemList( )` List of items being paid for. List of items being paid for. Returns `PayPal\Api\ItemList`
`public`	# `setNotifyUrl( string $notify_url )` URL to send payment notifications URL to send payment notifications Parameters `$notify_url` Returns $this Throws InvalidArgumentException
`public string`	# `getNotifyUrl( )` URL to send payment notifications URL to send payment notifications Returns string
`public`	# `setOrderUrl( string $order_url )` Url on merchant site pertaining to this payment. Url on merchant site pertaining to this payment. Parameters `$order_url` Returns $this Throws InvalidArgumentException
`public string`	# `getOrderUrl( )` Url on merchant site pertaining to this payment. Url on merchant site pertaining to this payment. Returns string
`public`	# `setExternalFunding( PayPal\Api\ExternalFunding[] $external_funding )` List of external funding being applied to the purchase unit. Each external_funding unit should have a unique reference_id List of external funding being applied to the purchase unit. Each external_funding unit should have a unique reference_id Deprecated Not publicly available Parameters `$external_funding` Returns $this
`public PayPal\Api\ExternalFunding[]`	# `getExternalFunding( )` List of external funding being applied to the purchase unit. Each external_funding unit should have a unique reference_id List of external funding being applied to the purchase unit. Each external_funding unit should have a unique reference_id Deprecated Not publicly available Returns `PayPal\Api\ExternalFunding[]`
`public`	# `addExternalFunding( PayPal\Api\ExternalFunding $externalFunding )` Append ExternalFunding to the list. Append ExternalFunding to the list. Deprecated Not publicly available Parameters `$externalFunding` Returns $this
`public`	# `removeExternalFunding( PayPal\Api\ExternalFunding $externalFunding )` Remove ExternalFunding from the list. Remove ExternalFunding from the list. Deprecated Not publicly available Parameters `$externalFunding` Returns $this

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

$credential

Namespaces

Classes

Class CartBase

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Deprecated

Parameters

Returns

Deprecated

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Deprecated

Parameters

Returns

Deprecated

Returns

Deprecated

Parameters

Returns

Deprecated

Parameters

Returns

Methods inherited from PayPal\Common\PayPalModel

Properties summary

Properties inherited from PayPal\Common\PayPalModel