My Project
 All Classes Namespaces Files Functions Variables Typedefs Properties Pages
Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest Class Reference

More...

Inheritance diagram for Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest:

Public Member Functions

 CreatePaymentRequest (string amount=default(string), string cardCvvNumber=default(string), string paymentDate=default(string), string paymentRequestDate=default(string), string paymentAmountType=default(string), FeeRequest fee=default(FeeRequest), CustomerMinimalRequest customer=default(CustomerMinimalRequest), FundingAccountMinimalRequest fundingAccount=default(FundingAccountMinimalRequest), CustomerAccountMinimalRequest customerAccount=default(CustomerAccountMinimalRequest), string paymentReference=default(string), string paymentNotificationEmail=default(string), string comments=default(string), Dictionary< string, string > customFields=default(Dictionary< string, string >))
 Initializes a new instance of the CreatePaymentRequest class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
virtual string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (CreatePaymentRequest input)
 Returns true if CreatePaymentRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 CreatePaymentRequest ()
 Initializes a new instance of the CreatePaymentRequest class. More...
 

Properties

string Amount [get, set]
 The amount being paid. In case the payment_amount_type is &#39;discounted_amount&#39;, &#39;penalty_amount&#39; or &#39;other&#39;, the amount needs to be specified. In other cases, this is derived from the payment_amount_type. More...
 
string CardCvvNumber [get, set]
 This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account. More...
 
string PaymentDate [get, set]
 The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string PaymentRequestDate [get, set]
 The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it. More...
 
FeeRequest Fee [get, set]
 Gets or Sets Fee More...
 
CustomerMinimalRequest Customer [get, set]
 Gets or Sets Customer More...
 
FundingAccountMinimalRequest FundingAccount [get, set]
 Gets or Sets FundingAccount More...
 
CustomerAccountMinimalRequest CustomerAccount [get, set]
 Gets or Sets CustomerAccount More...
 
string PaymentReference [get, set]
 The unique identifier in the client system for the payment. More...
 
string PaymentNotificationEmail [get, set]
 The email address to which notifications for the payment will be sent. The notifications will be sent to the customer&#39;s email in case this is not provided. More...
 
string Comments [get, set]
 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...
 
Dictionary< string, string > CustomFields [get, set]
 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...
 

Detailed Description

This class subject to change without prior notice, Please dont use this class directly.

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.CreatePaymentRequest ( )
protected

Initializes a new instance of the CreatePaymentRequest class.

Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.CreatePaymentRequest ( string  amount = default(string),
string  cardCvvNumber = default(string),
string  paymentDate = default(string),
string  paymentRequestDate = default(string),
string  paymentAmountType = default(string),
FeeRequest  fee = default(FeeRequest),
CustomerMinimalRequest  customer = default(CustomerMinimalRequest),
FundingAccountMinimalRequest  fundingAccount = default(FundingAccountMinimalRequest),
CustomerAccountMinimalRequest  customerAccount = default(CustomerAccountMinimalRequest),
string  paymentReference = default(string),
string  paymentNotificationEmail = default(string),
string  comments = default(string),
Dictionary< string, string >  customFields = default(Dictionary<string, string>) 
)

Initializes a new instance of the CreatePaymentRequest class.

Parameters
amountThe amount being paid. In case the payment_amount_type is &#39;discounted_amount&#39;, &#39;penalty_amount&#39; or &#39;other&#39;, the amount needs to be specified. In other cases, this is derived from the payment_amount_type..
cardCvvNumberThis is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account..
paymentDateThe date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD..
paymentRequestDateThe date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it..
paymentAmountTypeThe type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other..
feefee.
customercustomer (required).
fundingAccountfundingAccount (required).
customerAccountcustomerAccount (required).
paymentReferenceThe unique identifier in the client system for the payment..
paymentNotificationEmailThe email address to which notifications for the payment will be sent. The notifications will be sent to the customer&#39;s email in case this is not provided..
commentsComments 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..
customFieldsThe 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..

Member Function Documentation

override bool Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.Equals ( object  input)

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean
bool Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.Equals ( CreatePaymentRequest  input)

Returns true if CreatePaymentRequest instances are equal

Parameters
inputInstance of CreatePaymentRequest to be compared
Returns
Boolean
override int Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.GetHashCode ( )

Gets the hash code

Returns
Hash code
virtual string Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.ToJson ( )
virtual

Returns the JSON string presentation of the object

Returns
string
override string Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.ToString ( )

Returns the string presentation of the object

Returns
string

Property Documentation

string Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.Amount
getset

The amount being paid. In case the payment_amount_type is &#39;discounted_amount&#39;, &#39;penalty_amount&#39; or &#39;other&#39;, the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

The amount being paid. In case the payment_amount_type is &#39;discounted_amount&#39;, &#39;penalty_amount&#39; or &#39;other&#39;, the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

string Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.CardCvvNumber
getset

This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account.

This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account.

string Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.Comments
getset

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.

CustomerMinimalRequest Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.Customer
getset

Gets or Sets Customer

CustomerAccountMinimalRequest Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.CustomerAccount
getset

Gets or Sets CustomerAccount

Dictionary<string, string> Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.CustomFields
getset

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.

FeeRequest Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.Fee
getset

Gets or Sets Fee

FundingAccountMinimalRequest Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.FundingAccount
getset

Gets or Sets FundingAccount

string Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.PaymentDate
getset

The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.PaymentNotificationEmail
getset

The email address to which notifications for the payment will be sent. The notifications will be sent to the customer&#39;s email in case this is not provided.

The email address to which notifications for the payment will be sent. The notifications will be sent to the customer&#39;s email in case this is not provided.

string Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.PaymentReference
getset

The unique identifier in the client system for the payment.

The unique identifier in the client system for the payment.

string Orbipay.PaymentsApi.Client.Models.CreatePaymentRequest.PaymentRequestDate
getset

The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.

The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.


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