My Project
 All Classes Namespaces Files Functions Variables Typedefs Properties Pages
Orbipay.PaymentsApi.Client.Wrappers.Payments Class Reference
Inheritance diagram for Orbipay.PaymentsApi.Client.Wrappers.Payments:
Orbipay.PaymentsApi.Client.Wrappers.Base

Public Member Functions

List< PaymentGetList ()
 Gets List More...
 
string GetTotalResultsCount ()
 total number of payments available with matching 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 GetIdCustomer ()
 The unique identifier assigned by EBPP to the customer. More...
 
string GetIdFundingAccount ()
 The unique identifier assigned by EBPP to the funding account More...
 
string GetIdCustomerAccount ()
 The unique identifier assigned by EBPP to the customer account More...
 
string GetConfirmationNumber ()
 The confirmation number or reference provided to the customer for the successful payment. More...
 
List< string > GetStatus ()
 The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... More...
 
List< string > GetPaymentScheduleType ()
 The schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... More...
 
List< string > GetPaymentMethod ()
 The fulfillment method for the payment. More...
 
string GetFromDate ()
 The date from which payments, matching the criteria specified, need to be retrieved. More...
 
string GetToDate ()
 The date upto which payments, matching the criteria specified, need to be retrieved. More...
 
string GetPageSize ()
 The maximum number of objects returned in the query. More...
 
Payments ForClient (string clientKey)
 
Payments VideChannel (string channel)
 
Payments FindBy (MultiMap< String > PaymentsFilterMap)
 
Payments ForCustomer (string idCustomer)
 
Payments RetrievedBy (string requestor, string requestorType)
 RetrievedBy Method. More...
 
Payments Get (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
 Get Method. More...
 
IEnumerator< PaymentsGetEnumerator ()
 
- 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< PaymentList
 List More...
 
string TotalResultsCount
 total number of payments available with matching 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 idCustomer
 The unique identifier assigned by EBPP to the customer. More...
 
string idFundingAccount
 The unique identifier assigned by EBPP to the funding account More...
 
string idCustomerAccount
 The unique identifier assigned by EBPP to the customer account More...
 
string confirmationNumber
 The confirmation number or reference provided to the customer for the successful payment. More...
 
List< string > status
 The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... More...
 
List< string > paymentScheduleType
 The schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... More...
 
List< string > paymentMethod
 The fulfillment method for the payment. More...
 
string fromDate
 The date from which payments, matching the criteria specified, need to be retrieved. More...
 
string toDate
 The date upto which payments, matching the criteria specified, need to be retrieved. More...
 
string pageSize
 The maximum number of objects returned in the query. 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

Payments Orbipay.PaymentsApi.Client.Wrappers.Payments.FindBy ( MultiMap< String >  PaymentsFilterMap)

FindBy Method.

Parameters
PaymentsFilterMapThe PaymentsFilterMap is of type MultiMap<String>
Returns
Payments
Payments Orbipay.PaymentsApi.Client.Wrappers.Payments.ForClient ( string  clientKey)

ForClient Method.

Parameters
ClientKeyThe ClientKey is of type string
Returns
Payments
Payments Orbipay.PaymentsApi.Client.Wrappers.Payments.ForCustomer ( string  idCustomer)

ForCustomer Method.

Parameters
idCustomerThe idCustomer is of type string
Returns
Payments
Payments Orbipay.PaymentsApi.Client.Wrappers.Payments.Get ( InvocationContext  invocation_context,
string  live_mode = null,
string  api_end_point = null 
)

Get Method.

Parameters
invocationContextThe invocationContext is of type InvocationContext
liveModeThe liveMode is of type String
Exceptions
OrbipayApiExceptionThe only Exception that is thrown in Exceptional case
Returns
Payments
string Orbipay.PaymentsApi.Client.Wrappers.Payments.GetConfirmationNumber ( )

The confirmation number or reference provided to the customer for the successful payment.

The confirmation number or reference provided to the customer for the successful payment.

IEnumerator<Payments> Orbipay.PaymentsApi.Client.Wrappers.Payments.GetEnumerator ( )
string Orbipay.PaymentsApi.Client.Wrappers.Payments.GetFromDate ( )

The date from which payments, matching the criteria specified, need to be retrieved.

The date from which payments, matching the criteria specified, need to be retrieved.

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

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

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

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

true if there are more results or pages

true if there are more results or pages

string Orbipay.PaymentsApi.Client.Wrappers.Payments.GetIdCustomer ( )

The unique identifier assigned by EBPP to the customer.

The unique identifier assigned by EBPP to the customer.

string Orbipay.PaymentsApi.Client.Wrappers.Payments.GetIdCustomerAccount ( )

The unique identifier assigned by EBPP to the customer account

The unique identifier assigned by EBPP to the customer account

string Orbipay.PaymentsApi.Client.Wrappers.Payments.GetIdFundingAccount ( )

The unique identifier assigned by EBPP to the funding account

The unique identifier assigned by EBPP to the funding account

List<Payment> Orbipay.PaymentsApi.Client.Wrappers.Payments.GetList ( )

Gets List

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

The maximum number of objects returned in the query.

The maximum number of objects returned in the query.

List<string> Orbipay.PaymentsApi.Client.Wrappers.Payments.GetPaymentMethod ( )

The fulfillment method for the payment.

The fulfillment method for the payment.

List<string> Orbipay.PaymentsApi.Client.Wrappers.Payments.GetPaymentScheduleType ( )

The schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2....

The schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2....

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

The query id of the object.

The query id of the object.

List<string> Orbipay.PaymentsApi.Client.Wrappers.Payments.GetStatus ( )

The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2....

The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2....

string Orbipay.PaymentsApi.Client.Wrappers.Payments.GetToDate ( )

The date upto which payments, matching the criteria specified, need to be retrieved.

The date upto which payments, matching the criteria specified, need to be retrieved.

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

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

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

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

total number of payments available with matching criteria

total number of payments available with matching criteria

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

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

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

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

RetrievedBy Method.

Parameters
RequestorThe Requestor is of type string
RequestorTypeThe RequestorType is of type string
Returns
Payments
Payments Orbipay.PaymentsApi.Client.Wrappers.Payments.VideChannel ( string  channel)

VideChannel Method.

Parameters
ChannelThe Channel is of type string
Returns
Payments

Member Data Documentation

string Orbipay.PaymentsApi.Client.Wrappers.Payments.confirmationNumber

The confirmation number or reference provided to the customer for the successful payment.

The confirmation number or reference provided to the customer for the successful payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payments.fromDate

The date from which payments, matching the criteria specified, need to be retrieved.

The date from which payments, matching the criteria specified, need to be retrieved.

string Orbipay.PaymentsApi.Client.Wrappers.Payments.FromIndex

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

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

string Orbipay.PaymentsApi.Client.Wrappers.Payments.HasMoreResults

true if there are more results or pages

true if there are more results or pages

string Orbipay.PaymentsApi.Client.Wrappers.Payments.idCustomer

The unique identifier assigned by EBPP to the customer.

The unique identifier assigned by EBPP to the customer.

string Orbipay.PaymentsApi.Client.Wrappers.Payments.idCustomerAccount

The unique identifier assigned by EBPP to the customer account

The unique identifier assigned by EBPP to the customer account

string Orbipay.PaymentsApi.Client.Wrappers.Payments.idFundingAccount

The unique identifier assigned by EBPP to the funding account

The unique identifier assigned by EBPP to the funding account

List<Payment> Orbipay.PaymentsApi.Client.Wrappers.Payments.List

List

string Orbipay.PaymentsApi.Client.Wrappers.Payments.pageSize

The maximum number of objects returned in the query.

The maximum number of objects returned in the query.

List<string> Orbipay.PaymentsApi.Client.Wrappers.Payments.paymentMethod

The fulfillment method for the payment.

The fulfillment method for the payment.

List<string> Orbipay.PaymentsApi.Client.Wrappers.Payments.paymentScheduleType

The schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2....

The schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2....

string Orbipay.PaymentsApi.Client.Wrappers.Payments.QueryId

The query id of the object.

The query id of the object.

List<string> Orbipay.PaymentsApi.Client.Wrappers.Payments.status

The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2....

The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2....

string Orbipay.PaymentsApi.Client.Wrappers.Payments.toDate

The date upto which payments, matching the criteria specified, need to be retrieved.

The date upto which payments, matching the criteria specified, need to be retrieved.

string Orbipay.PaymentsApi.Client.Wrappers.Payments.ToIndex

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

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

string Orbipay.PaymentsApi.Client.Wrappers.Payments.TotalResultsCount

total number of payments available with matching criteria

total number of payments available with matching criteria

string Orbipay.PaymentsApi.Client.Wrappers.Payments.Url

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

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: