class SquareConnect::V1Tender
A tender represents a discrete monetary exchange. Square represents this exchange as a money object with a specific currency and amount, where the amount is given in the smallest denomination of the given currency. Square POS can accept more than one form of tender for a single payment (such as by splitting a bill between a credit card and a gift card). The `tender` field of the Payment object lists all forms of tender used for the payment. Split tender payments behave slightly differently from single tender payments: The receipt_url
for a split tender corresponds only to the first tender listed in the tender field. To get the receipt URLs for the remaining tenders, use the receipt_url
fields of the corresponding Tender
objects. *A note on gift cards**: when a customer purchases a Square gift card from a merchant, the merchant receives the full amount of the gift card in the associated payment. When that gift card is used as a tender, the balance of the gift card is reduced and the merchant receives no funds. A `Tender` object with a type of `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the associated payment.
Attributes
The brand of credit card provided. See [V1TenderCardBrand](type
-v1tendercardbrand) for possible values
The amount of total_money
returned to the buyer as change.
The ID of the employee that processed the tender.
The tender's unique ID. See [V1TenderEntryMethod](type
-v1tenderentrymethod) for possible values
The tender's unique ID.
Indicates whether or not the tender is associated with an exchange. If is_exchange
is true, the tender represents the value of goods returned in an exchange not the actual money paid. The exchange value reduces the tender amounts needed to pay for items purchased in the exchange.
A human-readable description of the tender.
The last four digits of the provided credit card's account number.
Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER.
The URL of the receipt for the tender.
The total of all refunds applied to this tender. This amount is always negative or zero.
The time when the tender was settled, in ISO 8601 format.
The time when the tender was created, in ISO 8601 format.
The amount of total_money
applied to the payment.
The total amount of money provided in this form of tender.
The type of tender. See [V1TenderType](type
-v1tendertype) for possible values
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/v1_tender.rb, line 65 def self.attribute_map { :'id' => :'id', :'type' => :'type', :'name' => :'name', :'employee_id' => :'employee_id', :'receipt_url' => :'receipt_url', :'card_brand' => :'card_brand', :'pan_suffix' => :'pan_suffix', :'entry_method' => :'entry_method', :'payment_note' => :'payment_note', :'total_money' => :'total_money', :'tendered_money' => :'tendered_money', :'tendered_at' => :'tendered_at', :'settled_at' => :'settled_at', :'change_back_money' => :'change_back_money', :'refunded_money' => :'refunded_money', :'is_exchange' => :'is_exchange' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/v1_tender.rb, line 110 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?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'employee_id') self.employee_id = attributes[:'employee_id'] end if attributes.has_key?(:'receipt_url') self.receipt_url = attributes[:'receipt_url'] end if attributes.has_key?(:'card_brand') self.card_brand = attributes[:'card_brand'] end if attributes.has_key?(:'pan_suffix') self.pan_suffix = attributes[:'pan_suffix'] end if attributes.has_key?(:'entry_method') self.entry_method = attributes[:'entry_method'] end if attributes.has_key?(:'payment_note') self.payment_note = attributes[:'payment_note'] end if attributes.has_key?(:'total_money') self.total_money = attributes[:'total_money'] end if attributes.has_key?(:'tendered_money') self.tendered_money = attributes[:'tendered_money'] end if attributes.has_key?(:'tendered_at') self.tendered_at = attributes[:'tendered_at'] end if attributes.has_key?(:'settled_at') self.settled_at = attributes[:'settled_at'] end if attributes.has_key?(:'change_back_money') self.change_back_money = attributes[:'change_back_money'] end if attributes.has_key?(:'refunded_money') self.refunded_money = attributes[:'refunded_money'] end if attributes.has_key?(:'is_exchange') self.is_exchange = attributes[:'is_exchange'] end end
Attribute type mapping.
# File lib/square_connect/models/v1_tender.rb, line 87 def self.swagger_types { :'id' => :'String', :'type' => :'String', :'name' => :'String', :'employee_id' => :'String', :'receipt_url' => :'String', :'card_brand' => :'String', :'pan_suffix' => :'String', :'entry_method' => :'String', :'payment_note' => :'String', :'total_money' => :'V1Money', :'tendered_money' => :'V1Money', :'tendered_at' => :'String', :'settled_at' => :'String', :'change_back_money' => :'V1Money', :'refunded_money' => :'V1Money', :'is_exchange' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/v1_tender.rb, line 197 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && type == o.type && name == o.name && employee_id == o.employee_id && receipt_url == o.receipt_url && card_brand == o.card_brand && pan_suffix == o.pan_suffix && entry_method == o.entry_method && payment_note == o.payment_note && total_money == o.total_money && tendered_money == o.tendered_money && tendered_at == o.tendered_at && settled_at == o.settled_at && change_back_money == o.change_back_money && refunded_money == o.refunded_money && is_exchange == o.is_exchange 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/square_connect/models/v1_tender.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 = SquareConnect.const_get(type).new temp_model.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/square_connect/models/v1_tender.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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/square_connect/models/v1_tender.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
@see the `==` method @param [Object] Object to be compared
# File lib/square_connect/models/v1_tender.rb, line 220 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/v1_tender.rb, line 226 def hash [id, type, name, employee_id, receipt_url, card_brand, pan_suffix, entry_method, payment_note, total_money, tendered_money, tendered_at, settled_at, change_back_money, refunded_money, is_exchange].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/square_connect/models/v1_tender.rb, line 184 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/square_connect/models/v1_tender.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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/square_connect/models/v1_tender.rb, line 294 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/square_connect/models/v1_tender.rb, line 191 def valid? return true end