Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Orbipay.PaymentsApi.Client.Api.RefundApi:

Public Member Functions
	RefundApi (String basePath)
	Initializes a new instance of the RefundApi class. More...

	RefundApi (Orbipay.PaymentsApi.Client.Client.Configuration configuration=null)
	Initializes a new instance of the RefundApi class using Configuration object More...

String	GetBasePath ()
	Gets the base path of the API client. More...

void	SetBasePath (String basePath)
	Sets the base path of the API client. More...

IDictionary< String, String >	DefaultHeader ()
	Gets the default header. More...

void	AddDefaultHeader (string key, string value)
	Add default header. More...

ApiResponse< RefundResponse >	CreateRefund (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, CreateRefundRequest createRefundRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Create Refund This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer. More...

ApiResponse< RefundResponse >	CreateRefundWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, CreateRefundRequest createRefundRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Create Refund This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer. More...

async System.Threading.Tasks.Task < RefundResponse >	CreateRefundAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, CreateRefundRequest createRefundRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Create Refund This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer. More...

async System.Threading.Tasks.Task < ApiResponse< RefundResponse > >	CreateRefundAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, CreateRefundRequest createRefundRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Create Refund This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer. More...

ApiResponse< RefundResponse >	GetRefund (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_REFUND, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Refund The API is used to retrieve the details of a refund by id. More...

ApiResponse< RefundResponse >	GetRefundWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_REFUND, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Refund The API is used to retrieve the details of a refund by id. More...

async System.Threading.Tasks.Task < RefundResponse >	GetRefundAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_REFUND, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Refund The API is used to retrieve the details of a refund by id. More...

async System.Threading.Tasks.Task < ApiResponse< RefundResponse > >	GetRefundAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_REFUND, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Refund The API is used to retrieve the details of a refund by id. More...

ApiResponse< RefundsResponse >	RetrieveRefunds (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string traceId=null, string idCustomer=null, string confirmationNumber=null, List< string > status=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time. More...

ApiResponse< RefundsResponse >	RetrieveRefundsWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string traceId=null, string idCustomer=null, string confirmationNumber=null, List< string > status=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time. More...

async System.Threading.Tasks.Task < RefundsResponse >	RetrieveRefundsAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string traceId=null, string idCustomer=null, string confirmationNumber=null, List< string > status=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time. More...

async System.Threading.Tasks.Task < ApiResponse< RefundsResponse > >	RetrieveRefundsAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string traceId=null, string idCustomer=null, string confirmationNumber=null, List< string > status=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time. More...

Properties
Orbipay.PaymentsApi.Client.Client.Configuration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Orbipay.PaymentsApi.Client.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Properties inherited from Orbipay.PaymentsApi.Client.Client.IApiAccessor
Configuration	Configuration `[get, set]`
	Gets or sets the configuration object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Api.RefundApi.RefundApi ( String basePath )

Initializes a new instance of the RefundApi class.

Returns

Orbipay.PaymentsApi.Client.Api.RefundApi.RefundApi ( Orbipay.PaymentsApi.Client.Client.Configuration configuration = null )

Initializes a new instance of the RefundApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

Member Function Documentation

void Orbipay.PaymentsApi.Client.Api.RefundApi.AddDefaultHeader	(	string	key,
		string	value
	)

Add default header.

Parameters

key	Header field name.
value	Header field value.

Returns

ApiResponse<RefundResponse> Orbipay.PaymentsApi.Client.Api.RefundApi.CreateRefund	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT,
		string	ID_CUSTOMER,
		CreateRefundRequest	createRefundRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Create Refund This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
createRefundRequest	JSON containing all the fields required to refund a payment.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: RefundResponse

Implements Orbipay.PaymentsApi.Client.Api.IRefundApi.

async System.Threading.Tasks.Task<RefundResponse> Orbipay.PaymentsApi.Client.Api.RefundApi.CreateRefundAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT,
		string	ID_CUSTOMER,
		CreateRefundRequest	createRefundRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Create Refund This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
createRefundRequest	JSON containing all the fields required to refund a payment.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of RefundResponse

Implements Orbipay.PaymentsApi.Client.Api.IRefundApi.

async System.Threading.Tasks.Task<ApiResponse<RefundResponse> > Orbipay.PaymentsApi.Client.Api.RefundApi.CreateRefundAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT,
		string	ID_CUSTOMER,
		CreateRefundRequest	createRefundRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Create Refund This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
createRefundRequest	JSON containing all the fields required to refund a payment.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of ApiResponse (RefundResponse)

Implements Orbipay.PaymentsApi.Client.Api.IRefundApi.

ApiResponse< RefundResponse > Orbipay.PaymentsApi.Client.Api.RefundApi.CreateRefundWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT,
		string	ID_CUSTOMER,
		CreateRefundRequest	createRefundRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Create Refund This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
createRefundRequest	JSON containing all the fields required to refund a payment.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: ApiResponse of RefundResponse

Implements Orbipay.PaymentsApi.Client.Api.IRefundApi.

IDictionary<String, String> Orbipay.PaymentsApi.Client.Api.RefundApi.DefaultHeader ( )

Gets the default header.

Returns: Dictionary of HTTP header

String Orbipay.PaymentsApi.Client.Api.RefundApi.GetBasePath ( )

Gets the base path of the API client.

The base path

Implements Orbipay.PaymentsApi.Client.Client.IApiAccessor.

ApiResponse<RefundResponse> Orbipay.PaymentsApi.Client.Api.RefundApi.GetRefund	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_REFUND,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Get Refund The API is used to retrieve the details of a refund by id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_REFUND	The unique identifier assigned by EBPP to the refund.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: RefundResponse

Implements Orbipay.PaymentsApi.Client.Api.IRefundApi.

async System.Threading.Tasks.Task<RefundResponse> Orbipay.PaymentsApi.Client.Api.RefundApi.GetRefundAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_REFUND,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Get Refund The API is used to retrieve the details of a refund by id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_REFUND	The unique identifier assigned by EBPP to the refund.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of RefundResponse

Implements Orbipay.PaymentsApi.Client.Api.IRefundApi.

async System.Threading.Tasks.Task<ApiResponse<RefundResponse> > Orbipay.PaymentsApi.Client.Api.RefundApi.GetRefundAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_REFUND,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Get Refund The API is used to retrieve the details of a refund by id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_REFUND	The unique identifier assigned by EBPP to the refund.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: Task of ApiResponse (RefundResponse)

Implements Orbipay.PaymentsApi.Client.Api.IRefundApi.

ApiResponse< RefundResponse > Orbipay.PaymentsApi.Client.Api.RefundApi.GetRefundWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_REFUND,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Get Refund The API is used to retrieve the details of a refund by id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_REFUND	The unique identifier assigned by EBPP to the refund.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: ApiResponse of RefundResponse

Implements Orbipay.PaymentsApi.Client.Api.IRefundApi.

ApiResponse<RefundsResponse> Orbipay.PaymentsApi.Client.Api.RefundApi.RetrieveRefunds	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	idCustomer = `null`,
		string	confirmationNumber = `null`,
		List< string >	status = `null`,
		string	fromDate = `null`,
		string	toDate = `null`,
		string	pageSize = `null`,
		string	queryId = `null`,
		string	fromIndex = `null`,
		string	toIndex = `null`
	)

Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
confirmationNumber	The confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
status	The status of the refund. This can take multiple values in the format key=value1&key=value2.... (optional)
fromDate	The date from which refunds, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which refunds, matching the criteria specified, need to be retrieved. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
queryId	query id of the Retrieve/Search Customers lookup. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns: RefundsResponse

Implements Orbipay.PaymentsApi.Client.Api.IRefundApi.

async System.Threading.Tasks.Task<RefundsResponse> Orbipay.PaymentsApi.Client.Api.RefundApi.RetrieveRefundsAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	idCustomer = `null`,
		string	confirmationNumber = `null`,
		List< string >	status = `null`,
		string	fromDate = `null`,
		string	toDate = `null`,
		string	pageSize = `null`,
		string	queryId = `null`,
		string	fromIndex = `null`,
		string	toIndex = `null`
	)

Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
confirmationNumber	The confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
status	The status of the refund. This can take multiple values in the format key=value1&key=value2.... (optional)
fromDate	The date from which refunds, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which refunds, matching the criteria specified, need to be retrieved. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
queryId	query id of the Retrieve/Search Customers lookup. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns: Task of RefundsResponse

Implements Orbipay.PaymentsApi.Client.Api.IRefundApi.

async System.Threading.Tasks.Task<ApiResponse<RefundsResponse> > Orbipay.PaymentsApi.Client.Api.RefundApi.RetrieveRefundsAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	idCustomer = `null`,
		string	confirmationNumber = `null`,
		List< string >	status = `null`,
		string	fromDate = `null`,
		string	toDate = `null`,
		string	pageSize = `null`,
		string	queryId = `null`,
		string	fromIndex = `null`,
		string	toIndex = `null`
	)

Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
confirmationNumber	The confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
status	The status of the refund. This can take multiple values in the format key=value1&key=value2.... (optional)
fromDate	The date from which refunds, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which refunds, matching the criteria specified, need to be retrieved. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
queryId	query id of the Retrieve/Search Customers lookup. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns: Task of ApiResponse (RefundsResponse)

