Class Refund

A refund transaction.

PayPal\Common\PayPalModel

PayPal\Common\PayPalResourceModel implements PayPal\Rest\IResource

PayPal\Api\Refund

Direct known subclasses

PayPal\Api\DetailedRefund

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

Methods summary

`public`	# `setId( string $id )` ID of the refund transaction. 17 characters max. ID of the refund transaction. 17 characters max. Parameters `$id` Returns $this
`public string`	# `getId( )` ID of the refund transaction. 17 characters max. ID of the refund transaction. 17 characters max. Returns string
`public`	# `setAmount( PayPal\Api\Amount $amount )` Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max. Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max. Parameters `$amount` Returns $this
`public PayPal\Api\Amount`	# `getAmount( )` Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max. Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max. Returns `PayPal\Api\Amount`
`public`	# `setState( string $state )` State of the refund. Valid Values: ["pending", "completed", "failed"] State of the refund. Valid Values: ["pending", "completed", "failed"] Parameters `$state` Returns $this
`public string`	# `getState( )` State of the refund. State of the refund. Returns string
`public`	# `setReason( string $reason )` Reason description for the Sale transaction being refunded. Reason description for the Sale transaction being refunded. Parameters `$reason` Returns $this
`public string`	# `getReason( )` Reason description for the Sale transaction being refunded. Reason description for the Sale transaction being refunded. Returns string
`public`	# `setInvoiceNumber( string $invoice_number )` Your own invoice or tracking ID number. Character length and limitations: 127 single-byte alphanumeric characters. Your own invoice or tracking ID number. Character length and limitations: 127 single-byte alphanumeric characters. Parameters `$invoice_number` Returns $this
`public string`	# `getInvoiceNumber( )` Your own invoice or tracking ID number. Character length and limitations: 127 single-byte alphanumeric characters. Your own invoice or tracking ID number. Character length and limitations: 127 single-byte alphanumeric characters. Returns string
`public`	# `setSaleId( string $sale_id )` ID of the Sale transaction being refunded. ID of the Sale transaction being refunded. Parameters `$sale_id` Returns $this
`public string`	# `getSaleId( )` ID of the Sale transaction being refunded. ID of the Sale transaction being refunded. Returns string
`public`	# `setCaptureId( string $capture_id )` ID of the sale transaction being refunded. ID of the sale transaction being refunded. Parameters `$capture_id` Returns $this
`public string`	# `getCaptureId( )` ID of the sale transaction being refunded. ID of the sale transaction being refunded. Returns string
`public`	# `setParentPayment( string $parent_payment )` ID of the payment resource on which this transaction is based. ID of the payment resource on which this transaction is based. Parameters `$parent_payment` Returns $this
`public string`	# `getParentPayment( )` ID of the payment resource on which this transaction is based. ID of the payment resource on which this transaction is based. Returns string
`public`	# `setDescription( string $description )` Description of what is being refunded for. Description of what is being refunded for. Parameters `$description` Returns $this
`public string`	# `getDescription( )` Description of what is being refunded for. Description of what is being refunded for. Returns string
`public`	# `setCreateTime( string $create_time )` Time of refund as defined in RFC 3339 Section 5.6. Time of refund as defined in RFC 3339 Section 5.6. Parameters `$create_time` Returns $this
`public string`	# `getCreateTime( )` Time of refund as defined in RFC 3339 Section 5.6. Time of refund as defined in RFC 3339 Section 5.6. Returns string
`public`	# `setUpdateTime( string $update_time )` Time that the resource was last updated. Time that the resource was last updated. Parameters `$update_time` Returns $this
`public string`	# `getUpdateTime( )` Time that the resource was last updated. Time that the resource was last updated. Returns string
`public`	# `setReasonCode( string $reason_code )` The reason code for the refund state being pending Valid Values: ["ECHECK"] The reason code for the refund state being pending Valid Values: ["ECHECK"] Parameters `$reason_code` Returns $this
`public string`	# `getReasonCode( )` The reason code for the refund state being pending The reason code for the refund state being pending Returns string
`public static PayPal\Api\Refund`	# `get( string $refundId, PayPal\Rest\ApiContext $apiContext = null, PayPalRestCall $restCall = null )` Shows details for a refund, by ID. Shows details for a refund, by ID. Parameters `$refundId` `$apiContext` is the APIContext for this call. It can be used to pass dynamic configuration and credentials. `$restCall` is the Rest Call Service that is used to make rest calls Returns `PayPal\Api\Refund`

Methods inherited from PayPal\Common\PayPalResourceModel

addLink(), executeCall(), getLink(), getLinks(), removeLink(), setLinks(), updateAccessToken()

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 Refund

Direct 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

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Methods inherited from PayPal\Common\PayPalResourceModel

Methods inherited from PayPal\Common\PayPalModel

Properties summary

Properties inherited from PayPal\Common\PayPalModel