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

Public Member Functions

string GetAccountHolderName ()
 The name as specified on the account. More...
 
string GetNickname ()
 The nickname by which a customer might want to identify the account. More...
 
Address GetAddress ()
 Gets Address More...
 
string GetCustomerAccountReference ()
 The unique identifier in the client system for the customer account. More...
 
string GetAccountNumber ()
 The number or reference that a customer uses to identify the customer's account. More...
 
string GetCurrentBalance ()
 The current balance on the customer's account with the biller. More...
 
string GetCurrentStatementBalance ()
 The balance on the customer’s account with the biller as reported on the last statement. More...
 
string GetMinimumPaymentDue ()
 The minimum payment amount, as specified by the biller, that needs to be made against the customer’s account. More...
 
string GetPastAmountDue ()
 The amount that is due from the past bills/statements on the customer’s account with the biller. More...
 
string GetPaymentDueDate ()
 The date by which the customer needs to clear the dues against the customer's account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string GetStatementDate ()
 The date on which the biller generates the statement for the customer's account. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string GetId ()
 Id is a unique identifier assigned to the customer account in EBPP. More...
 
string GetUrl ()
 This URL fetches the Account details. More...
 
string GetStatus ()
 The status of the customer's account in EBPP. More...
 
Dictionary< string, string > GetCustomFields ()
 The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests. More...
 
string GetComments ()
 Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo. More...
 
AuditInfo GetAuditInfo ()
 Gets AuditInfo More...
 
string GetID_CUSTOMER_ACCOUNT ()
 The unique identifier assigned by EBPP to the Customer Account. More...
 
string GetID_CUSTOMER ()
 The unique identifier assigned by EBPP to the customer. More...
 
 CustomerAccount (string iDCUSTOMERACCOUNT=null)
 
CustomerAccount ForClient (string clientKey)
 
CustomerAccount VideChannel (string channel)
 
CustomerAccount WithDetails (string accountHolderName, string nickname, string accountNumber, string minimumPaymentDue, string pastAmountDue, string paymentDueDate, string statementDate)
 
CustomerAccount WithBalances (string currentBalance, string currentStatementBalance)
 
CustomerAccount WithReference (string customerAccountReference)
 
CustomerAccount WithStatus (string status)
 
CustomerAccount WithAddress (Address address)
 
CustomerAccount WithCustomFields (Dictionary< string, string > customFields)
 
CustomerAccount WithMemo (string comments)
 
CustomerAccount ForCustomer (string iDCUSTOMER)
 
CustomerAccount RetrievedBy (string requestor, string requestorType)
 RetrievedBy Method. More...
 
CustomerAccount RenewedBy (string requestor, string requestorType)
 RenewedBy Method. More...
 
