Class: Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionData

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/recaptchaenterprise_v1/classes.rb,
lib/google/apis/recaptchaenterprise_v1/representations.rb,
lib/google/apis/recaptchaenterprise_v1/representations.rb

Overview

Transaction data associated with a payment protected by reCAPTCHA Enterprise. All fields are optional.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecaptchaenterpriseV1TransactionData

Returns a new instance of GoogleCloudRecaptchaenterpriseV1TransactionData.



1139
1140
1141
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1139

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#billing_address ⇒ Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionDataAddress

Structured address format for billing and shipping addresses. Corresponds to the JSON property billingAddress



1071
1072
1073
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1071

def billing_address
  @billing_address
end

#card_bin ⇒ String

The Bank Identification Number - generally the first 6 or 8 digits of the card. Corresponds to the JSON property cardBin

Returns:

  • (String)


1076
1077
1078
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1076

def card_bin
  @card_bin
end

#card_last_four ⇒ String

The last four digits of the card. Corresponds to the JSON property cardLastFour

Returns:

  • (String)


1081
1082
1083
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1081

def card_last_four
  @card_last_four
end

#currency_code ⇒ String

The currency code in ISO-4217 format. Corresponds to the JSON property currencyCode

Returns:

  • (String)


1086
1087
1088
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1086

def currency_code
  @currency_code
end

#gateway_info ⇒ Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo

Details about the transaction from the gateway. Corresponds to the JSON property gatewayInfo



1091
1092
1093
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1091

def gateway_info
  @gateway_info
end

#items ⇒ Array<Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionDataItem>

Items purchased in this transaction. Corresponds to the JSON property items



1096
1097
1098
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1096

def items
  @items
end

#merchants ⇒ Array<Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionDataUser>

Information about the user or users fulfilling the transaction. Corresponds to the JSON property merchants



1101
1102
1103
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1101

def merchants
  @merchants
end

#payment_method ⇒ String

The payment method for the transaction. The allowed values are: * credit-card * debit-card * gift-card * processor-name (If a third-party is used, for example, processor-paypal) * custom-name (If an alternative method is used, for example, custom-crypto) Corresponds to the JSON property paymentMethod

Returns:

  • (String)


1109
1110
1111
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1109

def payment_method
  @payment_method
end

#shipping_address ⇒ Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionDataAddress

Structured address format for billing and shipping addresses. Corresponds to the JSON property shippingAddress



1114
1115
1116
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1114

def shipping_address
  @shipping_address
end

#shipping_value ⇒ Float

The value of shipping in the specified currency. 0 for free or no shipping. Corresponds to the JSON property shippingValue

Returns:

  • (Float)


1119
1120
1121
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1119

def shipping_value
  @shipping_value
end

#transaction_id ⇒ String

Unique identifier for the transaction. This custom identifier can be used to reference this transaction in the future, for example, labeling a refund or chargeback event. Two attempts at the same transaction should use the same transaction id. Corresponds to the JSON property transactionId

Returns:

  • (String)


1127
1128
1129
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1127

def transaction_id
  @transaction_id
end

#user ⇒ Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionDataUser

Details about a user's account involved in the transaction. Corresponds to the JSON property user



1132
1133
1134
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1132

def user
  @user
end

#value ⇒ Float

The decimal value of the transaction in the specified currency. Corresponds to the JSON property value

Returns:

  • (Float)


1137
1138
1139
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1137

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1144

def update!(**args)
  @billing_address = args[:billing_address] if args.key?(:billing_address)
  @card_bin = args[:card_bin] if args.key?(:card_bin)
  @card_last_four = args[:card_last_four] if args.key?(:card_last_four)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @gateway_info = args[:gateway_info] if args.key?(:gateway_info)
  @items = args[:items] if args.key?(:items)
  @merchants = args[:merchants] if args.key?(:merchants)
  @payment_method = args[:payment_method] if args.key?(:payment_method)
  @shipping_address = args[:shipping_address] if args.key?(:shipping_address)
  @shipping_value = args[:shipping_value] if args.key?(:shipping_value)
  @transaction_id = args[:transaction_id] if args.key?(:transaction_id)
  @user = args[:user] if args.key?(:user)
  @value = args[:value] if args.key?(:value)
end