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

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

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

	RecordedPaymentApi (Orbipay.PaymentsApi.Client.Client.Configuration configuration=null)
	Initializes a new instance of the RecordedPaymentApi 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< 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 The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case 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 The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case More...

async 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 The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case More...

async 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 The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case 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 The API is used to retrieve the details of a payment by id. 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 The API is used to retrieve the details of a payment by id. More...

async 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 The API is used to retrieve the details of a payment by id. More...

async 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 The API is used to retrieve the details of a payment by id. 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 The API is used to record payments in EBPP those are made and fulfilled outside EBPP. 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 The API is used to record payments in EBPP those are made and fulfilled outside EBPP. More...

async 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 The API is used to record payments in EBPP those are made and fulfilled outside EBPP. More...

async 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 The API is used to record payments in EBPP those are made and fulfilled outside EBPP. 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 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. 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 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. More...

async 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 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. More...

async 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 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. 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.RecordedPaymentApi.RecordedPaymentApi ( String basePath )

Initializes a new instance of the RecordedPaymentApi class.

Returns

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

Initializes a new instance of the RecordedPaymentApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

Member Function Documentation

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

Add default header.

Parameters

key	Header field name.
value	Header field value.

Returns

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

Gets the default header.

Returns: Dictionary of HTTP header

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

async System.Threading.Tasks.Task Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<Object> > Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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)

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

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

Gets the base path of the API client.

The base path

Implements Orbipay.PaymentsApi.Client.Client.IApiAccessor.

ApiResponse<GetRecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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: GetRecordedPaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

async System.Threading.Tasks.Task<GetRecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<GetRecordedPaymentResponse> > Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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)

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

ApiResponse< GetRecordedPaymentResponse > Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

ApiResponse<RecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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: RecordedPaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

async System.Threading.Tasks.Task<RecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<RecordedPaymentResponse> > Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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)

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

ApiResponse< RecordedPaymentResponse > Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

ApiResponse<RecordedPaymentsResponse> Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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=value1&key=value2.... (optional)
status	The status of the payment. This can take multiple values in the format key=value1&key=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: RecordedPaymentsResponse

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

async System.Threading.Tasks.Task<RecordedPaymentsResponse> Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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=value1&key=value2.... (optional)
status	The status of the payment. This can take multiple values in the format key=value1&key=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

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<RecordedPaymentsResponse> > Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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=value1&key=value2.... (optional)
status	The status of the payment. This can take multiple values in the format key=value1&key=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)

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

ApiResponse< RecordedPaymentsResponse > Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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=value1&key=value2.... (optional)
status	The status of the payment. This can take multiple values in the format key=value1&key=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

Implements Orbipay.PaymentsApi.Client.Api.IRecordedPaymentApi.

void Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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.RecordedPaymentApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

Orbipay.PaymentsApi.Client.Client.ExceptionFactory Orbipay.PaymentsApi.Client.Api.RecordedPaymentApi.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/RecordedPaymentApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation