class Plaid::WalletTransaction
The transaction details
Attributes
Timestamp when the transaction was created, in [ISO 8601](wikipedia.org/wiki/ISO_8601) format.
The date and time of the last time the ‘status` was updated, in IS0 8601 format
The payment id that this transaction is associated with, if any. This is present only for transaction types ‘PIS_PAY_IN` and `REFUND`.
A reference for the transaction
A unique ID identifying the transaction
The type of the transaction. The supported transaction types that are returned are: ‘BANK_TRANSFER:` a transaction which credits an e-wallet through an external bank transfer. `PAYOUT:` a transaction which debits an e-wallet by disbursing funds to a counterparty. `PIS_PAY_IN:` a payment which credits an e-wallet through Plaid’s Payment Initiation Services
(PIS) APIs. For more information see the [Payment Initiation endpoints](plaid.com/docs/api/products/payment-initiation/). ‘REFUND:` a transaction which debits an e-wallet by refunding a previously initiated payment made through Plaid’s [PIS APIs](plaid.com/docs/api/products/payment-initiation/). ‘FUNDS_SWEEP`: an automated transaction which debits funds from an e-wallet to a designated client-owned account. `RETURN`: an automated transaction where a debit transaction was reversed and money moved back to originating account. `RECALL`: a transaction where the sending bank has requested the return of funds due to a fraud claim, technical error, or other issue associated with the payment.
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
Returns all the JSON keys this model knows about
# File lib/plaid/models/wallet_transaction.rb, line 95 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/wallet_transaction.rb, line 76 def self.attribute_map { :'transaction_id' => :'transaction_id', :'wallet_id' => :'wallet_id', :'reference' => :'reference', :'type' => :'type', :'scheme' => :'scheme', :'amount' => :'amount', :'counterparty' => :'counterparty', :'status' => :'status', :'created_at' => :'created_at', :'last_status_update' => :'last_status_update', :'payment_id' => :'payment_id', :'failure_reason' => :'failure_reason', :'related_transactions' => :'related_transactions' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/wallet_transaction.rb, line 302 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/plaid/models/wallet_transaction.rb, line 129 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::WalletTransaction` 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::WalletTransaction`. 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?(:'transaction_id') self.transaction_id = attributes[:'transaction_id'] end if attributes.key?(:'wallet_id') self.wallet_id = attributes[:'wallet_id'] end if attributes.key?(:'reference') self.reference = attributes[:'reference'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'scheme') self.scheme = attributes[:'scheme'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'counterparty') self.counterparty = attributes[:'counterparty'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'last_status_update') self.last_status_update = attributes[:'last_status_update'] end if attributes.key?(:'payment_id') self.payment_id = attributes[:'payment_id'] end if attributes.key?(:'failure_reason') self.failure_reason = attributes[:'failure_reason'] end if attributes.key?(:'related_transactions') if (value = attributes[:'related_transactions']).is_a?(Array) self.related_transactions = value end end end
List of attributes with nullable: true
# File lib/plaid/models/wallet_transaction.rb, line 119 def self.openapi_nullable Set.new([ :'scheme', :'payment_id', :'failure_reason', ]) end
Attribute type mapping.
# File lib/plaid/models/wallet_transaction.rb, line 100 def self.openapi_types { :'transaction_id' => :'String', :'wallet_id' => :'String', :'reference' => :'String', :'type' => :'String', :'scheme' => :'WalletPaymentScheme', :'amount' => :'WalletTransactionAmount', :'counterparty' => :'WalletTransactionCounterparty', :'status' => :'WalletTransactionStatus', :'created_at' => :'Time', :'last_status_update' => :'Time', :'payment_id' => :'String', :'failure_reason' => :'WalletTransactionFailureReason', :'related_transactions' => :'Array<WalletTransactionRelation>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/wallet_transaction.rb, line 269 def ==(o) return true if self.equal?(o) self.class == o.class && transaction_id == o.transaction_id && wallet_id == o.wallet_id && reference == o.reference && type == o.type && scheme == o.scheme && amount == o.amount && counterparty == o.counterparty && status == o.status && created_at == o.created_at && last_status_update == o.last_status_update && payment_id == o.payment_id && failure_reason == o.failure_reason && related_transactions == o.related_transactions end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/plaid/models/wallet_transaction.rb, line 333 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
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
# File lib/plaid/models/wallet_transaction.rb, line 404 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/wallet_transaction.rb, line 309 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/plaid/models/wallet_transaction.rb, line 289 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/wallet_transaction.rb, line 295 def hash [transaction_id, wallet_id, reference, type, scheme, amount, counterparty, status, created_at, last_status_update, payment_id, failure_reason, related_transactions].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/plaid/models/wallet_transaction.rb, line 199 def list_invalid_properties invalid_properties = Array.new if @transaction_id.nil? invalid_properties.push('invalid value for "transaction_id", transaction_id cannot be nil.') end if @wallet_id.nil? invalid_properties.push('invalid value for "wallet_id", wallet_id cannot be nil.') end if @reference.nil? invalid_properties.push('invalid value for "reference", reference cannot be nil.') end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @counterparty.nil? invalid_properties.push('invalid value for "counterparty", counterparty cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @created_at.nil? invalid_properties.push('invalid value for "created_at", created_at 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/plaid/models/wallet_transaction.rb, line 386 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 string representation of the object @return [String] String presentation of the object
# File lib/plaid/models/wallet_transaction.rb, line 374 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/plaid/models/wallet_transaction.rb, line 259 def type=(type) validator = EnumAttributeValidator.new('String', ["BANK_TRANSFER", "PAYOUT", "PIS_PAY_IN", "REFUND", "FUNDS_SWEEP", "RETURN", "RECALL"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/plaid/models/wallet_transaction.rb, line 242 def valid? return false if @transaction_id.nil? return false if @wallet_id.nil? return false if @reference.nil? return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ["BANK_TRANSFER", "PAYOUT", "PIS_PAY_IN", "REFUND", "FUNDS_SWEEP", "RETURN", "RECALL"]) return false unless type_validator.valid?(@type) return false if @amount.nil? return false if @counterparty.nil? return false if @status.nil? return false if @created_at.nil? return false if @last_status_update.nil? true end