Implements Orbipay.PaymentsApi.Client.Api.IRefundApi.

ApiResponse< RefundsResponse > Orbipay.PaymentsApi.Client.Api.RefundApi.RetrieveRefundsWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	idCustomer = `null`,
		string	confirmationNumber = `null`,
		List< string >	status = `null`,
		string	fromDate = `null`,
		string	toDate = `null`,
		string	pageSize = `null`,
		string	queryId = `null`,
		string	fromIndex = `null`,
		string	toIndex = `null`
	)

Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
confirmationNumber	The confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
status	The status of the refund. This can take multiple values in the format key=value1&key=value2.... (optional)
fromDate	The date from which refunds, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which refunds, matching the criteria specified, need to be retrieved. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
queryId	query id of the Retrieve/Search Customers lookup. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns: ApiResponse of RefundsResponse

Implements Orbipay.PaymentsApi.Client.Api.IRefundApi.

void Orbipay.PaymentsApi.Client.Api.RefundApi.SetBasePath ( String basePath )

Sets the base path of the API client.

The base path

Property Documentation

Orbipay.PaymentsApi.Client.Client.Configuration Orbipay.PaymentsApi.Client.Api.RefundApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

Orbipay.PaymentsApi.Client.Client.ExceptionFactory Orbipay.PaymentsApi.Client.Api.RefundApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

src/Orbipay.PaymentsApi.Client/Api/RefundApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation