forked from LiveCarta/PayPal-PHP-SDK
9c0827643b
- Updated OpenId classes to be in API namespace - Updated PP Naming Convention to PayPal Naming Convention - FormatConverter Class got its own namespace - Handlers are grouped in Handler namespace - Samples and Tests Updated Accordingly
437 lines
9.1 KiB
PHP
437 lines
9.1 KiB
PHP
<?php
|
|
|
|
namespace PayPal\Api;
|
|
|
|
use PayPal\Common\PayPalModel;
|
|
use PayPal\Rest\ApiContext;
|
|
use PayPal\Rest\IResource;
|
|
use PayPal\Transport\PayPalRestCall;
|
|
use PayPal\Validation\ArgumentValidator;
|
|
|
|
/**
|
|
* Class Refund
|
|
*
|
|
* A refund transaction.
|
|
*
|
|
* @package PayPal\Api
|
|
*
|
|
* @property string id
|
|
* @property string create_time
|
|
* @property string update_time
|
|
* @property \PayPal\Api\Amount amount
|
|
* @property string state
|
|
* @property string sale_id
|
|
* @property string capture_id
|
|
* @property string parent_payment
|
|
* @property string description
|
|
* @property \PayPal\Api\Links links
|
|
*/
|
|
class Refund extends PayPalModel implements IResource
|
|
{
|
|
/**
|
|
* OAuth Credentials to use for this call
|
|
*
|
|
* @var \PayPal\Auth\OAuthTokenCredential $credential
|
|
*/
|
|
protected static $credential;
|
|
|
|
/**
|
|
* Sets Credential
|
|
*
|
|
* @deprecated Pass ApiContext to create/get methods instead
|
|
* @param \PayPal\Auth\OAuthTokenCredential $credential
|
|
*/
|
|
public static function setCredential($credential)
|
|
{
|
|
self::$credential = $credential;
|
|
}
|
|
|
|
/**
|
|
* Identifier of the refund transaction in UTC ISO8601 format.
|
|
*
|
|
*
|
|
* @param string $id
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setId($id)
|
|
{
|
|
$this->id = $id;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Identifier of the refund transaction in UTC ISO8601 format.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getId()
|
|
{
|
|
return $this->id;
|
|
}
|
|
|
|
/**
|
|
* Time the resource was created in UTC ISO8601 format.
|
|
*
|
|
*
|
|
* @param string $create_time
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setCreateTime($create_time)
|
|
{
|
|
$this->create_time = $create_time;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Time the resource was created in UTC ISO8601 format.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getCreateTime()
|
|
{
|
|
return $this->create_time;
|
|
}
|
|
|
|
/**
|
|
* Time the resource was created in UTC ISO8601 format.
|
|
*
|
|
* @deprecated Instead use setCreateTime
|
|
*
|
|
* @param string $create_time
|
|
* @return $this
|
|
*/
|
|
public function setCreate_time($create_time)
|
|
{
|
|
$this->create_time = $create_time;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Time the resource was created in UTC ISO8601 format.
|
|
* @deprecated Instead use getCreateTime
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getCreate_time()
|
|
{
|
|
return $this->create_time;
|
|
}
|
|
|
|
/**
|
|
* Time the resource was last updated in UTC ISO8601 format.
|
|
*
|
|
*
|
|
* @param string $update_time
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setUpdateTime($update_time)
|
|
{
|
|
$this->update_time = $update_time;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Time the resource was last updated in UTC ISO8601 format.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getUpdateTime()
|
|
{
|
|
return $this->update_time;
|
|
}
|
|
|
|
/**
|
|
* Time the resource was last updated in UTC ISO8601 format.
|
|
*
|
|
* @deprecated Instead use setUpdateTime
|
|
*
|
|
* @param string $update_time
|
|
* @return $this
|
|
*/
|
|
public function setUpdate_time($update_time)
|
|
{
|
|
$this->update_time = $update_time;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Time the resource was last updated in UTC ISO8601 format.
|
|
* @deprecated Instead use getUpdateTime
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getUpdate_time()
|
|
{
|
|
return $this->update_time;
|
|
}
|
|
|
|
/**
|
|
* Details including both refunded amount (to Payer) and refunded fee (to Payee).If amount is not specified, it's assumed to be full refund.
|
|
*
|
|
*
|
|
* @param \PayPal\Api\Amount $amount
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setAmount($amount)
|
|
{
|
|
$this->amount = $amount;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Details including both refunded amount (to Payer) and refunded fee (to Payee).If amount is not specified, it's assumed to be full refund.
|
|
*
|
|
* @return \PayPal\Api\Amount
|
|
*/
|
|
public function getAmount()
|
|
{
|
|
return $this->amount;
|
|
}
|
|
|
|
/**
|
|
* State of the refund transaction.
|
|
* Valid Values: ["pending", "completed", "failed"]
|
|
*
|
|
* @param string $state
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setState($state)
|
|
{
|
|
$this->state = $state;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* State of the refund transaction.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getState()
|
|
{
|
|
return $this->state;
|
|
}
|
|
|
|
/**
|
|
* ID of the Sale transaction being refunded.
|
|
*
|
|
*
|
|
* @param string $sale_id
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setSaleId($sale_id)
|
|
{
|
|
$this->sale_id = $sale_id;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* ID of the Sale transaction being refunded.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getSaleId()
|
|
{
|
|
return $this->sale_id;
|
|
}
|
|
|
|
/**
|
|
* ID of the Sale transaction being refunded.
|
|
*
|
|
* @deprecated Instead use setSaleId
|
|
*
|
|
* @param string $sale_id
|
|
* @return $this
|
|
*/
|
|
public function setSale_id($sale_id)
|
|
{
|
|
$this->sale_id = $sale_id;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* ID of the Sale transaction being refunded.
|
|
* @deprecated Instead use getSaleId
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getSale_id()
|
|
{
|
|
return $this->sale_id;
|
|
}
|
|
|
|
/**
|
|
* ID of the Capture transaction being refunded.
|
|
*
|
|
*
|
|
* @param string $capture_id
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setCaptureId($capture_id)
|
|
{
|
|
$this->capture_id = $capture_id;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* ID of the Capture transaction being refunded.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getCaptureId()
|
|
{
|
|
return $this->capture_id;
|
|
}
|
|
|
|
/**
|
|
* ID of the Capture transaction being refunded.
|
|
*
|
|
* @deprecated Instead use setCaptureId
|
|
*
|
|
* @param string $capture_id
|
|
* @return $this
|
|
*/
|
|
public function setCapture_id($capture_id)
|
|
{
|
|
$this->capture_id = $capture_id;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* ID of the Capture transaction being refunded.
|
|
* @deprecated Instead use getCaptureId
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getCapture_id()
|
|
{
|
|
return $this->capture_id;
|
|
}
|
|
|
|
/**
|
|
* ID of the Payment resource that this transaction is based on.
|
|
*
|
|
*
|
|
* @param string $parent_payment
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setParentPayment($parent_payment)
|
|
{
|
|
$this->parent_payment = $parent_payment;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* ID of the Payment resource that this transaction is based on.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getParentPayment()
|
|
{
|
|
return $this->parent_payment;
|
|
}
|
|
|
|
/**
|
|
* ID of the Payment resource that this transaction is based on.
|
|
*
|
|
* @deprecated Instead use setParentPayment
|
|
*
|
|
* @param string $parent_payment
|
|
* @return $this
|
|
*/
|
|
public function setParent_payment($parent_payment)
|
|
{
|
|
$this->parent_payment = $parent_payment;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* ID of the Payment resource that this transaction is based on.
|
|
* @deprecated Instead use getParentPayment
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getParent_payment()
|
|
{
|
|
return $this->parent_payment;
|
|
}
|
|
|
|
/**
|
|
* Description of what is being refunded for.
|
|
*
|
|
*
|
|
* @param string $description
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setDescription($description)
|
|
{
|
|
$this->description = $description;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Description of what is being refunded for.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getDescription()
|
|
{
|
|
return $this->description;
|
|
}
|
|
|
|
/**
|
|
* Sets Links
|
|
*
|
|
*
|
|
* @param \PayPal\Api\Links $links
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setLinks($links)
|
|
{
|
|
$this->links = $links;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets Links
|
|
*
|
|
* @return \PayPal\Api\Links[]
|
|
*/
|
|
public function getLinks()
|
|
{
|
|
return $this->links;
|
|
}
|
|
|
|
/**
|
|
* Obtain the Refund transaction resource for the given identifier.
|
|
*
|
|
* @param string $refundId
|
|
* @param \PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
|
|
* @return Refund
|
|
*/
|
|
public static function get($refundId, $apiContext = null)
|
|
{
|
|
ArgumentValidator::validate($refundId, 'refundId');
|
|
|
|
$payLoad = "";
|
|
if ($apiContext == null) {
|
|
$apiContext = new ApiContext(self::$credential);
|
|
}
|
|
$call = new PayPalRestCall($apiContext);
|
|
$json = $call->execute(array('PayPal\Handler\RestHandler'), "/v1/payments/refund/$refundId", "GET", $payLoad);
|
|
$ret = new Refund();
|
|
$ret->fromJson($json);
|
|
return $ret;
|
|
}
|
|
|
|
}
|