Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::PaymentResponseCgen
- Inherits:
-
Object
- Object
- OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::PaymentResponseCgen
- Defined in:
- lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb
Overview
.
############################################################################################
## This class subject to change without prior notice, Please dont use this class directly.##
############################################################################################
Instance Attribute Summary collapse
-
#amount ⇒ String
readonly
The amount being paid.
-
#audit_info ⇒ AuditInfoVo
readonly
The attribute audit_info.
-
#card_cvv_number ⇒ String
readonly
This is never returned by Orbipay.
-
#comments ⇒ String
readonly
Comments that can be used to recollect the operation performed on the resource object.
-
#confirmation_number ⇒ String
readonly
The confirmation number or reference provided to the customer for the payment.
-
#currency_code3d ⇒ String
readonly
The three-letter currency code in the ISO4217 format, in uppercase, for the card account.
-
#custom_fields ⇒ Hash<String, String>
readonly
The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client.
-
#customer ⇒ CustomerSnapshotResponse
readonly
The attribute customer.
-
#customer_account ⇒ CustomerAccountSnapshotResponse
readonly
The attribute customer_account.
-
#deleted ⇒ String
readonly
The status of payment which says whether the payment is deleted or not.
-
#expected_payment_settlement_date ⇒ String
readonly
The date on which the payment is expected to be settled with the biller.
-
#fee ⇒ FeeResponse
readonly
The attribute fee.
-
#funding_account ⇒ FundingAccountSnapshotResponse
readonly
The attribute funding_account.
-
#id ⇒ String
readonly
The unique identifier assigned by Orbipay to the payment.
-
#payment_amount_type ⇒ String
readonly
The type of amount, as per the bill/statement, that is being paid.
-
#payment_date ⇒ String
readonly
The date on which the payment is scheduled to be made.
-
#payment_entry_date ⇒ String
readonly
The date on which the payment is captured in Orbipay.
-
#payment_method ⇒ String
readonly
The fulfillment method for the payment.
-
#payment_network_response ⇒ PaymentNetworkResponseVo
readonly
The attribute payment_network_response.
-
#payment_notification_email ⇒ String
readonly
The email address to which notifications for the payment will be sent.
-
#payment_reference ⇒ String
readonly
The unique identifier in the client system for the payment.
-
#payment_request_date ⇒ String
readonly
The date on which the biller wants the payment to be settled.
-
#payment_return_date ⇒ String
readonly
The date on which the ACH returns is received by Orbipay.
-
#payment_schedule_type ⇒ String
readonly
The schedule type for the payment.
-
#return_code ⇒ String
readonly
The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.
-
#status ⇒ String
readonly
The status of the payment.
-
#url ⇒ String
readonly
This URL fetches the details of payment.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash, Object
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PaymentResponseCgen
constructor
Initializes the object.
- #set_values(args) ⇒ Object
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ PaymentResponseCgen
Initializes the object
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 194 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'url') self.url = attributes[:'url'] end if attributes.has_key?(:'fee') self.fee = attributes[:'fee'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'payment_method') self.payment_method = attributes[:'payment_method'] end if attributes.has_key?(:'confirmation_number') self.confirmation_number = attributes[:'confirmation_number'] end if attributes.has_key?(:'custom_fields') if (value = attributes[:'custom_fields']).is_a?(Hash) self.custom_fields = value end end if attributes.has_key?(:'currency_code3d') self.currency_code3d = attributes[:'currency_code3d'] end if attributes.has_key?(:'amount') self.amount = attributes[:'amount'] end if attributes.has_key?(:'card_cvv_number') self.card_cvv_number = attributes[:'card_cvv_number'] end if attributes.has_key?(:'payment_date') self.payment_date = attributes[:'payment_date'] end if attributes.has_key?(:'payment_schedule_type') self.payment_schedule_type = attributes[:'payment_schedule_type'] end if attributes.has_key?(:'payment_request_date') self.payment_request_date = attributes[:'payment_request_date'] end if attributes.has_key?(:'payment_amount_type') self.payment_amount_type = attributes[:'payment_amount_type'] end if attributes.has_key?(:'payment_reference') self.payment_reference = attributes[:'payment_reference'] end if attributes.has_key?(:'expected_payment_settlement_date') self.expected_payment_settlement_date = attributes[:'expected_payment_settlement_date'] end if attributes.has_key?(:'payment_entry_date') self.payment_entry_date = attributes[:'payment_entry_date'] end if attributes.has_key?(:'payment_return_date') self.payment_return_date = attributes[:'payment_return_date'] end if attributes.has_key?(:'return_code') self.return_code = attributes[:'return_code'] end if attributes.has_key?(:'payment_notification_email') self.payment_notification_email = attributes[:'payment_notification_email'] end if attributes.has_key?(:'comments') self.comments = attributes[:'comments'] end if attributes.has_key?(:'deleted') self.deleted = attributes[:'deleted'] end if attributes.has_key?(:'customer') self.customer = attributes[:'customer'] end if attributes.has_key?(:'funding_account') self.funding_account = attributes[:'funding_account'] end if attributes.has_key?(:'customer_account') self.customer_account = attributes[:'customer_account'] end if attributes.has_key?(:'payment_network_response') self.payment_network_response = attributes[:'payment_network_response'] end if attributes.has_key?(:'audit_info') self.audit_info = attributes[:'audit_info'] end end |
Instance Attribute Details
#amount ⇒ String (readonly)
The amount being paid. In case the payment_amount_type is 'discounted_amount', 'penalty_amount' or 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.
57 58 59 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 57 def amount @amount end |
#audit_info ⇒ AuditInfoVo (readonly)
Returns The attribute audit_info.
124 125 126 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 124 def audit_info @audit_info end |
#card_cvv_number ⇒ String (readonly)
This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment with a card funding account.
61 62 63 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 61 def card_cvv_number @card_cvv_number end |
#comments ⇒ String (readonly)
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.
105 106 107 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 105 def comments @comments end |
#confirmation_number ⇒ String (readonly)
The confirmation number or reference provided to the customer for the payment.
45 46 47 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 45 def confirmation_number @confirmation_number end |
#currency_code3d ⇒ String (readonly)
The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD.
53 54 55 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 53 def currency_code3d @currency_code3d end |
#custom_fields ⇒ Hash<String, String> (readonly)
The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href = "mailto: support@billerpayments.com">support@billerpayments.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests.
49 50 51 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 49 def custom_fields @custom_fields end |
#customer ⇒ CustomerSnapshotResponse (readonly)
Returns The attribute customer.
112 113 114 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 112 def customer @customer end |
#customer_account ⇒ CustomerAccountSnapshotResponse (readonly)
Returns The attribute customer_account.
118 119 120 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 118 def customer_account @customer_account end |
#deleted ⇒ String (readonly)
The status of payment which says whether the payment is deleted or not
109 110 111 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 109 def deleted @deleted end |
#expected_payment_settlement_date ⇒ String (readonly)
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.
85 86 87 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 85 def expected_payment_settlement_date @expected_payment_settlement_date end |
#fee ⇒ FeeResponse (readonly)
Returns The attribute fee.
33 34 35 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 33 def fee @fee end |
#funding_account ⇒ FundingAccountSnapshotResponse (readonly)
Returns The attribute funding_account.
115 116 117 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 115 def funding_account @funding_account end |
#id ⇒ String (readonly)
The unique identifier assigned by Orbipay to the payment.
26 27 28 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 26 def id @id end |
#payment_amount_type ⇒ String (readonly)
The 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.
77 78 79 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 77 def payment_amount_type @payment_amount_type end |
#payment_date ⇒ String (readonly)
The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
65 66 67 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 65 def payment_date @payment_date end |
#payment_entry_date ⇒ String (readonly)
The date on which the payment is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
89 90 91 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 89 def payment_entry_date @payment_entry_date end |
#payment_method ⇒ String (readonly)
The fulfillment method for the payment.
41 42 43 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 41 def payment_method @payment_method end |
#payment_network_response ⇒ PaymentNetworkResponseVo (readonly)
Returns The attribute payment_network_response.
121 122 123 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 121 def payment_network_response @payment_network_response end |
#payment_notification_email ⇒ String (readonly)
The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.
101 102 103 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 101 def payment_notification_email @payment_notification_email end |
#payment_reference ⇒ String (readonly)
The unique identifier in the client system for the payment.
81 82 83 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 81 def payment_reference @payment_reference end |
#payment_request_date ⇒ String (readonly)
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.
73 74 75 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 73 def payment_request_date @payment_request_date end |
#payment_return_date ⇒ String (readonly)
The date on which the ACH returns is received by Orbipay.
93 94 95 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 93 def payment_return_date @payment_return_date end |
#payment_schedule_type ⇒ String (readonly)
The schedule type for the payment. This defaults to one_time_payment.
69 70 71 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 69 def payment_schedule_type @payment_schedule_type end |
#return_code ⇒ String (readonly)
The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.
97 98 99 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 97 def return_code @return_code end |
#status ⇒ String (readonly)
The status of the payment.
37 38 39 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 37 def status @status end |
#url ⇒ String (readonly)
This URL fetches the details of payment.
30 31 32 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 30 def url @url end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 127 def self.attribute_map { :'id' => :'id', :'url' => :'url', :'fee' => :'fee', :'status' => :'status', :'payment_method' => :'payment_method', :'confirmation_number' => :'confirmation_number', :'custom_fields' => :'custom_fields', :'currency_code3d' => :'currency_code3d', :'amount' => :'amount', :'card_cvv_number' => :'card_cvv_number', :'payment_date' => :'payment_date', :'payment_schedule_type' => :'payment_schedule_type', :'payment_request_date' => :'payment_request_date', :'payment_amount_type' => :'payment_amount_type', :'payment_reference' => :'payment_reference', :'expected_payment_settlement_date' => :'expected_payment_settlement_date', :'payment_entry_date' => :'payment_entry_date', :'payment_return_date' => :'payment_return_date', :'return_code' => :'return_code', :'payment_notification_email' => :'payment_notification_email', :'comments' => :'comments', :'deleted' => :'deleted', :'customer' => :'customer', :'funding_account' => :'funding_account', :'customer_account' => :'customer_account', :'payment_network_response' => :'payment_network_response', :'audit_info' => :'audit_info' } end |
.swagger_types ⇒ Object
Attribute type mapping.
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 160 def self.swagger_types { :'id' => :'String', :'url' => :'String', :'fee' => :'FeeResponse', :'status' => :'String', :'payment_method' => :'String', :'confirmation_number' => :'String', :'custom_fields' => :'Hash<String, String>', :'currency_code3d' => :'String', :'amount' => :'String', :'card_cvv_number' => :'String', :'payment_date' => :'String', :'payment_schedule_type' => :'String', :'payment_request_date' => :'String', :'payment_amount_type' => :'String', :'payment_reference' => :'String', :'expected_payment_settlement_date' => :'String', :'payment_entry_date' => :'String', :'payment_return_date' => :'String', :'return_code' => :'String', :'payment_notification_email' => :'String', :'comments' => :'String', :'deleted' => :'String', :'customer' => :'CustomerSnapshotResponse', :'funding_account' => :'FundingAccountSnapshotResponse', :'customer_account' => :'CustomerAccountSnapshotResponse', :'payment_network_response' => :'PaymentNetworkResponseVo', :'audit_info' => :'AuditInfoVo' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 322 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && url == o.url && fee == o.fee && status == o.status && payment_method == o.payment_method && confirmation_number == o.confirmation_number && custom_fields == o.custom_fields && currency_code3d == o.currency_code3d && amount == o.amount && card_cvv_number == o.card_cvv_number && payment_date == o.payment_date && payment_schedule_type == o.payment_schedule_type && payment_request_date == o.payment_request_date && payment_amount_type == o.payment_amount_type && payment_reference == o.payment_reference && expected_payment_settlement_date == o.expected_payment_settlement_date && payment_entry_date == o.payment_entry_date && payment_return_date == o.payment_return_date && return_code == o.return_code && payment_notification_email == o.payment_notification_email && comments == o.comments && deleted == o.deleted && customer == o.customer && funding_account == o.funding_account && customer_account == o.customer_account && payment_network_response == o.payment_network_response && audit_info == o.audit_info end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 390 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String if value.nil? value else value.to_s end when :Integer if value.nil? value else value.to_i end when :Float if value.nil? value else value.to_f end when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash, Object
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
469 470 471 472 473 474 475 476 477 478 479 480 481 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 469 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 369 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) set_values(key => attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? set_values(key => _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
356 357 358 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 356 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
362 363 364 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 362 def hash [id, url, fee, status, payment_method, confirmation_number, custom_fields, currency_code3d, amount, card_cvv_number, payment_date, payment_schedule_type, payment_request_date, payment_amount_type, payment_reference, expected_payment_settlement_date, payment_entry_date, payment_return_date, return_code, payment_notification_email, comments, deleted, customer, funding_account, customer_account, payment_network_response, audit_info].hash end |
#set_values(args) ⇒ Object
312 313 314 315 316 317 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 312 def set_values(args) args.each do |attr, arg| (class << self; self; end).send(:attr_reader, attr.to_sym) instance_variable_set("@#{attr}", arg) end end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
448 449 450 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 448 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
454 455 456 457 458 459 460 461 462 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 454 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
442 443 444 |
# File 'lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb', line 442 def to_s to_hash.to_s end |