Refund
extends Base
in package
Refund Class Doc Comment
Tags
Table of Contents
- DISCRIMINATOR = null
- $api_end_point : string
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $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
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $audit_info : AuditInfo
- $comments : string
- $confirmation_number : string
- $custom_fields : mixed
- $expected_refund_settlement_date : string
- $fee_refund : FeeRefund
- $http_status_code : mixed
- $id : string
- $id_customer : string
- $id_payment : string
- $id_refund : string
- $invocation_context : InvocationContext
- $live_mode : string
- $payment_network_response : PaymentNetworkResponse
- $refund_amount : string
- $refund_date : string
- $refund_entry_date : string
- $refund_reference : string
- $refund_type : string
- $source_payment : SourcePayment
- $status : string
- $url : string
- __construct() : mixed
- Refund 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
- create() : Refund
- create
- createdBy() : Refund
- createdBy
- forClient() : mixed
- forCustomer() : mixed
- forPayment() : mixed
- get() : Refund
- get
- getApiEndPoint() : string
- getAuditInfo() : AuditInfo
- 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() : FeeRefund
- Gets fee_refund
- getHttpStatusCode() : mixed
- getId() : string
- Gets id
- getIdCustomer() : string
- Gets id_customer
- getIdPayment() : string
- Gets id_payment
- getIdRefund() : string
- Gets id_refund
- getInvocationContext() : InvocationContext
- getPaymentNetworkResponse() : PaymentNetworkResponse
- 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
- getSourcePayment() : SourcePayment
- Gets source_payment
- getStatus() : string
- Gets status
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUrl() : string
- Gets url
- jsonSerialize() : mixed
- Specify data which should be serialized to JSON
- retrievedBy() : Refund
- retrievedBy
- setInvocationContext() : mixed
- 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
- videChannel() : mixed
- withContext() : mixed
- withCustomFields() : mixed
- withDetails() : mixed
- withFeeRefund() : mixed
- withMemo() : mixed
- withReference() : mixed
- withStatus() : mixed
- requestedBy() : mixed
- setAPIEndpoint() : mixed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$api_end_point
protected
string
$api_end_point
$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', 'id_payment' => 'ID_PAYMENT', 'id_customer' => 'ID_CUSTOMER', 'id_refund' => 'ID_REFUND']
$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', 'id_payment' => 'getIdPayment', 'id_customer' => 'getIdCustomer', 'id_refund' => 'getIdRefund']
$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', 'id_payment' => 'setIdPayment', 'id_customer' => 'setIdCustomer', 'id_refund' => 'setIdRefund']
$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, 'id_payment' => null, 'id_customer' => null, 'id_refund' => null]
$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\Wrappers\FeeRefund', '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\Wrappers\SourcePayment', 'payment_network_response' => '\Orbipay\PaymentsApi\Client\Wrappers\PaymentNetworkResponse', 'audit_info' => '\Orbipay\PaymentsApi\Client\Wrappers\AuditInfo', 'id_payment' => 'string', 'id_customer' => 'string', 'id_refund' => 'string']
$audit_info
private
AuditInfo
$audit_info
$comments
private
string
$comments
$confirmation_number
private
string
$confirmation_number
$custom_fields
private
mixed
$custom_fields
$expected_refund_settlement_date
private
string
$expected_refund_settlement_date
$fee_refund
private
FeeRefund
$fee_refund
$http_status_code
private
mixed
$http_status_code
$id
private
string
$id
$id_customer
private
string
$id_customer
$id_payment
private
string
$id_payment
$id_refund
private
string
$id_refund
$invocation_context
private
InvocationContext
$invocation_context
$live_mode
private
string
$live_mode
$payment_network_response
private
PaymentNetworkResponse
$payment_network_response
$refund_amount
private
string
$refund_amount
$refund_date
private
string
$refund_date
$refund_entry_date
private
string
$refund_entry_date
$refund_reference
private
string
$refund_reference
$refund_type
private
string
$refund_type
$source_payment
private
SourcePayment
$source_payment
$status
private
string
$status
$url
private
string
$url
Methods
__construct()
Refund constructor.
public
__construct([string $id_refund = null ]) : mixed
Parameters
- $id_refund : string = null
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> —create()
create
public
create(InvocationContext $invocationContext[, string $liveMode = null ][, string $apiEndPoint = null ]) : Refund
Parameters
- $invocationContext : InvocationContext
- $liveMode : string = null
- $apiEndPoint : string = null
Tags
Return values
Refund —createdBy()
createdBy
public
createdBy([ $requestor = null ][, $requestor_type = null ]) : Refund
Parameters
Return values
Refund —forClient()
public
forClient([mixed $client_key = null ]) : mixed
Parameters
- $client_key : mixed = null
Return values
mixed —forCustomer()
public
forCustomer([mixed $id_customer = null ]) : mixed
Parameters
- $id_customer : mixed = null
Return values
mixed —forPayment()
public
forPayment([mixed $id_payment = null ]) : mixed
Parameters
- $id_payment : mixed = null
Return values
mixed —get()
get
public
get(InvocationContext $invocationContext[, string $liveMode = null ][, string $apiEndPoint = null ]) : Refund
Parameters
- $invocationContext : InvocationContext
- $liveMode : string = null
- $apiEndPoint : string = null
Tags
Return values
Refund —getApiEndPoint()
public
getApiEndPoint() : string
Return values
string —getAuditInfo()
Gets audit_info
public
getAuditInfo() : AuditInfo
Return values
AuditInfo —$audit_info audit_info
getComments()
Gets comments
public
getComments() : string
Return values
string —$comments 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.
getConfirmationNumber()
Gets confirmation_number
public
getConfirmationNumber() : string
Return values
string —$confirmation_number The confirmation number or reference provided to the customer for the refund.
getCustomFields()
Gets custom_fields
public
getCustomFields() : mixed
Return values
mixed —getExpectedRefundSettlementDate()
Gets expected_refund_settlement_date
public
getExpectedRefundSettlementDate() : string
Return values
string —$expected_refund_settlement_date The date by which the credits would be posted to the original funding account. ISO8601 full-date format, YYYY-MM-DD
getFeeRefund()
Gets fee_refund
public
getFeeRefund() : FeeRefund
Return values
FeeRefund —$fee_refund fee_refund
getHttpStatusCode()
public
getHttpStatusCode() : mixed
Return values
mixed —getId()
Gets id
public
getId() : string
Return values
string —$id The unique identifier assigned by EBPP to the refund.
getIdCustomer()
Gets id_customer
public
getIdCustomer() : string
Return values
string —$id_customer The unique identifier assigned by EBPP to the customer.
getIdPayment()
Gets id_payment
public
getIdPayment() : string
Return values
string —$id_payment The unique identifier assigned by EBPP to the payment.
getIdRefund()
Gets id_refund
public
getIdRefund() : string
Return values
string —$id_refund The unique identifier assigned by EBPP to the refund.
getInvocationContext()
public
getInvocationContext() : InvocationContext
Return values
InvocationContext —getPaymentNetworkResponse()
Gets payment_network_response
public
getPaymentNetworkResponse() : PaymentNetworkResponse
Return values
PaymentNetworkResponse —$payment_network_response payment_network_response
getRefundAmount()
Gets refund_amount
public
getRefundAmount() : string
Return values
string —$refund_amount The refund amount upto 2 decimal places.
getRefundDate()
Gets refund_date
public
getRefundDate() : string
Return values
string —$refund_date The date on which the refund is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
getRefundEntryDate()
Gets refund_entry_date
public
getRefundEntryDate() : string
Return values
string —$refund_entry_date The date on which the refund captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
getRefundReference()
Gets refund_reference
public
getRefundReference() : string
Return values
string —$refund_reference The unique identifier in the client system for the refund.
getRefundType()
Gets refund_type
public
getRefundType() : string
Return values
string —$refund_type 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.
getSourcePayment()
Gets source_payment
public
getSourcePayment() : SourcePayment
Return values
SourcePayment —$source_payment source_payment
getStatus()
Gets status
public
getStatus() : string
Return values
string —$status The status of the refund.
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 —$url This URL fetches the details of refund.
jsonSerialize()
Specify data which should be serialized to JSON
public
jsonSerialize() : mixed
Tags
Return values
mixed —data which can be serialized by json_encode, which is a value of any type other than a resource.
retrievedBy()
retrievedBy
public
retrievedBy([ $requestor = null ][, $requestor_type = null ]) : Refund
Parameters
Return values
Refund —setInvocationContext()
public
setInvocationContext([InvocationContext $invocation_context = null ]) : mixed
Parameters
- $invocation_context : InvocationContext = null
Return values
mixed —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>
Return values
array<string|int, mixed> —videChannel()
public
videChannel([mixed $channel = null ]) : mixed
Parameters
- $channel : mixed = null
Return values
mixed —withContext()
public
withContext(InvocationContext $request[, string $live_mode = null ][, string $apiEndPoint = null ]) : mixed
Parameters
- $request : InvocationContext
- $live_mode : string = null
- $apiEndPoint : string = null
Return values
mixed —withCustomFields()
public
withCustomFields([mixed $custom_fields = null ]) : mixed
Parameters
- $custom_fields : mixed = null
Return values
mixed —withDetails()
public
withDetails([mixed $refund_amount = null ]) : mixed
Parameters
- $refund_amount : mixed = null
Return values
mixed —withFeeRefund()
public
withFeeRefund([mixed $fee_refund = null ]) : mixed
Parameters
- $fee_refund : mixed = null
Return values
mixed —withMemo()
public
withMemo([mixed $comments = null ]) : mixed
Parameters
- $comments : mixed = null
Return values
mixed —withReference()
public
withReference([mixed $refund_reference = null ]) : mixed
Parameters
- $refund_reference : mixed = null
Return values
mixed —withStatus()
public
withStatus([mixed $status = null ]) : mixed
Parameters
- $status : mixed = null
Return values
mixed —requestedBy()
protected
requestedBy(mixed $requestor, mixed $requestor_type) : mixed
Parameters
- $requestor : mixed
- $requestor_type : mixed
Return values
mixed —setAPIEndpoint()
protected
setAPIEndpoint([string $live_mode = null ][, string $apiEndPoint = null ]) : mixed
Parameters
- $live_mode : string = null
- $apiEndPoint : string = null