Class: Minfraud::Components::Report::Transaction

Inherits:
Base
  • Object
show all
Includes:
Enum
Defined in:
lib/minfraud/components/report/transaction.rb

Overview

Contains the fields used in the Report Transaction API.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Enum

included

Methods inherited from Base

#to_json

Constructor Details

#initialize(params = {}) ⇒ Transaction

Returns a new instance of Transaction.

Parameters:

  • params (Hash) (defaults to: {}) —

    Hash of parameters. Each key/value should correspond to one of the available attributes.



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/minfraud/components/report/transaction.rb', line 77

def initialize(params = {})
  @ip_address      = params[:ip_address]
  @chargeback_code = params[:chargeback_code]
  @maxmind_id      = params[:maxmind_id]
  @minfraud_id     = params[:minfraud_id]
  @notes           = params[:notes]
  @transaction_id  = params[:transaction_id]
  self.tag         = params[:tag]

  validate
end

Instance Attribute Details

#chargeback_code ⇒ String?

A string which is provided by your payment processor indicating the reason for the chargeback.

Returns:

  • (String, nil) 


38
39
40
 
# File 'lib/minfraud/components/report/transaction.rb', line 38

def chargeback_code
  @chargeback_code
end

#ip_address ⇒ String?

The IP address of the customer placing the order. This should be passed as a string like "152.216.7.110". This field is not required if you provide at least one of the transaction's minfraud_id, maxmind_id, or transaction_id. You are encouraged to provide it, if possible.

Returns:

  • (String, nil) 


21
22
23
 
# File 'lib/minfraud/components/report/transaction.rb', line 21

def ip_address
  @ip_address
end

#maxmind_id ⇒ String?

A unique eight character string identifying a minFraud Standard or Premium request. These IDs are returned in the maxmindID field of a response for a successful minFraud request. This field is not required if you provide at least one of the transaction's ip_address, minfraud_id, or transaction_id. You are encouraged to provide it, if possible.

Returns:

  • (String, nil) 


48
49
50
 
# File 'lib/minfraud/components/report/transaction.rb', line 48

def maxmind_id
  @maxmind_id
end

#minfraud_id ⇒ String?

A UUID that identifies a minFraud Score, minFraud Insights, or minFraud Factors request. This ID is returned at /id in the response. This field is not required if you provide at least one of the transaction's ip_address, maxmind_id, or transaction_id. You are encouraged to provide it, if possible.

Returns:

  • (String, nil) 


57
58
59
 
# File 'lib/minfraud/components/report/transaction.rb', line 57

def minfraud_id
  @minfraud_id
end

#notes ⇒ String?

Your notes on the fraud tag associated with the transaction. We manually review many reported transactions to improve our scoring for you so any additional details to help us understand context are helpful.

Returns:

  • (String, nil) 


65
66
67
 
# File 'lib/minfraud/components/report/transaction.rb', line 65

def notes
  @notes
end

#tag ⇒ Symbol?

A symbol indicating the likelihood that a transaction may be fraudulent.

This may be one of :chargeback, :clear (to retract a previous report), :not_fraud, :spam_or_abuse, or :suspected_fraud.

Returns:

  • (Symbol, nil) 


32
 
# File 'lib/minfraud/components/report/transaction.rb', line 32

enum_accessor :tag, %i[chargeback clear not_fraud spam_or_abuse suspected_fraud]

#transaction_id ⇒ String?

The transaction ID you originally passed to minFraud. This field is not required if you provide at least one of the transaction's ip_address, maxmind_id, or minfraud_id. You are encouraged to provide it, if possible.

Returns:

  • (String, nil) 


73
74
75
 
# File 'lib/minfraud/components/report/transaction.rb', line 73

def transaction_id
  @transaction_id
end