'string',
'amount_money' => '\SquareConnect\Model\Money',
'app_fee_money' => '\SquareConnect\Model\Money',
'payment_id' => 'string',
'reason' => 'string'
);
/**
* Array of attributes where the key is the local name, and the value is the original name
* @var string[]
*/
static $attributeMap = array(
'idempotency_key' => 'idempotency_key',
'amount_money' => 'amount_money',
'app_fee_money' => 'app_fee_money',
'payment_id' => 'payment_id',
'reason' => 'reason'
);
/**
* Array of attributes to setter functions (for deserialization of responses)
* @var string[]
*/
static $setters = array(
'idempotency_key' => 'setIdempotencyKey',
'amount_money' => 'setAmountMoney',
'app_fee_money' => 'setAppFeeMoney',
'payment_id' => 'setPaymentId',
'reason' => 'setReason'
);
/**
* Array of attributes to getter functions (for serialization of requests)
* @var string[]
*/
static $getters = array(
'idempotency_key' => 'getIdempotencyKey',
'amount_money' => 'getAmountMoney',
'app_fee_money' => 'getAppFeeMoney',
'payment_id' => 'getPaymentId',
'reason' => 'getReason'
);
/**
* $idempotency_key A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](/basics/api101/idempotency).
* @var string
*/
protected $idempotency_key;
/**
* $amount_money The amount of money to refund. Cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is charging the card.
* @var \SquareConnect\Model\Money
*/
protected $amount_money;
/**
* $app_fee_money Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](/payments-api/take-payments-and-collect-fees)
* @var \SquareConnect\Model\Money
*/
protected $app_fee_money;
/**
* $payment_id Unique ID of the payment being refunded.
* @var string
*/
protected $payment_id;
/**
* $reason A description of the reason for the refund.
* @var string
*/
protected $reason;
/**
* Constructor
* @param mixed[] $data Associated array of property value initializing the model
*/
public function __construct(array $data = null)
{
if ($data != null) {
if (isset($data["idempotency_key"])) {
$this->idempotency_key = $data["idempotency_key"];
} else {
$this->idempotency_key = null;
}
if (isset($data["amount_money"])) {
$this->amount_money = $data["amount_money"];
} else {
$this->amount_money = null;
}
if (isset($data["app_fee_money"])) {
$this->app_fee_money = $data["app_fee_money"];
} else {
$this->app_fee_money = null;
}
if (isset($data["payment_id"])) {
$this->payment_id = $data["payment_id"];
} else {
$this->payment_id = null;
}
if (isset($data["reason"])) {
$this->reason = $data["reason"];
} else {
$this->reason = null;
}
}
}
/**
* Gets idempotency_key
* @return string
*/
public function getIdempotencyKey()
{
return $this->idempotency_key;
}
/**
* Sets idempotency_key
* @param string $idempotency_key A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](/basics/api101/idempotency).
* @return $this
*/
public function setIdempotencyKey($idempotency_key)
{
$this->idempotency_key = $idempotency_key;
return $this;
}
/**
* Gets amount_money
* @return \SquareConnect\Model\Money
*/
public function getAmountMoney()
{
return $this->amount_money;
}
/**
* Sets amount_money
* @param \SquareConnect\Model\Money $amount_money The amount of money to refund. Cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is charging the card.
* @return $this
*/
public function setAmountMoney($amount_money)
{
$this->amount_money = $amount_money;
return $this;
}
/**
* Gets app_fee_money
* @return \SquareConnect\Model\Money
*/
public function getAppFeeMoney()
{
return $this->app_fee_money;
}
/**
* Sets app_fee_money
* @param \SquareConnect\Model\Money $app_fee_money Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](/payments-api/take-payments-and-collect-fees)
* @return $this
*/
public function setAppFeeMoney($app_fee_money)
{
$this->app_fee_money = $app_fee_money;
return $this;
}
/**
* Gets payment_id
* @return string
*/
public function getPaymentId()
{
return $this->payment_id;
}
/**
* Sets payment_id
* @param string $payment_id Unique ID of the payment being refunded.
* @return $this
*/
public function setPaymentId($payment_id)
{
$this->payment_id = $payment_id;
return $this;
}
/**
* Gets reason
* @return string
*/
public function getReason()
{
return $this->reason;
}
/**
* Sets reason
* @param string $reason A description of the reason for the refund.
* @return $this
*/
public function setReason($reason)
{
$this->reason = $reason;
return $this;
}
/**
* Returns true if offset exists. False otherwise.
* @param integer $offset Offset
* @return boolean
*/
public function offsetExists($offset)
{
return isset($this->$offset);
}
/**
* Gets offset.
* @param integer $offset Offset
* @return mixed
*/
public function offsetGet($offset)
{
return $this->$offset;
}
/**
* Sets value based on offset.
* @param integer $offset Offset
* @param mixed $value Value to be set
* @return void
*/
public function offsetSet($offset, $value)
{
$this->$offset = $value;
}
/**
* Unsets offset.
* @param integer $offset Offset
* @return void
*/
public function offsetUnset($offset)
{
unset($this->$offset);
}
/**
* Gets the string presentation of the object
* @return string
*/
public function __toString()
{
if (defined('JSON_PRETTY_PRINT')) {
return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
} else {
return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
}
}
}