class Plaid::Transfer

Represents a transfer within the Transfers API.

Attributes

account_id[RW]

The Plaid ‘account_id` corresponding to the end-user account that will be debited or credited.

ach_class[RW]
amount[RW]

The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling ‘/transfer/authorization/create`, specify the maximum amount to authorize. When calling `/transfer/create`, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling `/transfer/create`, the maximum amount authorized in the `authorization_id` will be sent.

authorization_id[RW]

Plaid’s unique identifier for a transfer authorization.

cancellable[RW]

When ‘true`, you can still cancel this transfer.

created[RW]

The datetime when this transfer was created. This will be of the form ‘2006-01-02T15:04:05Z`

credit_funds_source[RW]
description[RW]

The description of the transfer.

expected_settlement_date[RW]

The date when settlement will occur between Plaid and the receiving bank (RDFI). For ACH debits, this is the date funds will be pulled from the bank account being debited. For ACH credits, this is the date funds will be delivered to the bank account being credited. Only set for ACH transfers; ‘null` for non-ACH transfers. This will be of the form YYYY-MM-DD.

expected_sweep_settlement_schedule[RW]

The expected sweep settlement schedule of this transfer, assuming this transfer is not ‘returned`. Only applies to ACH debit transfers.

facilitator_fee[RW]

The amount to deduct from ‘transfer.amount` and distribute to the platform’s Ledger balance as a facilitator fee (decimal string with two digits of precision e.g. "10.00"). The remainder will go to the end-customer’s Ledger balance. This must be less than or equal to the `transfer.amount`.

failure_reason[RW]
funding_account_id[RW]

The id of the associated funding account, available in the Plaid Dashboard. If present, this indicates which of your business checking accounts will be credited or debited.

guarantee_decision[RW]
guarantee_decision_rationale[RW]
id[RW]

Plaid’s unique identifier for a transfer.

iso_currency_code[RW]

The currency of the transfer amount, e.g. "USD"

ledger_id[RW]

Plaid’s unique identifier for a Plaid Ledger Balance.

metadata[RW]

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: The JSON values must be Strings (no nested JSON objects allowed) Only ASCII characters may be used Maximum of 50 key/value pairs Maximum key length of 40 characters Maximum value length of 500 characters

network[RW]
network_trace_id[RW]

The trace identifier for the transfer based on its network. This will only be set after the transfer has posted. For ‘ach` or `same-day-ach` transfers, this is the ACH trace number. For `rtp` transfers, this is the Transaction Identification number. For `wire` transfers, this is the IMAD (Input Message Accountability Data) number.

origination_account_id[RW]

Plaid’s unique identifier for the origination account that was used for this transfer.

originator_client_id[RW]

