Class: Google::Cloud::RecaptchaEnterprise::V1::TransactionData

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb

Overview

Transaction data associated with a payment protected by reCAPTCHA Enterprise.

Defined Under Namespace

Classes: Address, GatewayInfo, Item, User

Instance Attribute Summary collapse

Instance Attribute Details

#billing_address ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::Address

Returns Optional. Address associated with the payment method when applicable.

Returns:



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#card_bin ⇒ ::String

Returns Optional. The Bank Identification Number - generally the first 6 or 8 digits of the card.

Returns:

  • (::String) —

    Optional. The Bank Identification Number - generally the first 6 or 8 digits of the card.



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#card_last_four ⇒ ::String

Returns Optional. The last four digits of the card.

Returns:

  • (::String) —

    Optional. The last four digits of the card.



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#currency_code ⇒ ::String

Returns Optional. The currency code in ISO-4217 format.

Returns:

  • (::String) —

    Optional. The currency code in ISO-4217 format.



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#gateway_info ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::GatewayInfo

Returns Optional. Information about the payment gateway's response to the transaction.

Returns:



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#items ⇒ ::Array<::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::Item>

Returns Optional. Items purchased in this transaction.

Returns:



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#merchants ⇒ ::Array<::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::User>

Returns Optional. Information about the user or users fulfilling the transaction.

Returns:



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#payment_method ⇒ ::String

Returns Optional. 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).

Returns:

  • (::String) —

    Optional. 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)


592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#shipping_address ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::Address

Returns Optional. Destination address if this transaction involves shipping a physical item.

Returns:



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#shipping_value ⇒ ::Float

Returns Optional. The value of shipping in the specified currency. 0 for free or no shipping.

Returns:

  • (::Float) —

    Optional. The value of shipping in the specified currency. 0 for free or no shipping.



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#transaction_id ⇒ ::String

Returns 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.

Returns:

  • (::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.



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::User

Returns Optional. Information about the user paying/initiating the transaction.

Returns:



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#value ⇒ ::Float

Returns Optional. The decimal value of the transaction in the specified currency.

Returns:

  • (::Float) —

    Optional. The decimal value of the transaction in the specified currency.



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 592

class TransactionData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Structured address format for billing and shipping addresses.
  # @!attribute [rw] recipient
  #   @return [::String]
  #     Optional. The recipient name, potentially including information such as
  #     "care of".
  # @!attribute [rw] address
  #   @return [::Array<::String>]
  #     Optional. The first lines of the address. The first line generally
  #     contains the street name and number, and further lines may include
  #     information such as an apartment number.
  # @!attribute [rw] locality
  #   @return [::String]
  #     Optional. The town/city of the address.
  # @!attribute [rw] administrative_area
  #   @return [::String]
  #     Optional. The state, province, or otherwise administrative area of the
  #     address.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Optional. The CLDR country/region of the address.
  # @!attribute [rw] postal_code
  #   @return [::String]
  #     Optional. The postal or ZIP code of the address.
  class Address
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a user's account involved in the transaction.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Optional. Unique account identifier for this user. If using account
  #     defender, this should match the hashed_account_id field. Otherwise, a
  #     unique and persistent identifier for this account.
  # @!attribute [rw] creation_ms
  #   @return [::Integer]
  #     Optional. The epoch milliseconds of the user's account creation.
  # @!attribute [rw] email
  #   @return [::String]
  #     Optional. The email address of the user.
  # @!attribute [rw] email_verified
  #   @return [::Boolean]
  #     Optional. Whether the email has been verified to be accessible by the
  #     user (OTP or similar).
  # @!attribute [rw] phone_number
  #   @return [::String]
  #     Optional. The phone number of the user, with country code.
  # @!attribute [rw] phone_verified
  #   @return [::Boolean]
  #     Optional. Whether the phone number has been verified to be accessible by
  #     the user (OTP or similar).
  class User
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Line items being purchased in this transaction.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. The full name of the item.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Optional. The value per item that the user is paying, in the transaction
  #     currency, after discounts.
  # @!attribute [rw] quantity
  #   @return [::Integer]
  #     Optional. The quantity of this item that is being purchased.
  # @!attribute [rw] merchant_account_id
  #   @return [::String]
  #     Optional. When a merchant is specified, its corresponding account_id.
  #     Necessary to populate marketplace-style transactions.
  class Item
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about the transaction from the gateway.
  # @!attribute [rw] name
  #   @return [::String]
  #     Optional. Name of the gateway service (for example, stripe, square,
  #     paypal).
  # @!attribute [rw] gateway_response_code
  #   @return [::String]
  #     Optional. Gateway response code describing the state of the transaction.
  # @!attribute [rw] avs_response_code
  #   @return [::String]
  #     Optional. AVS response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  # @!attribute [rw] cvv_response_code
  #   @return [::String]
  #     Optional. CVV response code from the gateway
  #     (available only when reCAPTCHA Enterprise is called after authorization).
  class GatewayInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end