class Plaid::PaymentInitiationPayment
PaymentInitiationPayment
defines a payment initiation payment
Attributes
The value of the reference sent to the bank after adjustment to pass bank validation rules.
The payment consent ID that this payment was initiated with. Is present only when payment was initiated using the payment consent.
A unique identifier assigned by Plaid
to each payment for tracking and reconciliation purposes. Note: Not all banks handle ‘end_to_end_id` consistently. To ensure accurate matching, clients should convert both the incoming `end_to_end_id` and the one provided by Plaid
to the same case (either lower or upper) before comparison. For virtual account payments, Plaid
manages this field automatically.
The International Bank Account Number (IBAN) for the sender, if specified in the ‘/payment_initiation/payment/create` call.
The date and time of the last time the ‘status` was updated, in IS0 8601 format
The ID of the payment. Like all Plaid
identifiers, the ‘payment_id` is case sensitive.
The ID of the recipient
A reference for the payment.
Refund IDs associated with the payment.
The transaction ID that this payment is associated with, if any. This is present only when a payment was initiated using virtual accounts.
The EMI (E-Money Institution
) wallet that this payment is associated with, if any. This wallet is used as an intermediary account to enable Plaid
to reconcile the settlement of funds for Payment Initiation requests.
Public Class Methods
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 119 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 93 def self.attribute_map { :'payment_id' => :'payment_id', :'amount' => :'amount', :'status' => :'status', :'recipient_id' => :'recipient_id', :'reference' => :'reference', :'adjusted_reference' => :'adjusted_reference', :'last_status_update' => :'last_status_update', :'schedule' => :'schedule', :'refund_details' => :'refund_details', :'bacs' => :'bacs', :'iban' => :'iban', :'refund_ids' => :'refund_ids', :'amount_refunded' => :'amount_refunded', :'wallet_id' => :'wallet_id', :'scheme' => :'scheme', :'adjusted_scheme' => :'adjusted_scheme', :'consent_id' => :'consent_id', :'transaction_id' => :'transaction_id', :'end_to_end_id' => :'end_to_end_id', :'error' => :'error' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 351 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 170 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::PaymentInitiationPayment` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::PaymentInitiationPayment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'payment_id') self.payment_id = attributes[:'payment_id'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'recipient_id') self.recipient_id = attributes[:'recipient_id'] end if attributes.key?(:'reference') self.reference = attributes[:'reference'] end if attributes.key?(:'adjusted_reference') self.adjusted_reference = attributes[:'adjusted_reference'] end if attributes.key?(:'last_status_update') self.last_status_update = attributes[:'last_status_update'] end if attributes.key?(:'schedule') self.schedule = attributes[:'schedule'] end if attributes.key?(:'refund_details') self.refund_details = attributes[:'refund_details'] end if attributes.key?(:'bacs') self.bacs = attributes[:'bacs'] end if attributes.key?(:'iban') self.iban = attributes[:'iban'] end if attributes.key?(:'refund_ids') if (value = attributes[:'refund_ids']).is_a?(Array) self.refund_ids = value end end if attributes.key?(:'amount_refunded') self.amount_refunded = attributes[:'amount_refunded'] end if attributes.key?(:'wallet_id') self.wallet_id = attributes[:'wallet_id'] end if attributes.key?(:'scheme') self.scheme = attributes[:'scheme'] end if attributes.key?(:'adjusted_scheme') self.adjusted_scheme = attributes[:'adjusted_scheme'] end if attributes.key?(:'consent_id') self.consent_id = attributes[:'consent_id'] end if attributes.key?(:'transaction_id') self.transaction_id = attributes[:'transaction_id'] end if attributes.key?(:'end_to_end_id') self.end_to_end_id = attributes[:'end_to_end_id'] end if attributes.key?(:'error') self.error = attributes[:'error'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 150 def self.openapi_nullable Set.new([ :'adjusted_reference', :'schedule', :'refund_details', :'bacs', :'iban', :'refund_ids', :'wallet_id', :'scheme', :'adjusted_scheme', :'consent_id', :'transaction_id', :'end_to_end_id', :'error' ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 124 def self.openapi_types { :'payment_id' => :'String', :'amount' => :'PaymentAmount', :'status' => :'PaymentInitiationPaymentStatus', :'recipient_id' => :'String', :'reference' => :'String', :'adjusted_reference' => :'String', :'last_status_update' => :'Time', :'schedule' => :'ExternalPaymentScheduleGet', :'refund_details' => :'ExternalPaymentRefundDetails', :'bacs' => :'SenderBACSNullable', :'iban' => :'String', :'refund_ids' => :'Array<String>', :'amount_refunded' => :'PaymentAmountRefunded', :'wallet_id' => :'String', :'scheme' => :'PaymentScheme', :'adjusted_scheme' => :'PaymentScheme', :'consent_id' => :'String', :'transaction_id' => :'String', :'end_to_end_id' => :'String', :'error' => :'PlaidError' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 311 def ==(o) return true if self.equal?(o) self.class == o.class && payment_id == o.payment_id && amount == o.amount && status == o.status && recipient_id == o.recipient_id && reference == o.reference && adjusted_reference == o.adjusted_reference && last_status_update == o.last_status_update && schedule == o.schedule && refund_details == o.refund_details && bacs == o.bacs && iban == o.iban && refund_ids == o.refund_ids && amount_refunded == o.amount_refunded && wallet_id == o.wallet_id && scheme == o.scheme && adjusted_scheme == o.adjusted_scheme && consent_id == o.consent_id && transaction_id == o.transaction_id && end_to_end_id == o.end_to_end_id && error == o.error end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 382 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f 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 # models (e.g. Pet) or oneOf klass = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 453 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 358 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 338 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 344 def hash [payment_id, amount, status, recipient_id, reference, adjusted_reference, last_status_update, schedule, refund_details, bacs, iban, refund_ids, amount_refunded, wallet_id, scheme, adjusted_scheme, consent_id, transaction_id, end_to_end_id, error].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 268 def list_invalid_properties invalid_properties = Array.new if @payment_id.nil? invalid_properties.push('invalid value for "payment_id", payment_id cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @recipient_id.nil? invalid_properties.push('invalid value for "recipient_id", recipient_id cannot be nil.') end if @reference.nil? invalid_properties.push('invalid value for "reference", reference cannot be nil.') end if @last_status_update.nil? invalid_properties.push('invalid value for "last_status_update", last_status_update cannot be nil.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 435 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 423 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/payment_initiation_payment.rb, line 299 def valid? return false if @payment_id.nil? return false if @amount.nil? return false if @status.nil? return false if @recipient_id.nil? return false if @reference.nil? return false if @last_status_update.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid