Interface TransactionDataOrBuilder (3.52.0)

public interface TransactionDataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBillingAddress()

public abstract TransactionData.Address getBillingAddress()

Optional. Address associated with the payment method when applicable.

.google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionData.Address

The billingAddress.

getBillingAddressOrBuilder()

public abstract TransactionData.AddressOrBuilder getBillingAddressOrBuilder()

Optional. Address associated with the payment method when applicable.

.google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionData.AddressOrBuilder

getCardBin()

public abstract String getCardBin()

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

string card_bin = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The cardBin.

getCardBinBytes()

public abstract ByteString getCardBinBytes()

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

string card_bin = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cardBin.

getCardLastFour()

public abstract String getCardLastFour()

Optional. The last four digits of the card.

string card_last_four = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The cardLastFour.

getCardLastFourBytes()

public abstract ByteString getCardLastFourBytes()

Optional. The last four digits of the card.

string card_last_four = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cardLastFour.

getCurrencyCode()

public abstract String getCurrencyCode()

Optional. The currency code in ISO-4217 format.

string currency_code = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public abstract ByteString getCurrencyCodeBytes()

Optional. The currency code in ISO-4217 format.

string currency_code = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for currencyCode.

getGatewayInfo()

public abstract TransactionData.GatewayInfo getGatewayInfo()

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

.google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionData.GatewayInfo

The gatewayInfo.

getGatewayInfoOrBuilder()

public abstract TransactionData.GatewayInfoOrBuilder getGatewayInfoOrBuilder()

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

.google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionData.GatewayInfoOrBuilder

getItems(int index)

public abstract TransactionData.Item getItems(int index)

Optional. Items purchased in this transaction.

repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TransactionData.Item

getItemsCount()

public abstract int getItemsCount()

Optional. Items purchased in this transaction.

repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getItemsList()

public abstract List<TransactionData.Item> getItemsList()

Optional. Items purchased in this transaction.

repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Item>

getItemsOrBuilder(int index)

public abstract TransactionData.ItemOrBuilder getItemsOrBuilder(int index)

Optional. Items purchased in this transaction.

repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TransactionData.ItemOrBuilder

getItemsOrBuilderList()

public abstract List<? extends TransactionData.ItemOrBuilder> getItemsOrBuilderList()

Optional. Items purchased in this transaction.

repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.recaptchaenterprise.v1.TransactionData.ItemOrBuilder>

getMerchants(int index)

public abstract TransactionData.User getMerchants(int index)

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

repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TransactionData.User

getMerchantsCount()

public abstract int getMerchantsCount()

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

repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getMerchantsList()

public abstract List<TransactionData.User> getMerchantsList()

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

repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<User>

getMerchantsOrBuilder(int index)

public abstract TransactionData.UserOrBuilder getMerchantsOrBuilder(int index)

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

repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TransactionData.UserOrBuilder

getMerchantsOrBuilderList()

public abstract List<? extends TransactionData.UserOrBuilder> getMerchantsOrBuilderList()

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

repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.recaptchaenterprise.v1.TransactionData.UserOrBuilder>

getPaymentMethod()

public abstract String getPaymentMethod()

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)

string payment_method = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The paymentMethod.

getPaymentMethodBytes()

public abstract ByteString getPaymentMethodBytes()

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)

string payment_method = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for paymentMethod.

getShippingAddress()

public abstract TransactionData.Address getShippingAddress()

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

.google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionData.Address

The shippingAddress.

getShippingAddressOrBuilder()

public abstract TransactionData.AddressOrBuilder getShippingAddressOrBuilder()

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

.google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionData.AddressOrBuilder

getShippingValue()

public abstract double getShippingValue()

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

double shipping_value = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The shippingValue.

getTransactionId()

public abstract String getTransactionId()

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.

optional string transaction_id = 11;

Returns
Type Description
String

The transactionId.

getTransactionIdBytes()

public abstract ByteString getTransactionIdBytes()

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.

optional string transaction_id = 11;

Returns
Type Description
ByteString

The bytes for transactionId.

getUser()

public abstract TransactionData.User getUser()

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

.google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionData.User

The user.

getUserOrBuilder()

public abstract TransactionData.UserOrBuilder getUserOrBuilder()

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

.google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionData.UserOrBuilder

getValue()

public abstract double getValue()

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

double value = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The value.

hasBillingAddress()

public abstract boolean hasBillingAddress()

Optional. Address associated with the payment method when applicable.

.google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the billingAddress field is set.

hasGatewayInfo()

public abstract boolean hasGatewayInfo()

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

.google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the gatewayInfo field is set.

hasShippingAddress()

public abstract boolean hasShippingAddress()

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

.google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the shippingAddress field is set.

hasTransactionId()

public abstract boolean hasTransactionId()

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.

optional string transaction_id = 11;

Returns
Type Description
boolean

Whether the transactionId field is set.

hasUser()

public abstract boolean hasUser()

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

.google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the user field is set.