Orbipay.PaymentsApi.Client.Wrappers.Refund Class Reference

Inheritance diagram for Orbipay.PaymentsApi.Client.Wrappers.Refund:

Public Member Functions
string	GetRefundReference ()
	The unique identifier in the client system for the refund. More...
string	GetId ()
	The unique identifier assigned by EBPP to the refund. More...
string	GetUrl ()
	This URL fetches the details of refund. More...
string	GetRefundType ()
	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. More...
string	GetRefundAmount ()
	The refund amount upto 2 decimal places. More...
FeeRefund	GetFeeRefund ()
	Gets FeeRefund More...
string	GetStatus ()
	The status of the refund. More...
string	GetConfirmationNumber ()
	The confirmation number or reference provided to the customer for the refund. More...
string	GetRefundDate ()
	The date on which the refund is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
string	GetRefundEntryDate ()
	The date on which the refund captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
string	GetExpectedRefundSettlementDate ()
	The date by which the credits would be posted to the original funding account. ISO8601 full-date format, YYYY-MM-DD More...
Dictionary< string, string >	GetCustomFields ()
	The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. More...
string	GetComments ()
	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. More...
SourcePayment	GetSourcePayment ()
	Gets SourcePayment More...
PaymentNetworkResponse	GetPaymentNetworkResponse ()
	Gets PaymentNetworkResponse More...
AuditInfo	GetAuditInfo ()
	Gets AuditInfo More...
string	GetID_PAYMENT ()
	The unique identifier assigned by EBPP to the payment. More...
string	GetID_CUSTOMER ()
	The unique identifier assigned by EBPP to the customer. More...
string	GetID_REFUND ()
	The unique identifier assigned by EBPP to the refund. More...
	Refund (string iDREFUND=null)
Refund	ForClient (string clientKey)
Refund	VideChannel (string channel)
Refund	WithDetails (string refundAmount)
Refund	WithReference (string refundReference)
Refund	WithMemo (string comments)
Refund	WithStatus (string status)
Refund	ForCustomer (string iDCUSTOMER)
Refund	ForPayment (string iDPAYMENT)
Refund	WithCustomFields (Dictionary< string, string > customFields)
Refund	WithFeeRefund (FeeRefund feeRefund)
Refund	CreatedBy (string requestor, string requestorType)
	CreatedBy Method. More...
Refund	RetrievedBy (string requestor, string requestorType)
	RetrievedBy Method. More...
Refund	Create (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
	Create Method. More...
Refund	Get (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
	Get Method. More...
IEnumerator< Refund >	GetEnumerator ()
Public Member Functions inherited from Orbipay.PaymentsApi.Client.Wrappers.Base
String	GetLiveMode ()
string	GetApiEndPoint ()
void	SetLiveMode (String LiveMode=default(String))
void	SetHttpStatusCode (int httpStatusCode)
InvocationContext	GetInvocationContext ()
int	GetHttpStatusCode ()
void	SetInvocationContext (InvocationContext invocationContext)
void	Dispose ()

Public Attributes
string	RefundReference
	The unique identifier in the client system for the refund. More...
string	Id
	The unique identifier assigned by EBPP to the refund. More...
string	Url
	This URL fetches the details of refund. More...
string	RefundType
	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. More...
string	RefundAmount
	The refund amount upto 2 decimal places. More...
FeeRefund	FeeRefund
	FeeRefund More...
string	Status
	The status of the refund. More...
string	ConfirmationNumber
	The confirmation number or reference provided to the customer for the refund. More...
string	RefundDate
	The date on which the refund is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
string	RefundEntryDate
	The date on which the refund captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
string	ExpectedRefundSettlementDate
	The date by which the credits would be posted to the original funding account. ISO8601 full-date format, YYYY-MM-DD More...
Dictionary< string, string >	CustomFields
	The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. More...
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. More...
SourcePayment	SourcePayment
	SourcePayment More...
PaymentNetworkResponse	PaymentNetworkResponse
	PaymentNetworkResponse More...
AuditInfo	AuditInfo
	AuditInfo More...
string	ID_PAYMENT
	The unique identifier assigned by EBPP to the payment. More...
string	ID_CUSTOMER
	The unique identifier assigned by EBPP to the customer. More...
string	ID_REFUND
	The unique identifier assigned by EBPP to the refund. More...
Public Attributes inherited from Orbipay.PaymentsApi.Client.Wrappers.Base
int	HttpStatusCode

Additional Inherited Members
Protected Member Functions inherited from Orbipay.PaymentsApi.Client.Wrappers.Base
Base	VideChannel (string channel)
Base	RequestedBy (string requestor, string requestorType)
Base	ForClient (string clientKey)
Base	SetAPIEndpoint (String LiveMode=null, String apiEndPoint=null)
Base	WithContext (InvocationContext request, String LiveMode=default(String), String apiEndPoint=null)

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Wrappers.Refund.Refund

(

string

iDREFUND = null

)

Refund Constructor.

Parameters

ID_REFUND

The ID_REFUND is of type string

Member Function Documentation

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.Create	(	InvocationContext	invocation_context,
		string	live_mode = null,
		string	api_end_point = null
	)

Create Method.

Parameters

invocationContext	The invocationContext is of type InvocationContext
liveMode	The liveMode is of type String

Exceptions

OrbipayApiException

The only Exception that is thrown in Exceptional case

Returns

Refund

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.CreatedBy	(	string	requestor,
		string	requestorType
	)

CreatedBy Method.

Parameters

Requestor	The Requestor is of type string
RequestorType	The RequestorType is of type string

Returns

Refund

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.ForClient

(

string

clientKey

)

ForClient Method.

Parameters

ClientKey

The ClientKey is of type string

Returns

Refund

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.ForCustomer

(

string

iDCUSTOMER

)

ForCustomer Method.

Parameters

ID_CUSTOMER

The ID_CUSTOMER is of type string

Returns

Refund

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.ForPayment

(

string

iDPAYMENT

)

ForPayment Method.

Parameters

ID_PAYMENT

The ID_PAYMENT is of type string

Returns

Refund

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.Get	(	InvocationContext	invocation_context,
		string	live_mode = null,
		string	api_end_point = null
	)

Get Method.

Parameters

invocationContext	The invocationContext is of type InvocationContext
liveMode	The liveMode is of type String

Exceptions

OrbipayApiException

The only Exception that is thrown in Exceptional case

Returns

Refund

AuditInfo Orbipay.PaymentsApi.Client.Wrappers.Refund.GetAuditInfo

(

)

Gets AuditInfo

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetComments

(

)

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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetConfirmationNumber

(

)

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

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

Dictionary<string, string> Orbipay.PaymentsApi.Client.Wrappers.Refund.GetCustomFields

(

)

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields.

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields.

IEnumerator<Refund> Orbipay.PaymentsApi.Client.Wrappers.Refund.GetEnumerator

(

)

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetExpectedRefundSettlementDate

(

)

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

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

FeeRefund Orbipay.PaymentsApi.Client.Wrappers.Refund.GetFeeRefund

(

)

Gets FeeRefund

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetId

(

)

The unique identifier assigned by EBPP to the refund.

The unique identifier assigned by EBPP to the refund.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetID_CUSTOMER

(

)

The unique identifier assigned by EBPP to the customer.

The unique identifier assigned by EBPP to the customer.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetID_PAYMENT

(

)

The unique identifier assigned by EBPP to the payment.

The unique identifier assigned by EBPP to the payment.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetID_REFUND

(

)

The unique identifier assigned by EBPP to the refund.

The unique identifier assigned by EBPP to the refund.

PaymentNetworkResponse Orbipay.PaymentsApi.Client.Wrappers.Refund.GetPaymentNetworkResponse

(

)

Gets PaymentNetworkResponse

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetRefundAmount

(

)

The refund amount upto 2 decimal places.

The refund amount upto 2 decimal places.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetRefundDate

(

)

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

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

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetRefundEntryDate

(

)

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

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

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetRefundReference

(

)

The unique identifier in the client system for the refund.

The unique identifier in the client system for the refund.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetRefundType

(

)

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.

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.

SourcePayment Orbipay.PaymentsApi.Client.Wrappers.Refund.GetSourcePayment

(

)

Gets SourcePayment

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetStatus

(

)

The status of the refund.

The status of the refund.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.GetUrl

(

)

This URL fetches the details of refund.

This URL fetches the details of refund.

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.RetrievedBy	(	string	requestor,
		string	requestorType
	)

RetrievedBy Method.

Parameters

Requestor	The Requestor is of type string
RequestorType	The RequestorType is of type string

Returns

Refund

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.VideChannel

(

string

channel

)

VideChannel Method.

Parameters

Channel

The Channel is of type string

Returns

Refund

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.WithCustomFields

(

Dictionary< string, string >

customFields

)

WithCustomFields Method.

Parameters

CustomFields

The CustomFields is of type Dictionary<string, string>

Returns

Refund

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.WithDetails

(

string

refundAmount

)

WithDetails Method.

Parameters

RefundAmount

The RefundAmount is of type string

Returns

Refund

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.WithFeeRefund

(

FeeRefund

feeRefund

)

WithFeeRefund Method.

Parameters

FeeRefund

The FeeRefund is of type FeeRefund

Returns

Refund

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.WithMemo

(

string

comments

)

WithMemo Method.

Parameters

Comments

The Comments is of type string

Returns

Refund

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.WithReference

(

string

refundReference

)

WithReference Method.

Parameters

RefundReference

The RefundReference is of type string

Returns

Refund

Refund Orbipay.PaymentsApi.Client.Wrappers.Refund.WithStatus

(

string

status

)

WithStatus Method.

Parameters

Status

The Status is of type string

Returns

Refund

Member Data Documentation

AuditInfo Orbipay.PaymentsApi.Client.Wrappers.Refund.AuditInfo

AuditInfo

string Orbipay.PaymentsApi.Client.Wrappers.Refund.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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.ConfirmationNumber

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

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

Dictionary<string, string> Orbipay.PaymentsApi.Client.Wrappers.Refund.CustomFields

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields.

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.ExpectedRefundSettlementDate

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

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

FeeRefund Orbipay.PaymentsApi.Client.Wrappers.Refund.FeeRefund

FeeRefund

string Orbipay.PaymentsApi.Client.Wrappers.Refund.Id

The unique identifier assigned by EBPP to the refund.

The unique identifier assigned by EBPP to the refund.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.ID_CUSTOMER

The unique identifier assigned by EBPP to the customer.

The unique identifier assigned by EBPP to the customer.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.ID_PAYMENT

The unique identifier assigned by EBPP to the payment.

The unique identifier assigned by EBPP to the payment.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.ID_REFUND

The unique identifier assigned by EBPP to the refund.

The unique identifier assigned by EBPP to the refund.

PaymentNetworkResponse Orbipay.PaymentsApi.Client.Wrappers.Refund.PaymentNetworkResponse

PaymentNetworkResponse

string Orbipay.PaymentsApi.Client.Wrappers.Refund.RefundAmount

The refund amount upto 2 decimal places.

The refund amount upto 2 decimal places.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.RefundDate

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

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

string Orbipay.PaymentsApi.Client.Wrappers.Refund.RefundEntryDate

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

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

string Orbipay.PaymentsApi.Client.Wrappers.Refund.RefundReference

The unique identifier in the client system for the refund.

The unique identifier in the client system for the refund.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.RefundType

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.

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.

SourcePayment Orbipay.PaymentsApi.Client.Wrappers.Refund.SourcePayment

SourcePayment

string Orbipay.PaymentsApi.Client.Wrappers.Refund.Status

The status of the refund.

The status of the refund.

string Orbipay.PaymentsApi.Client.Wrappers.Refund.Url

This URL fetches the details of refund.

This URL fetches the details of refund.

---

The documentation for this class was generated from the following file:

• src/Orbipay.PaymentsApi.Client/Wrappers/Refund.cs