Google Cloud Recaptcha Enterprise V1 Client - Class TransactionEvent (1.5.2)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
int

setEventType

Optional. The type of this transaction event.

Parameter
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var float
Returns
TypeDescription
$this

getEventTime

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

Returns
TypeDescription
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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this