CreateRefundRequest
in package
implements
ModelInterface, ArrayAccess
Warning:
This class subject to change without prior notice, Please dont use this class directly.
Tags
Interfaces, Classes and Traits
- ModelInterface
- Warning:
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getComments() : string
- Gets comments
- getCustomFields() : mixed
- Gets custom_fields
- getFeeRefund() : FeeRefundRequest
- Gets fee_refund
- getModelName() : string
- The original name of the model.
- getRefundAmount() : string
- Gets refund_amount
- getRefundReference() : string
- Gets refund_reference
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setComments() : $this
- Sets comments
- setCustomFields() : $this
- Sets custom_fields
- setFeeRefund() : $this
- Sets fee_refund
- setRefundAmount() : $this
- Sets refund_amount
- setRefundReference() : $this
- Sets refund_reference
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['refund_reference' => 'refund_reference', 'refund_amount' => 'refund_amount', 'fee_refund' => 'fee_refund', 'comments' => 'comments', 'custom_fields' => 'custom_fields']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['refund_reference' => 'getRefundReference', 'refund_amount' => 'getRefundAmount', 'fee_refund' => 'getFeeRefund', 'comments' => 'getComments', 'custom_fields' => 'getCustomFields']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['refund_reference' => 'setRefundReference', 'refund_amount' => 'setRefundAmount', 'fee_refund' => 'setFeeRefund', 'comments' => 'setComments', 'custom_fields' => 'setCustomFields']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['refund_reference' => null, 'refund_amount' => null, 'fee_refund' => null, 'comments' => null, 'custom_fields' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'CreateRefundRequest'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['refund_reference' => 'string', 'refund_amount' => 'string', 'fee_refund' => '\Orbipay\PaymentsApi\Client\Model\FeeRefundRequest', 'comments' => 'string', 'custom_fields' => 'map[string,string]']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getComments()
Gets comments
public
getComments() : string
Return values
string —getCustomFields()
Gets custom_fields
public
getCustomFields() : mixed
Return values
mixed —getFeeRefund()
Gets fee_refund
public
getFeeRefund() : FeeRefundRequest
Return values
FeeRefundRequest —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRefundAmount()
Gets refund_amount
public
getRefundAmount() : string
Return values
string —getRefundReference()
Gets refund_reference
public
getRefundReference() : string
Return values
string —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setComments()
Sets comments
public
setComments(string $comments) : $this
Parameters
- $comments : string
-
Comments that can be used to recollect the operation performed on the resource object.
Return values
$this —setCustomFields()
Sets custom_fields
public
setCustomFields(mixed $custom_fields) : $this
Parameters
- $custom_fields : mixed
Return values
$this —setFeeRefund()
Sets fee_refund
public
setFeeRefund(FeeRefundRequest $fee_refund) : $this
Parameters
- $fee_refund : FeeRefundRequest
-
fee_refund
Return values
$this —setRefundAmount()
Sets refund_amount
public
setRefundAmount(string $refund_amount) : $this
Parameters
- $refund_amount : string
-
The refund amount upto 2 decimal places.
Return values
$this —setRefundReference()
Sets refund_reference
public
setRefundReference(string $refund_reference) : $this
Parameters
- $refund_reference : string
-
The unique identifier in the client system for the refund.
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>