CustomerAccount Get (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
 Get Method. More...
 
CustomerAccount Renew (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
 Renew Method. More...
 
IEnumerator< CustomerAccountGetEnumerator ()
 
- 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

string AccountHolderName
 The name as specified on the account. More...
 
string Nickname
 The nickname by which a customer might want to identify the account. More...
 
Address Address
 Address More...
 
string CustomerAccountReference
 The unique identifier in the client system for the customer account. More...
 
string AccountNumber
 The number or reference that a customer uses to identify the customer&#39;s account. More...
 
string CurrentBalance
 The current balance on the customer&#39;s account with the biller. More...
 
string CurrentStatementBalance
 The balance on the customer’s account with the biller as reported on the last statement. More...
 
string MinimumPaymentDue
 The minimum payment amount, as specified by the biller, that needs to be made against the customer’s account. More...
 
string PastAmountDue
 The amount that is due from the past bills/statements on the customer’s account with the biller. More...
 
string PaymentDueDate
 The date by which the customer needs to clear the dues against the customer&#39;s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string StatementDate
 The date on which the biller generates the statement for the customer&#39;s account. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string Id
 Id is a unique identifier assigned to the customer account in EBPP. More...
 
string Url
 This URL fetches the Account details. More...
 
string Status
 The status of the customer&#39;s account in EBPP. More...
 
Dictionary< string, string > CustomFields
 The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests. More...
 
string Comments
 Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo. More...
 
AuditInfo AuditInfo
 AuditInfo More...
 
string ID_CUSTOMER_ACCOUNT
 The unique identifier assigned by EBPP to the Customer Account. More...
 
string ID_CUSTOMER
 The unique identifier assigned by EBPP to the customer. 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)
 

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.CustomerAccount ( string  iDCUSTOMERACCOUNT = null)

CustomerAccount Constructor.

Parameters
ID_CUSTOMER_ACCOUNTThe ID_CUSTOMER_ACCOUNT is of type string

Member Function Documentation

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

ForClient Method.

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

ForCustomer Method.

Parameters
ID_CUSTOMERThe ID_CUSTOMER is of type string
Returns
CustomerAccount
CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.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
CustomerAccount
string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetAccountHolderName ( )

The name as specified on the account.

The name as specified on the account.

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

The number or reference that a customer uses to identify the customer&#39;s account.

The number or reference that a customer uses to identify the customer&#39;s account.

Address Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetAddress ( )

Gets Address

AuditInfo Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetAuditInfo ( )

Gets AuditInfo

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetComments ( )

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetCurrentBalance ( )

The current balance on the customer&#39;s account with the biller.

The current balance on the customer&#39;s account with the biller.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetCurrentStatementBalance ( )

The balance on the customer’s account with the biller as reported on the last statement.

The balance on the customer’s account with the biller as reported on the last statement.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetCustomerAccountReference ( )

The unique identifier in the client system for the customer account.

The unique identifier in the client system for the customer account.

Dictionary<string, string> Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetCustomFields ( )

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests.

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests.

IEnumerator<CustomerAccount> Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetEnumerator ( )
string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetId ( )

Id is a unique identifier assigned to the customer account in EBPP.

Id is a unique identifier assigned to the customer account in EBPP.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetID_CUSTOMER ( )

The unique identifier assigned by EBPP to the customer.

The unique identifier assigned by EBPP to the customer.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetID_CUSTOMER_ACCOUNT ( )

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.CustomerAccount.GetMinimumPaymentDue ( )

The minimum payment amount, as specified by the biller, that needs to be made against the customer’s account.

The minimum payment amount, as specified by the biller, that needs to be made against the customer’s account.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetNickname ( )

The nickname by which a customer might want to identify the account.

The nickname by which a customer might want to identify the account.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetPastAmountDue ( )

The amount that is due from the past bills/statements on the customer’s account with the biller.

The amount that is due from the past bills/statements on the customer’s account with the biller.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetPaymentDueDate ( )

The date by which the customer needs to clear the dues against the customer&#39;s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date by which the customer needs to clear the dues against the customer&#39;s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetStatementDate ( )

The date on which the biller generates the statement for the customer&#39;s account. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date on which the biller generates the statement for the customer&#39;s account. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.GetStatus ( )

The status of the customer&#39;s account in EBPP.

The status of the customer&#39;s account in EBPP.

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

This URL fetches the Account details.

This URL fetches the Account details.

CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.Renew ( InvocationContext  invocation_context,
string  live_mode = null,
string  api_end_point = null 
)

Renew 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
CustomerAccount
CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.RenewedBy ( string  requestor,
string  requestorType 
)

RenewedBy Method.

Parameters
RequestorThe Requestor is of type string
RequestorTypeThe RequestorType is of type string
Returns
CustomerAccount
CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.RetrievedBy ( string  requestor,
string  requestorType 
)

RetrievedBy Method.

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

VideChannel Method.

Parameters
ChannelThe Channel is of type string
Returns
CustomerAccount
CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.WithAddress ( Address  address)

WithAddress Method.

Parameters
AddressThe Address is of type Address
Returns
CustomerAccount
CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.WithBalances ( string  currentBalance,
string  currentStatementBalance 
)

WithBalances Method.

Parameters
CurrentBalanceThe CurrentBalance is of type string
CurrentStatementBalanceThe CurrentStatementBalance is of type string
Returns
CustomerAccount
CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.WithCustomFields ( Dictionary< string, string >  customFields)

WithCustomFields Method.

Parameters
CustomFieldsThe CustomFields is of type Dictionary<string, string>
Returns
CustomerAccount
CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.WithDetails ( string  accountHolderName,
string  nickname,
string  accountNumber,
string  minimumPaymentDue,
string  pastAmountDue,
string  paymentDueDate,
string  statementDate 
)

WithDetails Method.

Parameters
AccountHolderNameThe AccountHolderName is of type string
NicknameThe Nickname is of type string
AccountNumberThe AccountNumber is of type string
MinimumPaymentDueThe MinimumPaymentDue is of type string
PastAmountDueThe PastAmountDue is of type string
PaymentDueDateThe PaymentDueDate is of type string
StatementDateThe StatementDate is of type string
Returns
CustomerAccount
CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.WithMemo ( string  comments)

WithMemo Method.

Parameters
CommentsThe Comments is of type string
Returns
CustomerAccount
CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.WithReference ( string  customerAccountReference)

WithReference Method.

Parameters
CustomerAccountReferenceThe CustomerAccountReference is of type string
Returns
CustomerAccount
CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.WithStatus ( string  status)

WithStatus Method.

Parameters
StatusThe Status is of type string
Returns
CustomerAccount

Member Data Documentation

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.AccountHolderName

The name as specified on the account.

The name as specified on the account.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.AccountNumber

The number or reference that a customer uses to identify the customer&#39;s account.

The number or reference that a customer uses to identify the customer&#39;s account.

Address Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.Address
AuditInfo Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.AuditInfo
string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.Comments

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.CurrentBalance

The current balance on the customer&#39;s account with the biller.

The current balance on the customer&#39;s account with the biller.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.CurrentStatementBalance

The balance on the customer’s account with the biller as reported on the last statement.

The balance on the customer’s account with the biller as reported on the last statement.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.CustomerAccountReference

The unique identifier in the client system for the customer account.

The unique identifier in the client system for the customer account.

Dictionary<string, string> Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.CustomFields

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests.

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.Id

Id is a unique identifier assigned to the customer account in EBPP.

Id is a unique identifier assigned to the customer account in EBPP.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.ID_CUSTOMER

The unique identifier assigned by EBPP to the customer.

The unique identifier assigned by EBPP to the customer.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.ID_CUSTOMER_ACCOUNT

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.CustomerAccount.MinimumPaymentDue

The minimum payment amount, as specified by the biller, that needs to be made against the customer’s account.

The minimum payment amount, as specified by the biller, that needs to be made against the customer’s account.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.Nickname

The nickname by which a customer might want to identify the account.

The nickname by which a customer might want to identify the account.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.PastAmountDue

The amount that is due from the past bills/statements on the customer’s account with the biller.

The amount that is due from the past bills/statements on the customer’s account with the biller.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.PaymentDueDate

The date by which the customer needs to clear the dues against the customer&#39;s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date by which the customer needs to clear the dues against the customer&#39;s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.StatementDate

The date on which the biller generates the statement for the customer&#39;s account. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date on which the biller generates the statement for the customer&#39;s account. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.Status

The status of the customer&#39;s account in EBPP.

The status of the customer&#39;s account in EBPP.

string Orbipay.PaymentsApi.Client.Wrappers.CustomerAccount.Url

This URL fetches the Account details.

This URL fetches the Account details.


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