Class: Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent

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

Overview

Describes an event in the lifecycle of a payment transaction.

Defined Under Namespace

Modules: TransactionEventType

Instance Attribute Summary collapse

Instance Attribute Details

#event_time ⇒ ::Google::Protobuf::Timestamp

Returns Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 55

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

  # Enum that represents an event in the payment transaction lifecycle.
  module TransactionEventType
    # Default, unspecified event type.
    TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0

    # Indicates that the transaction is approved by the merchant. The
    # accompanying reasons can include terms such as 'INHOUSE', 'ACCERTIFY',
    # 'CYBERSOURCE', or 'MANUAL_REVIEW'.
    MERCHANT_APPROVE = 1

    # Indicates that the transaction is denied and concluded due to risks
    # detected by the merchant. The accompanying reasons can include terms such
    # as 'INHOUSE',  'ACCERTIFY',  'CYBERSOURCE', or 'MANUAL_REVIEW'.
    MERCHANT_DENY = 2

    # Indicates that the transaction is being evaluated by a human, due to
    # suspicion or risk.
    MANUAL_REVIEW = 3

    # Indicates that the authorization attempt with the card issuer succeeded.
    AUTHORIZATION = 4

    # Indicates that the authorization attempt with the card issuer failed.
    # The accompanying reasons can include Visa's '54' indicating that the card
    # is expired, or '82' indicating that the CVV is incorrect.
    AUTHORIZATION_DECLINE = 5

    # Indicates that the transaction is completed because the funds were
    # settled.
    PAYMENT_CAPTURE = 6

    # Indicates that the transaction could not be completed because the funds
    # were not settled.
    PAYMENT_CAPTURE_DECLINE = 7

    # Indicates that the transaction has been canceled. Specify the reason
    # for the cancellation. For example, 'INSUFFICIENT_INVENTORY'.
    CANCEL = 8

    # Indicates that the merchant has received a chargeback inquiry due to
    # fraud for the transaction, requesting additional information before a
    # fraud chargeback is officially issued and a formal chargeback
    # notification is sent.
    CHARGEBACK_INQUIRY = 9

    # Indicates that the merchant has received a chargeback alert due to fraud
    # for the transaction. The process of resolving the dispute without
    # involving the payment network is started.
    CHARGEBACK_ALERT = 10

    # Indicates that a fraud notification is issued for the transaction, sent
    # by the payment instrument's issuing bank because the transaction appears
    # to be fraudulent. We recommend including TC40 or SAFE data in the
    # `reason` field for this event type. For partial chargebacks, we recommend
    # that you include an amount in the `value` field.
    FRAUD_NOTIFICATION = 11

    # Indicates that the merchant is informed by the payment network that the
    # transaction has entered the chargeback process due to fraud. Reason code
    # examples include Discover's '6005' and '6041'. For partial chargebacks,
    # we recommend that you include an amount in the `value` field.
    CHARGEBACK = 12

    # Indicates that the transaction has entered the chargeback process due to
    # fraud, and that the merchant has chosen to enter representment. Reason
    # examples include Discover's '6005' and '6041'. For partial chargebacks,
    # we recommend that you include an amount in the `value` field.
    CHARGEBACK_REPRESENTMENT = 13

    # Indicates that the transaction has had a fraud chargeback which was
    # illegitimate and was reversed as a result. For partial chargebacks, we
    # recommend that you include an amount in the `value` field.
    CHARGEBACK_REVERSE = 14

    # Indicates that the merchant has received a refund for a completed
    # transaction. For partial refunds, we recommend that you include an amount
    # in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of
    # exempt tax)
    REFUND_REQUEST = 15

    # Indicates that the merchant has received a refund request for this
    # transaction, but that they have declined it. For partial refunds, we
    # recommend that you include an amount in the `value` field. Reason
    # example: 'TAX_EXEMPT' (partial refund of exempt tax)
    REFUND_DECLINE = 16

    # Indicates that the completed transaction was refunded by the merchant.
    # For partial refunds, we recommend that you include an amount in the
    # `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt
    # tax)
    REFUND = 17

    # Indicates that the completed transaction was refunded by the merchant,
    # and that this refund was reversed. For partial refunds, we recommend that
    # you include an amount in the `value` field.
    REFUND_REVERSE = 18
  end
end

#event_type ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent::TransactionEventType

Returns Optional. The type of this transaction event.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 55

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

  # Enum that represents an event in the payment transaction lifecycle.
  module TransactionEventType
    # Default, unspecified event type.
    TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0

    # Indicates that the transaction is approved by the merchant. The
    # accompanying reasons can include terms such as 'INHOUSE', 'ACCERTIFY',
    # 'CYBERSOURCE', or 'MANUAL_REVIEW'.
    MERCHANT_APPROVE = 1

    # Indicates that the transaction is denied and concluded due to risks
    # detected by the merchant. The accompanying reasons can include terms such
    # as 'INHOUSE',  'ACCERTIFY',  'CYBERSOURCE', or 'MANUAL_REVIEW'.
    MERCHANT_DENY = 2

    # Indicates that the transaction is being evaluated by a human, due to
    # suspicion or risk.
    MANUAL_REVIEW = 3

    # Indicates that the authorization attempt with the card issuer succeeded.
    AUTHORIZATION = 4

    # Indicates that the authorization attempt with the card issuer failed.
    # The accompanying reasons can include Visa's '54' indicating that the card
    # is expired, or '82' indicating that the CVV is incorrect.
    AUTHORIZATION_DECLINE = 5

    # Indicates that the transaction is completed because the funds were
    # settled.
    PAYMENT_CAPTURE = 6

    # Indicates that the transaction could not be completed because the funds
    # were not settled.
    PAYMENT_CAPTURE_DECLINE = 7

    # Indicates that the transaction has been canceled. Specify the reason
    # for the cancellation. For example, 'INSUFFICIENT_INVENTORY'.
    CANCEL = 8

    # Indicates that the merchant has received a chargeback inquiry due to
    # fraud for the transaction, requesting additional information before a
    # fraud chargeback is officially issued and a formal chargeback
    # notification is sent.
    CHARGEBACK_INQUIRY = 9

    # Indicates that the merchant has received a chargeback alert due to fraud
    # for the transaction. The process of resolving the dispute without
    # involving the payment network is started.
    CHARGEBACK_ALERT = 10

    # Indicates that a fraud notification is issued for the transaction, sent
    # by the payment instrument's issuing bank because the transaction appears
    # to be fraudulent. We recommend including TC40 or SAFE data in the
    # `reason` field for this event type. For partial chargebacks, we recommend
    # that you include an amount in the `value` field.
    FRAUD_NOTIFICATION = 11

    # Indicates that the merchant is informed by the payment network that the
    # transaction has entered the chargeback process due to fraud. Reason code
    # examples include Discover's '6005' and '6041'. For partial chargebacks,
    # we recommend that you include an amount in the `value` field.
    CHARGEBACK = 12

    # Indicates that the transaction has entered the chargeback process due to
    # fraud, and that the merchant has chosen to enter representment. Reason
    # examples include Discover's '6005' and '6041'. For partial chargebacks,
    # we recommend that you include an amount in the `value` field.
    CHARGEBACK_REPRESENTMENT = 13

    # Indicates that the transaction has had a fraud chargeback which was
    # illegitimate and was reversed as a result. For partial chargebacks, we
    # recommend that you include an amount in the `value` field.
    CHARGEBACK_REVERSE = 14

    # Indicates that the merchant has received a refund for a completed
    # transaction. For partial refunds, we recommend that you include an amount
    # in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of
    # exempt tax)
    REFUND_REQUEST = 15

    # Indicates that the merchant has received a refund request for this
    # transaction, but that they have declined it. For partial refunds, we
    # recommend that you include an amount in the `value` field. Reason
    # example: 'TAX_EXEMPT' (partial refund of exempt tax)
    REFUND_DECLINE = 16

    # Indicates that the completed transaction was refunded by the merchant.
    # For partial refunds, we recommend that you include an amount in the
    # `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt
    # tax)
    REFUND = 17

    # Indicates that the completed transaction was refunded by the merchant,
    # and that this refund was reversed. For partial refunds, we recommend that
    # you include an amount in the `value` field.
    REFUND_REVERSE = 18
  end
end

#reason ⇒ ::String

Returns Optional. The reason or standardized code that corresponds with this transaction event, if one exists. For example, a CHARGEBACK event with code 6005.

Returns:

  • (::String) —

    Optional. The reason or standardized code that corresponds with this transaction event, if one exists. For example, a CHARGEBACK event with code 6005.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 55

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

  # Enum that represents an event in the payment transaction lifecycle.
  module TransactionEventType
    # Default, unspecified event type.
    TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0

    # Indicates that the transaction is approved by the merchant. The
    # accompanying reasons can include terms such as 'INHOUSE', 'ACCERTIFY',
    # 'CYBERSOURCE', or 'MANUAL_REVIEW'.
    MERCHANT_APPROVE = 1

    # Indicates that the transaction is denied and concluded due to risks
    # detected by the merchant. The accompanying reasons can include terms such
    # as 'INHOUSE',  'ACCERTIFY',  'CYBERSOURCE', or 'MANUAL_REVIEW'.
    MERCHANT_DENY = 2

    # Indicates that the transaction is being evaluated by a human, due to
    # suspicion or risk.
    MANUAL_REVIEW = 3

    # Indicates that the authorization attempt with the card issuer succeeded.
    AUTHORIZATION = 4

    # Indicates that the authorization attempt with the card issuer failed.
    # The accompanying reasons can include Visa's '54' indicating that the card
    # is expired, or '82' indicating that the CVV is incorrect.
    AUTHORIZATION_DECLINE = 5

    # Indicates that the transaction is completed because the funds were
    # settled.
    PAYMENT_CAPTURE = 6

    # Indicates that the transaction could not be completed because the funds
    # were not settled.
    PAYMENT_CAPTURE_DECLINE = 7

    # Indicates that the transaction has been canceled. Specify the reason
    # for the cancellation. For example, 'INSUFFICIENT_INVENTORY'.
    CANCEL = 8

    # Indicates that the merchant has received a chargeback inquiry due to
    # fraud for the transaction, requesting additional information before a
    # fraud chargeback is officially issued and a formal chargeback
    # notification is sent.
    CHARGEBACK_INQUIRY = 9

    # Indicates that the merchant has received a chargeback alert due to fraud
    # for the transaction. The process of resolving the dispute without
    # involving the payment network is started.
    CHARGEBACK_ALERT = 10

    # Indicates that a fraud notification is issued for the transaction, sent
    # by the payment instrument's issuing bank because the transaction appears
    # to be fraudulent. We recommend including TC40 or SAFE data in the
    # `reason` field for this event type. For partial chargebacks, we recommend
    # that you include an amount in the `value` field.
    FRAUD_NOTIFICATION = 11

    # Indicates that the merchant is informed by the payment network that the
    # transaction has entered the chargeback process due to fraud. Reason code
    # examples include Discover's '6005' and '6041'. For partial chargebacks,
    # we recommend that you include an amount in the `value` field.
    CHARGEBACK = 12

    # Indicates that the transaction has entered the chargeback process due to
    # fraud, and that the merchant has chosen to enter representment. Reason
    # examples include Discover's '6005' and '6041'. For partial chargebacks,
    # we recommend that you include an amount in the `value` field.
    CHARGEBACK_REPRESENTMENT = 13

    # Indicates that the transaction has had a fraud chargeback which was
    # illegitimate and was reversed as a result. For partial chargebacks, we
    # recommend that you include an amount in the `value` field.
    CHARGEBACK_REVERSE = 14

    # Indicates that the merchant has received a refund for a completed
    # transaction. For partial refunds, we recommend that you include an amount
    # in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of
    # exempt tax)
    REFUND_REQUEST = 15

    # Indicates that the merchant has received a refund request for this
    # transaction, but that they have declined it. For partial refunds, we
    # recommend that you include an amount in the `value` field. Reason
    # example: 'TAX_EXEMPT' (partial refund of exempt tax)
    REFUND_DECLINE = 16

    # Indicates that the completed transaction was refunded by the merchant.
    # For partial refunds, we recommend that you include an amount in the
    # `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt
    # tax)
    REFUND = 17

    # Indicates that the completed transaction was refunded by the merchant,
    # and that this refund was reversed. For partial refunds, we recommend that
    # you include an amount in the `value` field.
    REFUND_REVERSE = 18
  end
end

#value ⇒ ::Float

Returns Optional. The value that corresponds with this transaction event, if one exists. For example, a refund event where $5.00 was refunded. Currency is obtained from the original transaction data.

Returns:

  • (::Float) —

    Optional. The value that corresponds with this transaction event, if one exists. For example, a refund event where $5.00 was refunded. Currency is obtained from the original transaction data.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 55

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

  # Enum that represents an event in the payment transaction lifecycle.
  module TransactionEventType
    # Default, unspecified event type.
    TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0

    # Indicates that the transaction is approved by the merchant. The
    # accompanying reasons can include terms such as 'INHOUSE', 'ACCERTIFY',
    # 'CYBERSOURCE', or 'MANUAL_REVIEW'.
    MERCHANT_APPROVE = 1

    # Indicates that the transaction is denied and concluded due to risks
    # detected by the merchant. The accompanying reasons can include terms such
    # as 'INHOUSE',  'ACCERTIFY',  'CYBERSOURCE', or 'MANUAL_REVIEW'.
    MERCHANT_DENY = 2

    # Indicates that the transaction is being evaluated by a human, due to
    # suspicion or risk.
    MANUAL_REVIEW = 3

    # Indicates that the authorization attempt with the card issuer succeeded.
    AUTHORIZATION = 4

    # Indicates that the authorization attempt with the card issuer failed.
    # The accompanying reasons can include Visa's '54' indicating that the card
    # is expired, or '82' indicating that the CVV is incorrect.
    AUTHORIZATION_DECLINE = 5

    # Indicates that the transaction is completed because the funds were
    # settled.
    PAYMENT_CAPTURE = 6

    # Indicates that the transaction could not be completed because the funds
    # were not settled.
    PAYMENT_CAPTURE_DECLINE = 7

    # Indicates that the transaction has been canceled. Specify the reason
    # for the cancellation. For example, 'INSUFFICIENT_INVENTORY'.
    CANCEL = 8

    # Indicates that the merchant has received a chargeback inquiry due to
    # fraud for the transaction, requesting additional information before a
    # fraud chargeback is officially issued and a formal chargeback
    # notification is sent.
    CHARGEBACK_INQUIRY = 9

    # Indicates that the merchant has received a chargeback alert due to fraud
    # for the transaction. The process of resolving the dispute without
    # involving the payment network is started.
    CHARGEBACK_ALERT = 10

    # Indicates that a fraud notification is issued for the transaction, sent
    # by the payment instrument's issuing bank because the transaction appears
    # to be fraudulent. We recommend including TC40 or SAFE data in the
    # `reason` field for this event type. For partial chargebacks, we recommend
    # that you include an amount in the `value` field.
    FRAUD_NOTIFICATION = 11

    # Indicates that the merchant is informed by the payment network that the
    # transaction has entered the chargeback process due to fraud. Reason code
    # examples include Discover's '6005' and '6041'. For partial chargebacks,
    # we recommend that you include an amount in the `value` field.
    CHARGEBACK = 12

    # Indicates that the transaction has entered the chargeback process due to
    # fraud, and that the merchant has chosen to enter representment. Reason
    # examples include Discover's '6005' and '6041'. For partial chargebacks,
    # we recommend that you include an amount in the `value` field.
    CHARGEBACK_REPRESENTMENT = 13

    # Indicates that the transaction has had a fraud chargeback which was
    # illegitimate and was reversed as a result. For partial chargebacks, we
    # recommend that you include an amount in the `value` field.
    CHARGEBACK_REVERSE = 14

    # Indicates that the merchant has received a refund for a completed
    # transaction. For partial refunds, we recommend that you include an amount
    # in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of
    # exempt tax)
    REFUND_REQUEST = 15

    # Indicates that the merchant has received a refund request for this
    # transaction, but that they have declined it. For partial refunds, we
    # recommend that you include an amount in the `value` field. Reason
    # example: 'TAX_EXEMPT' (partial refund of exempt tax)
    REFUND_DECLINE = 16

    # Indicates that the completed transaction was refunded by the merchant.
    # For partial refunds, we recommend that you include an amount in the
    # `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt
    # tax)
    REFUND = 17

    # Indicates that the completed transaction was refunded by the merchant,
    # and that this refund was reversed. For partial refunds, we recommend that
    # you include an amount in the `value` field.
    REFUND_REVERSE = 18
  end
end