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

More...

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

Public Member Functions

 PaymentSetupResponse (string id=default(string), string url=default(string), FeeResponse fee=default(FeeResponse), string status=default(string), string paymentMethod=default(string), string paymentSetupScheduleType=default(string), string confirmationNumber=default(string), Dictionary< string, string > customFields=default(Dictionary< string, string >), string currencyCode3d=default(string), string amount=default(string), string cardCvvNumber=default(string), string nextPaymentDate=default(string), string paymentSetupReference=default(string), PaymentScheduleVo paymentSchedule=default(PaymentScheduleVo), string paymentSetupEntryDate=default(string), string comments=default(string), CustomerSnapshotResponse customer=default(CustomerSnapshotResponse), FundingAccountSnapshotResponse fundingAccount=default(FundingAccountSnapshotResponse), CustomerAccountSnapshotResponse customerAccount=default(CustomerAccountSnapshotResponse), PaymentNetworkResponseVo paymentNetworkResponse=default(PaymentNetworkResponseVo), AuditInfoVo auditInfo=default(AuditInfoVo))
 Initializes a new instance of the PaymentSetupResponse 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 (PaymentSetupResponse input)
 Returns true if PaymentSetupResponse instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Properties

string Id [get, set]
 The unique identifier assigned by EBPP to the payment setup. More...
 
string Url [get, set]
 This URL fetches the details of payment setup. More...
 
FeeResponse Fee [get, set]
 Gets or Sets Fee More...
 
string ConfirmationNumber [get, set]
 The confirmation number or reference provided to the customer for the payment setup. 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...
 
string CurrencyCode3d [get, set]
 The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD. More...
 
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 setup with a card funding account. More...
 
string NextPaymentDate [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 PaymentSetupReference [get, set]
 The unique identifier in the client system for the payment setup. More...
 
PaymentScheduleVo PaymentSchedule [get, set]
 Gets or Sets PaymentSchedule More...
 
string PaymentSetupEntryDate [get, set]
 The date on which the payment setup is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. 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 (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo. More...
 
CustomerSnapshotResponse Customer [get, set]
 Gets or Sets Customer More...
 
FundingAccountSnapshotResponse FundingAccount [get, set]
 Gets or Sets FundingAccount More...
 
CustomerAccountSnapshotResponse CustomerAccount [get, set]
 Gets or Sets CustomerAccount More...
 
PaymentNetworkResponseVo PaymentNetworkResponse [get, set]
 Gets or Sets PaymentNetworkResponse More...
 
AuditInfoVo AuditInfo [get, set]
 Gets or Sets AuditInfo More...
 

Detailed Description

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

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.PaymentSetupResponse ( string  id = default(string),
string  url = default(string),
FeeResponse  fee = default(FeeResponse),
string  status = default(string),
string  paymentMethod = default(string),
string  paymentSetupScheduleType = default(string),
string  confirmationNumber = default(string),
Dictionary< string, string >  customFields = default(Dictionary<string, string>),
string  currencyCode3d = default(string),
string  amount = default(string),
string  cardCvvNumber = default(string),
string  nextPaymentDate = default(string),
string  paymentSetupReference = default(string),
PaymentScheduleVo  paymentSchedule = default(PaymentScheduleVo),
string  paymentSetupEntryDate = default(string),
string  comments = default(string),
CustomerSnapshotResponse  customer = default(CustomerSnapshotResponse),
FundingAccountSnapshotResponse  fundingAccount = default(FundingAccountSnapshotResponse),
CustomerAccountSnapshotResponse  customerAccount = default(CustomerAccountSnapshotResponse),
PaymentNetworkResponseVo  paymentNetworkResponse = default(PaymentNetworkResponseVo),
AuditInfoVo  auditInfo = default(AuditInfoVo) 
)

Initializes a new instance of the PaymentSetupResponse class.

Parameters
idThe unique identifier assigned by EBPP to the payment setup..
urlThis URL fetches the details of payment setup..
feefee.
statusThe status of the payment..
paymentMethodThe fulfillment method for the payment..
paymentSetupScheduleTypeThe schedule type for the payment setup..
confirmationNumberThe confirmation number or reference provided to the customer for the payment setup..
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..
currencyCode3dThe three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD..
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 setup with a card funding account..
nextPaymentDateThe date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD..
paymentSetupReferenceThe unique identifier in the client system for the payment setup..
paymentSchedulepaymentSchedule.
paymentSetupEntryDateThe date on which the payment setup is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD..
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 (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo..
customercustomer.
fundingAccountfundingAccount.
customerAccountcustomerAccount.
paymentNetworkResponsepaymentNetworkResponse.
auditInfoauditInfo.

Member Function Documentation

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

Returns true if objects are equal

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

Returns true if PaymentSetupResponse instances are equal

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

Gets the hash code

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

Returns the JSON string presentation of the object

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

Returns the string presentation of the object

Returns
string

Property Documentation

string Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.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.

AuditInfoVo Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.AuditInfo
getset

Gets or Sets AuditInfo

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

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

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

string Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.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 (Orbipay) 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 (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.

string Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.ConfirmationNumber
getset

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

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

string Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.CurrencyCode3d
getset

The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD.

The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD.

CustomerSnapshotResponse Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.Customer
getset

Gets or Sets Customer

CustomerAccountSnapshotResponse Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.CustomerAccount
getset

Gets or Sets CustomerAccount

Dictionary<string, string> Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.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.

FeeResponse Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.Fee
getset

Gets or Sets Fee

FundingAccountSnapshotResponse Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.FundingAccount
getset

Gets or Sets FundingAccount

string Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.Id
getset

The unique identifier assigned by EBPP to the payment setup.

The unique identifier assigned by EBPP to the payment setup.

string Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.NextPaymentDate
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.

PaymentNetworkResponseVo Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.PaymentNetworkResponse
getset

Gets or Sets PaymentNetworkResponse

PaymentScheduleVo Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.PaymentSchedule
getset

Gets or Sets PaymentSchedule

string Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.PaymentSetupEntryDate
getset

The date on which the payment setup is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date on which the payment setup is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.PaymentSetupReference
getset

The unique identifier in the client system for the payment setup.

The unique identifier in the client system for the payment setup.

string Orbipay.PaymentsApi.Client.Models.PaymentSetupResponse.Url
getset

This URL fetches the details of payment setup.

This URL fetches the details of payment setup.


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