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

More...

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

Public Member Functions

 PaymentResponse (string id=default(string), string url=default(string), FeeResponse fee=default(FeeResponse), string status=default(string), string paymentMethod=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 paymentDate=default(string), string paymentScheduleType=default(string), string paymentRequestDate=default(string), string paymentAmountType=default(string), string paymentReference=default(string), string expectedPaymentSettlementDate=default(string), string paymentEntryDate=default(string), string paymentReturnDate=default(string), string returnCode=default(string), string paymentNotificationEmail=default(string), string comments=default(string), string token=default(string), CustomerSnapshotResponse customer=default(CustomerSnapshotResponse), FundingAccountSnapshotResponse fundingAccount=default(FundingAccountSnapshotResponse), CustomerAccountSnapshotResponse customerAccount=default(CustomerAccountSnapshotResponse), PaymentAuthorizationSnapshotResponse paymentAuthorization=default(PaymentAuthorizationSnapshotResponse), PaymentNetworkResponseVo paymentNetworkResponse=default(PaymentNetworkResponseVo), AuditInfoVo auditInfo=default(AuditInfoVo))
 Initializes a new instance of the PaymentResponse 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 (PaymentResponse input)
 Returns true if PaymentResponse 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. More...
 
string Url [get, set]
 This URL fetches the details of payment. 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. 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 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...
 
string PaymentReference [get, set]
 The unique identifier in the client system for the payment. More...
 
string ExpectedPaymentSettlementDate [get, set]
 The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string PaymentEntryDate [get, set]
 The date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string PaymentReturnDate [get, set]
 The date on which the ACH returns is received by EBPP. More...
 
string ReturnCode [get, set]
 The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments. 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...
 
string Token [get, set]
 The token is used to uniquely identify the payment, such as the POS token. 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...
 
PaymentAuthorizationSnapshotResponse PaymentAuthorization [get, set]
 Gets or Sets PaymentAuthorization 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.PaymentResponse.PaymentResponse ( string  id = default(string),
string  url = default(string),
FeeResponse  fee = default(FeeResponse),
string  status = default(string),
string  paymentMethod = 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  paymentDate = default(string),
string  paymentScheduleType = default(string),
string  paymentRequestDate = default(string),
string  paymentAmountType = default(string),
string  paymentReference = default(string),
string  expectedPaymentSettlementDate = default(string),
string  paymentEntryDate = default(string),
string  paymentReturnDate = default(string),
string  returnCode = default(string),
string  paymentNotificationEmail = default(string),
string  comments = default(string),
string  token = default(string),
CustomerSnapshotResponse  customer = default(CustomerSnapshotResponse),
FundingAccountSnapshotResponse  fundingAccount = default(FundingAccountSnapshotResponse),
CustomerAccountSnapshotResponse  customerAccount = default(CustomerAccountSnapshotResponse),
PaymentAuthorizationSnapshotResponse  paymentAuthorization = default(PaymentAuthorizationSnapshotResponse),
PaymentNetworkResponseVo  paymentNetworkResponse = default(PaymentNetworkResponseVo),
AuditInfoVo  auditInfo = default(AuditInfoVo) 
)

Initializes a new instance of the PaymentResponse class.

Parameters
idThe unique identifier assigned by EBPP to the payment..
urlThis URL fetches the details of payment..
feefee.
statusThe status of the payment..
paymentMethodThe fulfillment method for the payment..
confirmationNumberThe confirmation number or reference provided to the customer for the payment..
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 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..
paymentScheduleTypeThe schedule type for the payment. This defaults to one_time_payment..
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..
paymentReferenceThe unique identifier in the client system for the payment..
expectedPaymentSettlementDateThe date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD..
paymentEntryDateThe date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD..
paymentReturnDateThe date on which the ACH returns is received by EBPP..
returnCodeThe ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments..
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..
tokenThe token is used to uniquely identify the payment, such as the POS token..
customercustomer.
fundingAccountfundingAccount.
customerAccountcustomerAccount.
paymentAuthorizationpaymentAuthorization.
paymentNetworkResponsepaymentNetworkResponse.
auditInfoauditInfo.

Member Function Documentation

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

Returns true if objects are equal

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

Returns true if PaymentResponse instances are equal

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

Gets the hash code

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

Returns the JSON string presentation of the object

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

Returns the string presentation of the object

Returns
string

Property Documentation

string Orbipay.PaymentsApi.Client.Models.PaymentResponse.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.PaymentResponse.AuditInfo
getset

Gets or Sets AuditInfo

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

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

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

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

string Orbipay.PaymentsApi.Client.Models.PaymentResponse.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.PaymentResponse.Customer
getset

Gets or Sets Customer

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

Gets or Sets CustomerAccount

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

string Orbipay.PaymentsApi.Client.Models.PaymentResponse.ExpectedPaymentSettlementDate
getset

The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

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

Gets or Sets Fee

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

Gets or Sets FundingAccount

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

The unique identifier assigned by EBPP to the payment.

The unique identifier assigned by EBPP to the payment.

PaymentAuthorizationSnapshotResponse Orbipay.PaymentsApi.Client.Models.PaymentResponse.PaymentAuthorization
getset

Gets or Sets PaymentAuthorization

string Orbipay.PaymentsApi.Client.Models.PaymentResponse.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.PaymentResponse.PaymentEntryDate
getset

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

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

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

Gets or Sets PaymentNetworkResponse

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

string Orbipay.PaymentsApi.Client.Models.PaymentResponse.PaymentReturnDate
getset

The date on which the ACH returns is received by EBPP.

The date on which the ACH returns is received by EBPP.

string Orbipay.PaymentsApi.Client.Models.PaymentResponse.ReturnCode
getset

The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.

The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.

string Orbipay.PaymentsApi.Client.Models.PaymentResponse.Token
getset

The token is used to uniquely identify the payment, such as the POS token.

The token is used to uniquely identify the payment, such as the POS token.

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

This URL fetches the details of payment.

This URL fetches the details of payment.


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