Class: Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData
- Inherits:
-
Object
- Object
- Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb
Overview
Transaction data associated with a payment protected by reCAPTCHA.
Defined Under Namespace
Classes: Address, GatewayInfo, Item, User
Instance Attribute Summary collapse
-
#billing_address ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::Address
Address associated with the payment method when applicable.
-
#card_bin ⇒ ::String
The Bank Identification Number - generally the first 6 or 8 digits of the card.
-
#card_last_four ⇒ ::String
The last four digits of the card.
-
#currency_code ⇒ ::String
The currency code in ISO-4217 format.
-
#gateway_info ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::GatewayInfo
Information about the payment gateway's response to the transaction.
-
#items ⇒ ::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::Item>
Items purchased in this transaction.
-
#merchants ⇒ ::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::User>
Information about the user or users fulfilling the transaction.
-
#payment_method ⇒ ::String
The payment method for the transaction.
-
#shipping_address ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::Address
Destination address if this transaction involves shipping a physical item.
-
#shipping_value ⇒ ::Float
The value of shipping in the specified currency.
-
#transaction_id ⇒ ::String
Unique identifier for the transaction.
-
#user ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::User
Information about the user paying/initiating the transaction.
-
#value ⇒ ::Float
The decimal value of the transaction in the specified currency.
Instance Attribute Details
#billing_address ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::Address
Returns Address associated with the payment method when applicable.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA is called after authorization). class GatewayInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#card_bin ⇒ ::String
Returns The Bank Identification Number - generally the first 6 or 8 digits of the card.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA is called after authorization). class GatewayInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#card_last_four ⇒ ::String
Returns The last four digits of the card.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA is called after authorization). class GatewayInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#currency_code ⇒ ::String
Returns The currency code in ISO-4217 format.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA is called after authorization). class GatewayInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#gateway_info ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::GatewayInfo
Returns Information about the payment gateway's response to the transaction.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA is called after authorization). class GatewayInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#items ⇒ ::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::Item>
Returns Items purchased in this transaction.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA is called after authorization). class GatewayInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#merchants ⇒ ::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::User>
Returns Information about the user or users fulfilling the transaction.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA is called after authorization). class GatewayInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#payment_method ⇒ ::String
Returns 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).
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA is called after authorization). class GatewayInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#shipping_address ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::Address
Returns Destination address if this transaction involves shipping a physical item.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA is called after authorization). class GatewayInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#shipping_value ⇒ ::Float
Returns The value of shipping in the specified currency. 0 for free or no shipping.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA 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.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA is called after authorization). class GatewayInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#user ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::User
Returns Information about the user paying/initiating the transaction.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA is called after authorization). class GatewayInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#value ⇒ ::Float
Returns The decimal value of the transaction in the specified currency.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 473 class TransactionData include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Structured address format for billing and shipping addresses. # @!attribute [rw] recipient # @return [::String] # The recipient name, potentially including information such as "care of". # @!attribute [rw] address # @return [::Array<::String>] # 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] # The town/city of the address. # @!attribute [rw] administrative_area # @return [::String] # The state, province, or otherwise administrative area of the address. # @!attribute [rw] region_code # @return [::String] # The CLDR country/region of the address. # @!attribute [rw] postal_code # @return [::String] # 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] # 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] # The epoch milliseconds of the user's account creation. # @!attribute [rw] email # @return [::String] # The email address of the user. # @!attribute [rw] email_verified # @return [::Boolean] # Whether the email has been verified to be accessible by the user (OTP or # similar). # @!attribute [rw] phone_number # @return [::String] # The phone number of the user, with country code. # @!attribute [rw] phone_verified # @return [::Boolean] # 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] # The full name of the item. # @!attribute [rw] value # @return [::Float] # The value per item that the user is paying, in the transaction currency, # after discounts. # @!attribute [rw] quantity # @return [::Integer] # The quantity of this item that is being purchased. # @!attribute [rw] merchant_account_id # @return [::String] # 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] # Name of the gateway service (for example, stripe, square, paypal). # @!attribute [rw] gateway_response_code # @return [::String] # Gateway response code describing the state of the transaction. # @!attribute [rw] avs_response_code # @return [::String] # AVS response code from the gateway # (available only when reCAPTCHA is called after authorization). # @!attribute [rw] cvv_response_code # @return [::String] # CVV response code from the gateway # (available only when reCAPTCHA is called after authorization). class GatewayInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |