My Project
 All Classes Namespaces Files Functions Variables Typedefs Properties Pages
Orbipay.PaymentsApi.Client.Api.IRefundApi Interface Reference

More...

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

Public Member Functions

ApiResponse< RefundResponseCreateRefund (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 More...
 
ApiResponse< RefundResponseCreateRefundWithHttpInfo (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 More...
 
ApiResponse< RefundResponseGetRefund (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 More...
 
ApiResponse< RefundResponseGetRefundWithHttpInfo (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 More...
 
ApiResponse< RefundsResponseRetrieveRefunds (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 More...
 
ApiResponse< RefundsResponseRetrieveRefundsWithHttpInfo (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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
- Public Member Functions inherited from Orbipay.PaymentsApi.Client.Client.IApiAccessor
String GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- 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

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

Member Function Documentation

ApiResponse<RefundResponse> Orbipay.PaymentsApi.Client.Api.IRefundApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENTThe unique identifier assigned by EBPP to the payment.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
createRefundRequestJSON containing all the fields required to refund a payment.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse<RefundResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.RefundApi.

System.Threading.Tasks.Task<RefundResponse> Orbipay.PaymentsApi.Client.Api.IRefundApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENTThe unique identifier assigned by EBPP to the payment.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
createRefundRequestJSON containing all the fields required to refund a payment.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of RefundResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RefundApi.

System.Threading.Tasks.Task<ApiResponse<RefundResponse> > Orbipay.PaymentsApi.Client.Api.IRefundApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENTThe unique identifier assigned by EBPP to the payment.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
createRefundRequestJSON containing all the fields required to refund a payment.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of ApiResponse (RefundResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.RefundApi.

ApiResponse<RefundResponse> Orbipay.PaymentsApi.Client.Api.IRefundApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENTThe unique identifier assigned by EBPP to the payment.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
createRefundRequestJSON containing all the fields required to refund a payment.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse of RefundResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RefundApi.

ApiResponse<RefundResponse> Orbipay.PaymentsApi.Client.Api.IRefundApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_REFUNDThe unique identifier assigned by EBPP to the refund.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse<RefundResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.RefundApi.

System.Threading.Tasks.Task<RefundResponse> Orbipay.PaymentsApi.Client.Api.IRefundApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_REFUNDThe unique identifier assigned by EBPP to the refund.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of RefundResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RefundApi.

System.Threading.Tasks.Task<ApiResponse<RefundResponse> > Orbipay.PaymentsApi.Client.Api.IRefundApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_REFUNDThe unique identifier assigned by EBPP to the refund.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of ApiResponse (RefundResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.RefundApi.

ApiResponse<RefundResponse> Orbipay.PaymentsApi.Client.Api.IRefundApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_REFUNDThe unique identifier assigned by EBPP to the refund.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse of RefundResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RefundApi.

ApiResponse<RefundsResponse> Orbipay.PaymentsApi.Client.Api.IRefundApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
idCustomerThe unique identifier assigned by EBPP to the customer. (optional)
confirmationNumberThe confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
statusThe status of the refund. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDateThe date from which refunds, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which refunds, matching the criteria specified, need to be retrieved. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
queryIdquery id of the Retrieve/Search Customers lookup. (optional)
fromIndexTo fetch the next set of objects that start after this object (optional)
toIndexTo fetch the previous set of objects that end at this object (optional)
Returns
ApiResponse<RefundsResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.RefundApi.

System.Threading.Tasks.Task<RefundsResponse> Orbipay.PaymentsApi.Client.Api.IRefundApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
idCustomerThe unique identifier assigned by EBPP to the customer. (optional)
confirmationNumberThe confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
statusThe status of the refund. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDateThe date from which refunds, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which refunds, matching the criteria specified, need to be retrieved. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
queryIdquery id of the Retrieve/Search Customers lookup. (optional)
fromIndexTo fetch the next set of objects that start after this object (optional)
toIndexTo fetch the previous set of objects that end at this object (optional)
Returns
Task of RefundsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RefundApi.

System.Threading.Tasks.Task<ApiResponse<RefundsResponse> > Orbipay.PaymentsApi.Client.Api.IRefundApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
idCustomerThe unique identifier assigned by EBPP to the customer. (optional)
confirmationNumberThe confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
statusThe status of the refund. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDateThe date from which refunds, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which refunds, matching the criteria specified, need to be retrieved. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
queryIdquery id of the Retrieve/Search Customers lookup. (optional)
fromIndexTo fetch the next set of objects that start after this object (optional)
toIndexTo fetch the previous set of objects that end at this object (optional)
Returns
Task of ApiResponse (RefundsResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.RefundApi.

ApiResponse<RefundsResponse> Orbipay.PaymentsApi.Client.Api.IRefundApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
requestorThe identifier for the requestor of the API. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
idCustomerThe unique identifier assigned by EBPP to the customer. (optional)
confirmationNumberThe confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
statusThe status of the refund. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDateThe date from which refunds, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which refunds, matching the criteria specified, need to be retrieved. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
queryIdquery id of the Retrieve/Search Customers lookup. (optional)
fromIndexTo fetch the next set of objects that start after this object (optional)
toIndexTo fetch the previous set of objects that end at this object (optional)
Returns
ApiResponse of RefundsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RefundApi.


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