The Plaid client ID that is the originator of this transfer. Only present if created on behalf of another client as a [Platform customer](plaid.com/docs/transfer/application/#originators-vs-platforms).

recurring_transfer_id[RW]

The id of the recurring transfer if this transfer belongs to a recurring transfer.

refunds[RW]

A list of refunds associated with this transfer.

standard_return_window[RW]

The date 3 business days from settlement date indicating the following ACH returns can no longer happen: R01, R02, R03, R29. This will be of the form YYYY-MM-DD.

status[RW]
sweep_status[RW]
type[RW]
unauthorized_return_window[RW]

The date 61 business days from settlement date indicating the following ACH returns can no longer happen: R05, R07, R10, R11, R51, R33, R37, R38, R51, R52, R53. This will be of the form YYYY-MM-DD.

user[RW]
wire_details[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/transfer.rb, line 165
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/plaid/models/transfer.rb, line 127
def self.attribute_map
  {
    :'id' => :'id',
    :'authorization_id' => :'authorization_id',
    :'ach_class' => :'ach_class',
    :'account_id' => :'account_id',
    :'funding_account_id' => :'funding_account_id',
    :'ledger_id' => :'ledger_id',
    :'type' => :'type',
    :'user' => :'user',
    :'amount' => :'amount',
    :'description' => :'description',
    :'created' => :'created',
    :'status' => :'status',
    :'sweep_status' => :'sweep_status',
    :'network' => :'network',
    :'wire_details' => :'wire_details',
    :'cancellable' => :'cancellable',
    :'failure_reason' => :'failure_reason',
    :'metadata' => :'metadata',
    :'origination_account_id' => :'origination_account_id',
    :'guarantee_decision' => :'guarantee_decision',
    :'guarantee_decision_rationale' => :'guarantee_decision_rationale',
    :'iso_currency_code' => :'iso_currency_code',
    :'standard_return_window' => :'standard_return_window',
    :'unauthorized_return_window' => :'unauthorized_return_window',
    :'expected_settlement_date' => :'expected_settlement_date',
    :'originator_client_id' => :'originator_client_id',
    :'refunds' => :'refunds',
    :'recurring_transfer_id' => :'recurring_transfer_id',
    :'expected_sweep_settlement_schedule' => :'expected_sweep_settlement_schedule',
    :'credit_funds_source' => :'credit_funds_source',
    :'facilitator_fee' => :'facilitator_fee',
    :'network_trace_id' => :'network_trace_id'
  }
end
build_from_hash(attributes) click to toggle source

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/transfer.rb, line 523
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/plaid/models/transfer.rb, line 229
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::Transfer` 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::Transfer`. 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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'authorization_id')
    self.authorization_id = attributes[:'authorization_id']
  end

  if attributes.key?(:'ach_class')
    self.ach_class = attributes[:'ach_class']
  end

  if attributes.key?(:'account_id')
    self.account_id = attributes[:'account_id']
  end

  if attributes.key?(:'funding_account_id')
    self.funding_account_id = attributes[:'funding_account_id']
  end

  if attributes.key?(:'ledger_id')
    self.ledger_id = attributes[:'ledger_id']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'user')
    self.user = attributes[:'user']
  end

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'sweep_status')
    self.sweep_status = attributes[:'sweep_status']
  end

  if attributes.key?(:'network')
    self.network = attributes[:'network']
  end

  if attributes.key?(:'wire_details')
    self.wire_details = attributes[:'wire_details']
  end

  if attributes.key?(:'cancellable')
    self.cancellable = attributes[:'cancellable']
  end

  if attributes.key?(:'failure_reason')
    self.failure_reason = attributes[:'failure_reason']
  end

  if attributes.key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

  if attributes.key?(:'origination_account_id')
    self.origination_account_id = attributes[:'origination_account_id']
  end

  if attributes.key?(:'guarantee_decision')
    self.guarantee_decision = attributes[:'guarantee_decision']
  end

  if attributes.key?(:'guarantee_decision_rationale')
    self.guarantee_decision_rationale = attributes[:'guarantee_decision_rationale']
  end

  if attributes.key?(:'iso_currency_code')
    self.iso_currency_code = attributes[:'iso_currency_code']
  end

  if attributes.key?(:'standard_return_window')
    self.standard_return_window = attributes[:'standard_return_window']
  end

  if attributes.key?(:'unauthorized_return_window')
    self.unauthorized_return_window = attributes[:'unauthorized_return_window']
  end

  if attributes.key?(:'expected_settlement_date')
    self.expected_settlement_date = attributes[:'expected_settlement_date']
  end

  if attributes.key?(:'originator_client_id')
    self.originator_client_id = attributes[:'originator_client_id']
  end

  if attributes.key?(:'refunds')
    if (value = attributes[:'refunds']).is_a?(Array)
      self.refunds = value
    end
  end

  if attributes.key?(:'recurring_transfer_id')
    self.recurring_transfer_id = attributes[:'recurring_transfer_id']
  end

  if attributes.key?(:'expected_sweep_settlement_schedule')
    if (value = attributes[:'expected_sweep_settlement_schedule']).is_a?(Array)
      self.expected_sweep_settlement_schedule = value
    end
  end

  if attributes.key?(:'credit_funds_source')
    self.credit_funds_source = attributes[:'credit_funds_source']
  end

  if attributes.key?(:'facilitator_fee')
    self.facilitator_fee = attributes[:'facilitator_fee']
  end

  if attributes.key?(:'network_trace_id')
    self.network_trace_id = attributes[:'network_trace_id']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/plaid/models/transfer.rb, line 208
def self.openapi_nullable
  Set.new([
    :'funding_account_id',
    :'ledger_id',
    :'sweep_status',
    :'wire_details',
    :'failure_reason',
    :'metadata',
    :'guarantee_decision',
    :'guarantee_decision_rationale',
    :'standard_return_window',
    :'unauthorized_return_window',
    :'expected_settlement_date',
    :'originator_client_id',
    :'recurring_transfer_id',
    :'network_trace_id'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/transfer.rb, line 170
def self.openapi_types
  {
    :'id' => :'String',
    :'authorization_id' => :'String',
    :'ach_class' => :'ACHClass',
    :'account_id' => :'String',
    :'funding_account_id' => :'String',
    :'ledger_id' => :'String',
    :'type' => :'TransferType',
    :'user' => :'TransferUserInResponse',
    :'amount' => :'String',
    :'description' => :'String',
    :'created' => :'Time',
    :'status' => :'TransferStatus',
    :'sweep_status' => :'TransferSweepStatus',
    :'network' => :'TransferNetwork',
    :'wire_details' => :'TransferWireDetails',
    :'cancellable' => :'Boolean',
    :'failure_reason' => :'TransferFailure',
    :'metadata' => :'Hash<String, String>',
    :'origination_account_id' => :'String',
    :'guarantee_decision' => :'TransferAuthorizationGuaranteeDecision',
    :'guarantee_decision_rationale' => :'TransferAuthorizationGuaranteeDecisionRationale',
    :'iso_currency_code' => :'String',
    :'standard_return_window' => :'Date',
    :'unauthorized_return_window' => :'Date',
    :'expected_settlement_date' => :'Date',
    :'originator_client_id' => :'String',
    :'refunds' => :'Array<TransferRefund>',
    :'recurring_transfer_id' => :'String',
    :'expected_sweep_settlement_schedule' => :'Array<TransferExpectedSweepSettlementScheduleItem>',
    :'credit_funds_source' => :'TransferCreditFundsSource',
    :'facilitator_fee' => :'String',
    :'network_trace_id' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/plaid/models/transfer.rb, line 471
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      authorization_id == o.authorization_id &&
      ach_class == o.ach_class &&
      account_id == o.account_id &&
      funding_account_id == o.funding_account_id &&
      ledger_id == o.ledger_id &&
      type == o.type &&
      user == o.user &&
      amount == o.amount &&
      description == o.description &&
      created == o.created &&
      status == o.status &&
      sweep_status == o.sweep_status &&
      network == o.network &&
      wire_details == o.wire_details &&
      cancellable == o.cancellable &&
      failure_reason == o.failure_reason &&
      metadata == o.metadata &&
      origination_account_id == o.origination_account_id &&
      guarantee_decision == o.guarantee_decision &&
      guarantee_decision_rationale == o.guarantee_decision_rationale &&
      iso_currency_code == o.iso_currency_code &&
      standard_return_window == o.standard_return_window &&
      unauthorized_return_window == o.unauthorized_return_window &&
      expected_settlement_date == o.expected_settlement_date &&
      originator_client_id == o.originator_client_id &&
      refunds == o.refunds &&
      recurring_transfer_id == o.recurring_transfer_id &&
      expected_sweep_settlement_schedule == o.expected_sweep_settlement_schedule &&
      credit_funds_source == o.credit_funds_source &&
      facilitator_fee == o.facilitator_fee &&
      network_trace_id == o.network_trace_id
end
_deserialize(type, value) click to toggle source

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/transfer.rb, line 554
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
_to_hash(value) click to toggle source

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/transfer.rb, line 625
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) click to toggle source

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/transfer.rb, line 530
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
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/plaid/models/transfer.rb, line 510
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/plaid/models/transfer.rb, line 516
def hash
  [id, authorization_id, ach_class, account_id, funding_account_id, ledger_id, type, user, amount, description, created, status, sweep_status, network, wire_details, cancellable, failure_reason, metadata, origination_account_id, guarantee_decision, guarantee_decision_rationale, iso_currency_code, standard_return_window, unauthorized_return_window, expected_settlement_date, originator_client_id, refunds, recurring_transfer_id, expected_sweep_settlement_schedule, credit_funds_source, facilitator_fee, network_trace_id].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/plaid/models/transfer.rb, line 379
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @authorization_id.nil?
    invalid_properties.push('invalid value for "authorization_id", authorization_id cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @user.nil?
    invalid_properties.push('invalid value for "user", user cannot be nil.')
  end

  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @created.nil?
    invalid_properties.push('invalid value for "created", created cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @network.nil?
    invalid_properties.push('invalid value for "network", network cannot be nil.')
  end

  if @cancellable.nil?
    invalid_properties.push('invalid value for "cancellable", cancellable cannot be nil.')
  end


  if @origination_account_id.nil?
    invalid_properties.push('invalid value for "origination_account_id", origination_account_id cannot be nil.')
  end

  if @iso_currency_code.nil?
    invalid_properties.push('invalid value for "iso_currency_code", iso_currency_code cannot be nil.')
  end

  if @refunds.nil?
    invalid_properties.push('invalid value for "refunds", refunds cannot be nil.')
  end

  if @credit_funds_source.nil?
    invalid_properties.push('invalid value for "credit_funds_source", credit_funds_source cannot be nil.')
  end

  invalid_properties
end
metadata=(metadata) click to toggle source

Custom attribute writer method with validation @param [Object] metadata Value to be assigned

# File lib/plaid/models/transfer.rb, line 464
def metadata=(metadata)

  @metadata = metadata
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/transfer.rb, line 601
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/transfer.rb, line 607
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/plaid/models/transfer.rb, line 595
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/plaid/models/transfer.rb, line 443
def valid?
  return false if @id.nil?
  return false if @authorization_id.nil?
  return false if @type.nil?
  return false if @user.nil?
  return false if @amount.nil?
  return false if @description.nil?
  return false if @created.nil?
  return false if @status.nil?
  return false if @network.nil?
  return false if @cancellable.nil?
  return false if @metadata.length > 50
  return false if @origination_account_id.nil?
  return false if @iso_currency_code.nil?
  return false if @refunds.nil?
  return false if @credit_funds_source.nil?
  true
end