Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class TransactionEvent.
Describes an event in the lifecycle of a payment transaction.
Generated from protobuf message google.cloud.recaptchaenterprise.v1.TransactionEvent
Namespace
Google \ Cloud \ RecaptchaEnterprise \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ event_type |
int
Optional. The type of this transaction event. |
↳ reason |
string
Optional. The reason or standardized code that corresponds with this transaction event, if one exists. For example, a CHARGEBACK event with code 6005. |
↳ value |
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. |
↳ event_time |
Google\Protobuf\Timestamp
Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call. |
getEventType
Optional. The type of this transaction event.
Returns | |
---|---|
Type | Description |
int |
setEventType
Optional. The type of this transaction event.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getReason
Optional. The reason or standardized code that corresponds with this transaction event, if one exists. For example, a CHARGEBACK event with code 6005.
Returns | |
---|---|
Type | Description |
string |
setReason
Optional. The reason or standardized code that corresponds with this transaction event, if one exists. For example, a CHARGEBACK event with code 6005.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getValue
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 | |
---|---|
Type | Description |
float |
setValue
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.
Parameter | |
---|---|
Name | Description |
var |
float
|
Returns | |
---|---|
Type | Description |
$this |
getEventTime
Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasEventTime
clearEventTime
setEventTime
Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |