Documentation

RefundResponse implements ModelInterface, ArrayAccess

Warning:

This class subject to change without prior notice, Please dont use this class directly.

Tags
category

Class

Interfaces, Classes and Traits

ModelInterface
Warning:
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
REFUND_TYPE_FEE_ONLY  = 'fee_only'
REFUND_TYPE_OTHER  = 'other'
REFUND_TYPE_PAYMENT_AND_FEE  = 'payment_and_fee'
REFUND_TYPE_PAYMENT_ONLY  = 'payment_only'
STATUS_CANCELLED  = 'cancelled'
STATUS_DECLINED  = 'declined'
STATUS_DISPUTED  = 'disputed'
STATUS_ERROR  = 'error'
STATUS_PROCESSED  = 'processed'
STATUS_PROCESSING  = 'processing'
STATUS_RETURNED  = 'returned'
STATUS_SCHEDULED  = 'scheduled'
$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
getAuditInfo()  : AuditInfoVo
Gets audit_info
getComments()  : string
Gets comments
getConfirmationNumber()  : string
Gets confirmation_number
getCustomFields()  : mixed
Gets custom_fields
getExpectedRefundSettlementDate()  : string
Gets expected_refund_settlement_date
getFeeRefund()  : FeeRefundResponse
Gets fee_refund
getId()  : string
Gets id
getModelName()  : string
The original name of the model.
getPaymentNetworkResponse()  : PaymentNetworkResponseVo
Gets payment_network_response
getRefundAmount()  : string
Gets refund_amount
getRefundDate()  : string
Gets refund_date
getRefundEntryDate()  : string
Gets refund_entry_date
getRefundReference()  : string
Gets refund_reference
getRefundType()  : string
Gets refund_type
getRefundTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSourcePayment()  : SourcePayment
Gets source_payment
getStatus()  : string
Gets status
getStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUrl()  : string
Gets url
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAuditInfo()  : $this
Sets audit_info
setComments()  : $this
Sets comments
setConfirmationNumber()  : $this
Sets confirmation_number
setCustomFields()  : $this
Sets custom_fields
setExpectedRefundSettlementDate()  : $this
Sets expected_refund_settlement_date
setFeeRefund()  : $this
Sets fee_refund
setId()  : $this
Sets id
setPaymentNetworkResponse()  : $this
Sets payment_network_response
setRefundAmount()  : $this
Sets refund_amount
setRefundDate()  : $this
Sets refund_date
setRefundEntryDate()  : $this
Sets refund_entry_date
setRefundReference()  : $this
Sets refund_reference
setRefundType()  : $this
Sets refund_type
setSourcePayment()  : $this
Sets source_payment
setStatus()  : $this
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUrl()  : $this
Sets url
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

REFUND_TYPE_FEE_ONLY

public mixed REFUND_TYPE_FEE_ONLY = 'fee_only'

REFUND_TYPE_PAYMENT_AND_FEE

public mixed REFUND_TYPE_PAYMENT_AND_FEE = 'payment_and_fee'

REFUND_TYPE_PAYMENT_ONLY

public mixed REFUND_TYPE_PAYMENT_ONLY = 'payment_only'

STATUS_PROCESSING

public mixed STATUS_PROCESSING = 'processing'

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', 'id' => 'id', 'url' => 'url', 'refund_type' => 'refund_type', 'refund_amount' => 'refund_amount', 'fee_refund' => 'fee_refund', 'status' => 'status', 'confirmation_number' => 'confirmation_number', 'refund_date' => 'refund_date', 'refund_entry_date' => 'refund_entry_date', 'expected_refund_settlement_date' => 'expected_refund_settlement_date', 'custom_fields' => 'custom_fields', 'comments' => 'comments', 'source_payment' => 'source_payment', 'payment_network_response' => 'payment_network_response', 'audit_info' => 'audit_info']

$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', 'id' => 'getId', 'url' => 'getUrl', 'refund_type' => 'getRefundType', 'refund_amount' => 'getRefundAmount', 'fee_refund' => 'getFeeRefund', 'status' => 'getStatus', 'confirmation_number' => 'getConfirmationNumber', 'refund_date' => 'getRefundDate', 'refund_entry_date' => 'getRefundEntryDate', 'expected_refund_settlement_date' => 'getExpectedRefundSettlementDate', 'custom_fields' => 'getCustomFields', 'comments' => 'getComments', 'source_payment' => 'getSourcePayment', 'payment_network_response' => 'getPaymentNetworkResponse', 'audit_info' => 'getAuditInfo']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['refund_reference' => 'setRefundReference', 'id' => 'setId', 'url' => 'setUrl', 'refund_type' => 'setRefundType', 'refund_amount' => 'setRefundAmount', 'fee_refund' => 'setFeeRefund', 'status' => 'setStatus', 'confirmation_number' => 'setConfirmationNumber', 'refund_date' => 'setRefundDate', 'refund_entry_date' => 'setRefundEntryDate', 'expected_refund_settlement_date' => 'setExpectedRefundSettlementDate', 'custom_fields' => 'setCustomFields', 'comments' => 'setComments', 'source_payment' => 'setSourcePayment', 'payment_network_response' => 'setPaymentNetworkResponse', 'audit_info' => 'setAuditInfo']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['refund_reference' => null, 'id' => null, 'url' => null, 'refund_type' => null, 'refund_amount' => null, 'fee_refund' => null, 'status' => null, 'confirmation_number' => null, 'refund_date' => null, 'refund_entry_date' => null, 'expected_refund_settlement_date' => null, 'custom_fields' => null, 'comments' => null, 'source_payment' => null, 'payment_network_response' => null, 'audit_info' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'RefundResponse'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['refund_reference' => 'string', 'id' => 'string', 'url' => 'string', 'refund_type' => 'string', 'refund_amount' => 'string', 'fee_refund' => '\Orbipay\PaymentsApi\Client\Model\FeeRefundResponse', 'status' => 'string', 'confirmation_number' => 'string', 'refund_date' => 'string', 'refund_entry_date' => 'string', 'expected_refund_settlement_date' => 'string', 'custom_fields' => 'map[string,string]', 'comments' => 'string', 'source_payment' => '\Orbipay\PaymentsApi\Client\Model\SourcePayment', 'payment_network_response' => '\Orbipay\PaymentsApi\Client\Model\PaymentNetworkResponseVo', 'audit_info' => '\Orbipay\PaymentsApi\Client\Model\AuditInfoVo']

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

getConfirmationNumber()

Gets confirmation_number

public getConfirmationNumber() : string
Return values
string

getCustomFields()

Gets custom_fields

public getCustomFields() : mixed
Return values
mixed

getExpectedRefundSettlementDate()

Gets expected_refund_settlement_date

public getExpectedRefundSettlementDate() : string
Return values
string

getId()

Gets id

public getId() : string
Return values
string

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getRefundAmount()

Gets refund_amount

public getRefundAmount() : string
Return values
string

getRefundDate()

Gets refund_date

public getRefundDate() : string
Return values
string

getRefundEntryDate()

Gets refund_entry_date

public getRefundEntryDate() : string
Return values
string

getRefundReference()

Gets refund_reference

public getRefundReference() : string
Return values
string

getRefundType()

Gets refund_type

public getRefundType() : string
Return values
string

getRefundTypeAllowableValues()

Gets allowable values of the enum

public getRefundTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

getStatus()

Gets status

public getStatus() : string
Return values
string

getStatusAllowableValues()

Gets allowable values of the enum

public getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, 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>

getUrl()

Gets url

public getUrl() : string
Return values
string

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. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

Return values
$this

setConfirmationNumber()

Sets confirmation_number

public setConfirmationNumber(string $confirmation_number) : $this
Parameters
$confirmation_number : string

The confirmation number or reference provided to the customer for the refund.

Return values
$this

setCustomFields()

Sets custom_fields

public setCustomFields(mixed $custom_fields) : $this
Parameters
$custom_fields : mixed
Return values
$this

setExpectedRefundSettlementDate()

Sets expected_refund_settlement_date

public setExpectedRefundSettlementDate(string $expected_refund_settlement_date) : $this
Parameters
$expected_refund_settlement_date : string

The date by which the credits would be posted to the original funding account. ISO8601 full-date format, YYYY-MM-DD

Return values
$this

setId()

Sets id

public setId(string $id) : $this
Parameters
$id : string

The unique identifier assigned by EBPP to the 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

setRefundDate()

Sets refund_date

public setRefundDate(string $refund_date) : $this
Parameters
$refund_date : string

The date on which the refund is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Return values
$this

setRefundEntryDate()

Sets refund_entry_date

public setRefundEntryDate(string $refund_entry_date) : $this
Parameters
$refund_entry_date : string

The date on which the refund captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

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

setRefundType()

Sets refund_type

public setRefundType(string $refund_type) : $this
Parameters
$refund_type : string

The portion of the payment amount that is to be or has been refunded. The original payment can be refunded fully including the amount and the fee components, or partially, for just the amount or the fee component. Refund can also be initiated for an arbitrary amount limited by the original payment amount.

Return values
$this

setStatus()

Sets status

public setStatus(string $status) : $this
Parameters
$status : string

The status of 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>

setUrl()

Sets url

public setUrl(string $url) : $this
Parameters
$url : string

This URL fetches the details of refund.

Return values
$this

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>
Return values
array<string|int, mixed>

Search results