class Bfwd::BraintreeCaptureRequest

Warning: for use only in PCI-compliant environments; for more information, <a href="contact“>support@billforward.net">contact us</a> regarding provisioning of your own on-premise BillForward instance

This entity is for specifying raw credit card details, to be captured into the Braintree vault.

Attributes

account_id[RW]

{"description":"ID of the BillForward Account with which you would like to associate the created payment method.
If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.","verbs":}

card_number[RW]

{"description":"Number of the credit card being captured.","verbs":}

cardholder_name[RW]

{"description":"Name of the person who holds the credit card being captured.","verbs":}

created[RW]

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }

cvv[RW]

{"description":"3 or 4 digit card verification value assigned to the credit card being captured.","verbs":}

default_payment_method[RW]

{"default":false,"description":"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).","verbs":}

device_data[RW]

{"description":"(Required when vaulting a PayPal payment method; otherwise optional)
A JSON string providing information about the device your customer used to fill out the card capture form. This information is inserted into your form by <a href=\"braintree-data.jsdevelopers.braintreepayments.com/javascript+node/guides/advanced-fraud-tools/client-side\">braintree-data.js> &mdash; if and only if you use Braintree's drop-in form integrations. You should ideally provide it if you have one (it aids with fraud detection), but it is only mandatory in the case of PayPal payment method vaulting.","verbs":}

expiry_month[RW]

{"description":"Expiration month of the credit card being captured, formatted MM.","verbs":}

expiry_year[RW]

{"description":"Expiration year of the credit card being captured, formatted YYYY or YY.","verbs":}

ip_address[RW]

{"description":"IP address of the customer providing the details of the credit card to be captured.","verbs":}

ip_address_country[RW]

{"description":"Country of the IP address of the customer providing the details of the credit card to be captured.","verbs":}

merchant_account_id[RW]

{"description":"Braintree <a href=\"Merchant“>articles.braintreepayments.com/control-panel/important-gateway-credentials\">Merchant account ID</a> with which you wish for the captured funding instrument to transact. Within your Braintree gateway, you can have multiple merchant accounts to process transactions for different businesses or currencies. If you have a single merchant account, it is not necessary to specify a merchant account ID in your API requests. If you have multiple merchant accounts and choose not to specify the merchant account ID, all requests will process through your default merchant account.","verbs":}

organization_id[RW]

{"description":"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.","verbs":}

Public Class Methods

attribute_map() click to toggle source

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

# File lib/bf_ruby2/models/braintree_capture_request.rb, line 59
def self.attribute_map
  {
    :'created' => :'created',
    :'organization_id' => :'organizationID',
    :'account_id' => :'accountID',
    :'default_payment_method' => :'defaultPaymentMethod',
    :'cardholder_name' => :'cardholderName',
    :'card_number' => :'cardNumber',
    :'expiry_month' => :'expiryMonth',
    :'expiry_year' => :'expiryYear',
    :'cvv' => :'cvv',
    :'device_data' => :'deviceData',
    :'merchant_account_id' => :'merchantAccountId',
    :'ip_address' => :'ipAddress',
    :'ip_address_country' => :'ipAddressCountry'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/bf_ruby2/models/braintree_capture_request.rb, line 98
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?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.has_key?(:'organizationID')
    self.organization_id = attributes[:'organizationID']
  end

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

  if attributes.has_key?(:'defaultPaymentMethod')
    self.default_payment_method = attributes[:'defaultPaymentMethod']
  else
    self.default_payment_method = false
  end

  if attributes.has_key?(:'cardholderName')
    self.cardholder_name = attributes[:'cardholderName']
  end

  if attributes.has_key?(:'cardNumber')
    self.card_number = attributes[:'cardNumber']
  end

  if attributes.has_key?(:'expiryMonth')
    self.expiry_month = attributes[:'expiryMonth']
  end

  if attributes.has_key?(:'expiryYear')
    self.expiry_year = attributes[:'expiryYear']
  end

  if attributes.has_key?(:'cvv')
    self.cvv = attributes[:'cvv']
  end

  if attributes.has_key?(:'deviceData')
    self.device_data = attributes[:'deviceData']
  end

  if attributes.has_key?(:'merchantAccountId')
    self.merchant_account_id = attributes[:'merchantAccountId']
  end

  if attributes.has_key?(:'ipAddress')
    self.ip_address = attributes[:'ipAddress']
  end

  if attributes.has_key?(:'ipAddressCountry')
    self.ip_address_country = attributes[:'ipAddressCountry']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/bf_ruby2/models/braintree_capture_request.rb, line 78
def self.swagger_types
  {
    :'created' => :'DateTime',
    :'organization_id' => :'String',
    :'account_id' => :'String',
    :'default_payment_method' => :'BOOLEAN',
    :'cardholder_name' => :'String',
    :'card_number' => :'String',
    :'expiry_month' => :'String',
    :'expiry_year' => :'String',
    :'cvv' => :'String',
    :'device_data' => :'String',
    :'merchant_account_id' => :'String',
    :'ip_address' => :'String',
    :'ip_address_country' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/bf_ruby2/models/braintree_capture_request.rb, line 200
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      organization_id == o.organization_id &&
      account_id == o.account_id &&
      default_payment_method == o.default_payment_method &&
      cardholder_name == o.cardholder_name &&
      card_number == o.card_number &&
      expiry_month == o.expiry_month &&
      expiry_year == o.expiry_year &&
      cvv == o.cvv &&
      device_data == o.device_data &&
      merchant_account_id == o.merchant_account_id &&
      ip_address == o.ip_address &&
      ip_address_country == o.ip_address_country
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/bf_ruby2/models/braintree_capture_request.rb, line 254
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = Bfwd.const_get(type).new
    temp_model.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/bf_ruby2/models/braintree_capture_request.rb, line 320
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/bf_ruby2/models/braintree_capture_request.rb, line 233
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)
        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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/bf_ruby2/models/braintree_capture_request.rb, line 220
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/bf_ruby2/models/braintree_capture_request.rb, line 226
def hash
  [created, organization_id, account_id, default_payment_method, cardholder_name, card_number, expiry_month, expiry_year, cvv, device_data, merchant_account_id, ip_address, ip_address_country].hash
end
list_invalid_properties() click to toggle source

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

# File lib/bf_ruby2/models/braintree_capture_request.rb, line 162
def list_invalid_properties
  invalid_properties = Array.new
  if @cardholder_name.nil?
    invalid_properties.push("invalid value for 'cardholder_name', cardholder_name cannot be nil.")
  end

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

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

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

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

  return invalid_properties
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/bf_ruby2/models/braintree_capture_request.rb, line 300
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/bf_ruby2/models/braintree_capture_request.rb, line 306
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() click to toggle source

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

# File lib/bf_ruby2/models/braintree_capture_request.rb, line 294
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/bf_ruby2/models/braintree_capture_request.rb, line 189
def valid?
  return false if @cardholder_name.nil?
  return false if @card_number.nil?
  return false if @expiry_month.nil?
  return false if @expiry_year.nil?
  return false if @cvv.nil?
  return true
end