Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi Interface Reference

More...

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

Public Member Functions
ApiResponse< Object >	DeleteRecordPayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, DeleteRecordedPaymentRequest deleteRecordedPaymentRequest, string requestor=null, string xOPAYHeaders=null)
	Delete Recorded Payment More...
ApiResponse< Object >	DeleteRecordPaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, DeleteRecordedPaymentRequest deleteRecordedPaymentRequest, string requestor=null, string xOPAYHeaders=null)
	Delete Recorded Payment More...
ApiResponse < GetRecordedPaymentResponse >	GetRecordPayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string requestor=null, string xOPAYHeaders=null)
	Get Recorded Payment More...
ApiResponse < GetRecordedPaymentResponse >	GetRecordPaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string requestor=null, string xOPAYHeaders=null)
	Get Recorded Payment More...
ApiResponse < RecordedPaymentResponse >	RecordPayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, RecordPaymentRequest recordPaymentRequest, string requestor=null, string xOPAYHeaders=null)
	Record Payment More...
ApiResponse < RecordedPaymentResponse >	RecordPaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, RecordPaymentRequest recordPaymentRequest, string requestor=null, string xOPAYHeaders=null)
	Record Payment More...
ApiResponse < RecordedPaymentsResponse >	RetrieveRecordPayments (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string idCustomer, string requestor=null, string xOPAYHeaders=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > paymentMethod=null, List< string > status=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Recorded Payments More...
ApiResponse < RecordedPaymentsResponse >	RetrieveRecordPaymentsWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string idCustomer, string requestor=null, string xOPAYHeaders=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > paymentMethod=null, List< string > status=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Recorded Payments More...
System.Threading.Tasks.Task	DeleteRecordPaymentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, DeleteRecordedPaymentRequest deleteRecordedPaymentRequest, string requestor=null, string xOPAYHeaders=null)
	Delete Recorded Payment More...
System.Threading.Tasks.Task < ApiResponse< Object > >	DeleteRecordPaymentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, DeleteRecordedPaymentRequest deleteRecordedPaymentRequest, string requestor=null, string xOPAYHeaders=null)
	Delete Recorded Payment More...
System.Threading.Tasks.Task < GetRecordedPaymentResponse >	GetRecordPaymentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string requestor=null, string xOPAYHeaders=null)
	Get Recorded Payment More...
System.Threading.Tasks.Task < ApiResponse < GetRecordedPaymentResponse > >	GetRecordPaymentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string requestor=null, string xOPAYHeaders=null)
	Get Recorded Payment More...
System.Threading.Tasks.Task < RecordedPaymentResponse >	RecordPaymentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, RecordPaymentRequest recordPaymentRequest, string requestor=null, string xOPAYHeaders=null)
	Record Payment More...
System.Threading.Tasks.Task < ApiResponse < RecordedPaymentResponse > >	RecordPaymentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, RecordPaymentRequest recordPaymentRequest, string requestor=null, string xOPAYHeaders=null)
	Record Payment More...
System.Threading.Tasks.Task < RecordedPaymentsResponse >	RetrieveRecordPaymentsAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string idCustomer, string requestor=null, string xOPAYHeaders=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > paymentMethod=null, List< string > status=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Recorded Payments More...
System.Threading.Tasks.Task < ApiResponse < RecordedPaymentsResponse > >	RetrieveRecordPaymentsAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string idCustomer, string requestor=null, string xOPAYHeaders=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > paymentMethod=null, List< string > status=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Recorded Payments 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<Object> Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.DeleteRecordPayment	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT,
		DeleteRecordedPaymentRequest	deleteRecordedPaymentRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Delete Recorded Payment

The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case

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.
deleteRecordedPaymentRequest	Details of payment to be deleted/cancelled
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

System.Threading.Tasks.Task Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.DeleteRecordPaymentAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT,
		DeleteRecordedPaymentRequest	deleteRecordedPaymentRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Delete Recorded Payment

The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case

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.
deleteRecordedPaymentRequest	Details of payment to be deleted/cancelled
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Task of void

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

System.Threading.Tasks.Task<ApiResponse<Object> > Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.DeleteRecordPaymentAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT,
		DeleteRecordedPaymentRequest	deleteRecordedPaymentRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Delete Recorded Payment

The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case

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.
deleteRecordedPaymentRequest	Details of payment to be deleted/cancelled
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Task of ApiResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.DeleteRecordPaymentWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT,
		DeleteRecordedPaymentRequest	deleteRecordedPaymentRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Delete Recorded Payment

The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case

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.
deleteRecordedPaymentRequest	Details of payment to be deleted/cancelled
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

ApiResponse of Object(void)

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

ApiResponse<GetRecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.GetRecordPayment	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Get Recorded Payment

The API is used to retrieve the details of a payment 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_PAYMENT	The unique identifier assigned by EBPP to the payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

ApiResponse<GetRecordedPaymentResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

System.Threading.Tasks.Task<GetRecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.GetRecordPaymentAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Get Recorded Payment

The API is used to retrieve the details of a payment 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_PAYMENT	The unique identifier assigned by EBPP to the payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Task of GetRecordedPaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

System.Threading.Tasks.Task<ApiResponse<GetRecordedPaymentResponse> > Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.GetRecordPaymentAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Get Recorded Payment

The API is used to retrieve the details of a payment 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_PAYMENT	The unique identifier assigned by EBPP to the payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Task of ApiResponse (GetRecordedPaymentResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

ApiResponse<GetRecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.GetRecordPaymentWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Get Recorded Payment

The API is used to retrieve the details of a payment 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_PAYMENT	The unique identifier assigned by EBPP to the payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

ApiResponse of GetRecordedPaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

ApiResponse<RecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.RecordPayment	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		RecordPaymentRequest	recordPaymentRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Record Payment

The API is used to record payments in EBPP those are made and fulfilled outside EBPP.

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.
recordPaymentRequest	JSON containing all the fields required to record a payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

ApiResponse<RecordedPaymentResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

System.Threading.Tasks.Task<RecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.RecordPaymentAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		RecordPaymentRequest	recordPaymentRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Record Payment

The API is used to record payments in EBPP those are made and fulfilled outside EBPP.

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.
recordPaymentRequest	JSON containing all the fields required to record a payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Task of RecordedPaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

System.Threading.Tasks.Task<ApiResponse<RecordedPaymentResponse> > Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.RecordPaymentAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		RecordPaymentRequest	recordPaymentRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Record Payment

The API is used to record payments in EBPP those are made and fulfilled outside EBPP.

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.
recordPaymentRequest	JSON containing all the fields required to record a payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

Task of ApiResponse (RecordedPaymentResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

ApiResponse<RecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.RecordPaymentWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		RecordPaymentRequest	recordPaymentRequest,
		string	requestor = null,
		string	xOPAYHeaders = null
	)

Record Payment

The API is used to record payments in EBPP those are made and fulfilled outside EBPP.

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.
recordPaymentRequest	JSON containing all the fields required to record a payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns

ApiResponse of RecordedPaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

ApiResponse<RecordedPaymentsResponse> Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.RetrieveRecordPayments	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	idCustomer,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	idCustomerAccount = null,
		string	confirmationNumber = null,
		List< string >	paymentMethod = null,
		List< string >	status = null,
		string	fromDate = null,
		string	toDate = null,
		string	pageSize = null,
		string	queryId = null,
		string	fromIndex = null,
		string	toIndex = null
	)

Retrieve Recorded Payments

The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response.

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.
idCustomer	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
paymentMethod	The non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
status	The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDate	The date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which payments, 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 Payments 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<RecordedPaymentsResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

System.Threading.Tasks.Task<RecordedPaymentsResponse> Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.RetrieveRecordPaymentsAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	idCustomer,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	idCustomerAccount = null,
		string	confirmationNumber = null,
		List< string >	paymentMethod = null,
		List< string >	status = null,
		string	fromDate = null,
		string	toDate = null,
		string	pageSize = null,
		string	queryId = null,
		string	fromIndex = null,
		string	toIndex = null
	)

Retrieve Recorded Payments

The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response.

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.
idCustomer	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
paymentMethod	The non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
status	The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDate	The date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which payments, 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 Payments 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 RecordedPaymentsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

System.Threading.Tasks.Task<ApiResponse<RecordedPaymentsResponse> > Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.RetrieveRecordPaymentsAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	idCustomer,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	idCustomerAccount = null,
		string	confirmationNumber = null,
		List< string >	paymentMethod = null,
		List< string >	status = null,
		string	fromDate = null,
		string	toDate = null,
		string	pageSize = null,
		string	queryId = null,
		string	fromIndex = null,
		string	toIndex = null
	)

Retrieve Recorded Payments

The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response.

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.
idCustomer	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
paymentMethod	The non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
status	The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDate	The date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which payments, 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 Payments 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 (RecordedPaymentsResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

ApiResponse<RecordedPaymentsResponse> Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.RetrieveRecordPaymentsWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	idCustomer,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	idCustomerAccount = null,
		string	confirmationNumber = null,
		List< string >	paymentMethod = null,
		List< string >	status = null,
		string	fromDate = null,
		string	toDate = null,
		string	pageSize = null,
		string	queryId = null,
		string	fromIndex = null,
		string	toIndex = null
	)

Retrieve Recorded Payments

The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response.

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.
idCustomer	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
paymentMethod	The non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
status	The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDate	The date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which payments, 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 Payments 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 RecordedPaymentsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.

---

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

• src/Orbipay.PaymentsApi.Client/Api/RecordedPaymentApi.cs