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

Public Member Functions
List< Customer >	GetList ()
	Gets List More...

string	GetTotalResultsCount ()
	The total number of customers available matching the search criteria. More...

string	GetHasMoreResults ()
	true if there are more results or pages More...

string	GetUrl ()
	This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter. More...

string	GetFromIndex ()
	The id of the object before which the previous set of objects are to be retrieved. More...

string	GetToIndex ()
	The id of the object after which the next set of objects are to be retrieved. More...

string	GetQueryId ()
	The query id of the object. More...

string	GetPageSize ()
	The maximum number of objects returned in the query. More...

string	GetCustomerReference ()
	Unique ID assigned by the biller/client system for a given customer. More...

string	GetSsn ()
	The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. More...

string	GetEmail ()
	This field contains the customer’s email address within EBPP. More...

string	GetAccountNumber ()
	Customer Account Number of the customer to get details of. More...

Customers	ForClient (string clientKey)

Customers	VideChannel (string channel)

Customers	FindBy (MultiMap< String > CustomersFilterMap)

Customers	RetrievedBy (string requestor, string requestorType)
	RetrievedBy Method. More...

Customers	Get (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
	Get Method. More...

Customers	GetPage (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
	GetPage Method. More...

IEnumerator< Customers >	GetEnumerator ()

Public Member Functions inherited from Orbipay.PaymentsApi.Client.Wrappers.Base
String	GetLiveMode ()

string	GetApiEndPoint ()

void	SetLiveMode (String LiveMode=default(String))

void	SetHttpStatusCode (int httpStatusCode)

InvocationContext	GetInvocationContext ()

int	GetHttpStatusCode ()

void	SetInvocationContext (InvocationContext invocationContext)

void	Dispose ()

Public Attributes
List< Customer >	List
	List More...

string	TotalResultsCount
	The total number of customers available matching the search criteria. More...

string	HasMoreResults
	true if there are more results or pages More...

string	Url
	This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter. More...

string	FromIndex
	The id of the object before which the previous set of objects are to be retrieved. More...

string	ToIndex
	The id of the object after which the next set of objects are to be retrieved. More...

string	QueryId
	The query id of the object. More...

string	pageSize
	The maximum number of objects returned in the query. More...

string	customerReference
	Unique ID assigned by the biller/client system for a given customer. More...

string	ssn
	The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. More...

string	email
	This field contains the customer’s email address within EBPP. More...

string	accountNumber
	Customer Account Number of the customer to get details of. More...

Public Attributes inherited from Orbipay.PaymentsApi.Client.Wrappers.Base
int	HttpStatusCode

Additional Inherited Members
Protected Member Functions inherited from Orbipay.PaymentsApi.Client.Wrappers.Base
Base	VideChannel (string channel)

Base	RequestedBy (string requestor, string requestorType)

Base	ForClient (string clientKey)

Base	SetAPIEndpoint (String LiveMode=null, String apiEndPoint=null)

Base	WithContext (InvocationContext request, String LiveMode=default(String), String apiEndPoint=null)

Member Function Documentation

Customers Orbipay.PaymentsApi.Client.Wrappers.Customers.FindBy ( MultiMap< String > CustomersFilterMap )

FindBy Method.

Parameters

CustomersFilterMap The CustomersFilterMap is of type MultiMap<String>

Returns: Customers

Customers Orbipay.PaymentsApi.Client.Wrappers.Customers.ForClient ( string clientKey )

ForClient Method.

Parameters

ClientKey The ClientKey is of type string

Returns: Customers

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

Get Method.

Parameters

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

Exceptions

OrbipayApiException The only Exception that is thrown in Exceptional case

Returns: Customers

string Orbipay.PaymentsApi.Client.Wrappers.Customers.GetAccountNumber ( )

Customer Account Number of the customer to get details of.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.GetCustomerReference ( )

Unique ID assigned by the biller/client system for a given customer.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.GetEmail ( )

This field contains the customer’s email address within EBPP.

IEnumerator<Customers> Orbipay.PaymentsApi.Client.Wrappers.Customers.GetEnumerator ( )

string Orbipay.PaymentsApi.Client.Wrappers.Customers.GetFromIndex ( )

The id of the object before which the previous set of objects are to be retrieved.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.GetHasMoreResults ( )

true if there are more results or pages

List<Customer> Orbipay.PaymentsApi.Client.Wrappers.Customers.GetList ( )

Gets List

Customers Orbipay.PaymentsApi.Client.Wrappers.Customers.GetPage	(	InvocationContext	invocation_context,
		string	live_mode = `null`,
		string	api_end_point = `null`
	)

GetPage Method.

Parameters

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

Exceptions

OrbipayApiException The only Exception that is thrown in Exceptional case

Returns: Customers

string Orbipay.PaymentsApi.Client.Wrappers.Customers.GetPageSize ( )

The maximum number of objects returned in the query.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.GetQueryId ( )

The query id of the object.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.GetSsn ( )

The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.GetToIndex ( )

The id of the object after which the next set of objects are to be retrieved.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.GetTotalResultsCount ( )

The total number of customers available matching the search criteria.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.GetUrl ( )

This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter.

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

RetrievedBy Method.

Parameters

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

Returns: Customers

Customers Orbipay.PaymentsApi.Client.Wrappers.Customers.VideChannel ( string channel )

VideChannel Method.

Parameters

Channel The Channel is of type string

Returns: Customers

Member Data Documentation

string Orbipay.PaymentsApi.Client.Wrappers.Customers.accountNumber

Customer Account Number of the customer to get details of.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.customerReference

Unique ID assigned by the biller/client system for a given customer.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.email

This field contains the customer’s email address within EBPP.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.FromIndex

The id of the object before which the previous set of objects are to be retrieved.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.HasMoreResults

true if there are more results or pages

List<Customer> Orbipay.PaymentsApi.Client.Wrappers.Customers.List

List

string Orbipay.PaymentsApi.Client.Wrappers.Customers.pageSize

The maximum number of objects returned in the query.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.QueryId

The query id of the object.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.ssn

The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.ToIndex

The id of the object after which the next set of objects are to be retrieved.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.TotalResultsCount

The total number of customers available matching the search criteria.

string Orbipay.PaymentsApi.Client.Wrappers.Customers.Url

This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter.

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

src/Orbipay.PaymentsApi.Client/Wrappers/Customers.cs

Public Member Functions

Public Attributes

Additional Inherited Members

Member Function Documentation

Member Data Documentation