class Simplify::FraudCheck
A FraudCheck
object.
Attributes
Authentication
object used to access the API (See Simplify::Authentication
for details)
Public Class Methods
Creates an FraudCheck
object
- parms
-
a hash of parameters; valid keys are:
-
amount
Amount of the transaction to be checked for fraud (in the smallest unit of your currency). Example: 100 = $1.00USD. This field is required if using “full” or “advanced” mode. -
card => addressCity
City of the cardholder. [max length: 50, min length: 2] -
card => addressCountry
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2] -
card => addressLine1
Address of the cardholder. [max length: 255] -
card => addressLine2
Address of the cardholder if needed. [max length: 255] -
card => addressState
State of residence of the cardholder. For the US, this is a 2-digit USPS code. [max length: 255] -
card => addressZip
Postal code of the cardholder. The postal code size is between 5 and 9 characters in length and only contains numbers or letters. [max length: 32] -
card => cvc
CVC security code of the card. This is the code on the back of the card. Example: 123 -
card => expMonth
Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] required -
card => expYear
Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99] required -
card => name
Name as it appears on the card. [max length: 50, min length: 2] -
card => number
Card number as it appears on the card. [max length: 19, min length: 13] required -
currency
Currency code (ISO-4217) for the transaction to be checked for fraud. This field is required if using “full” or “advanced” mode. -
description
- Description of the fraud check. [max length: 255] -
ipAddress
IP Address of the customer for which the fraud check is to be done. [max length: 45] -
mode
Fraud check mode. “simple” only does an AVS and CVC check; “advanced” does a complete fraud check, running the input against the set up rules. [valid values: simple, advanced, full] required -
sessionId
Session ID used during data collection. [max length: 255] -
token
Card token token representing card details for the card to be checked. [max length: 255]
- auth
-
Authentication
information used for the API call. If no value is passed the global keysSimplify::public_key
andSimplify::private_key
are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
Returns a FraudCheck
object.
# File lib/simplify/fraudcheck.rb, line 83 def self.create(parms, *auth) auth_obj = Simplify::PaymentsApi.create_auth_object(auth) h = Simplify::PaymentsApi.execute("fraudCheck", 'create', parms, auth_obj) obj = FraudCheck.new() obj.authentication = auth_obj obj = obj.merge!(h) obj end
Retrieve a FraudCheck
object from the API
- id
-
ID of object to retrieve
- auth
-
Authentication
information used for the API call. If no value is passed the global keysSimplify::public_key
andSimplify::private_key
are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
Returns a FraudCheck
object.
# File lib/simplify/fraudcheck.rb, line 118 def self.find(id, *auth) auth_obj = Simplify::PaymentsApi.create_auth_object(auth) h = Simplify::PaymentsApi.execute("fraudCheck", 'show', {"id" => id}, auth_obj) obj = FraudCheck.new() obj.authentication = auth_obj obj = obj.merge!(h) obj end
Retrieve FraudCheck
objects.
- criteria
-
a hash of parameters; valid keys are:
-
filter
Filters to apply to the list. -
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] -
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0] -
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (eitherasc
for ascending ordesc
for descending). Sortable properties are:amount dateCreated fraudResult
.
- auth
-
Authentication
information used for the API call. If no value is passed the global keysSimplify::public_key
andSimplify::private_key
are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
Returns an object where the list
property contains the list of FraudCheck
objects and the total
property contains the total number of FraudCheck
objects available for the given criteria.
# File lib/simplify/fraudcheck.rb, line 102 def self.list(criteria = nil, *auth) auth_obj = Simplify::PaymentsApi.create_auth_object(auth) h = Simplify::PaymentsApi.execute("fraudCheck", 'list', criteria, auth_obj) obj = FraudCheck.new() obj.authentication = auth_obj obj = obj.merge!(h) obj end
Public Instance Methods
Returns the private key used when accessing this object. Deprecated: please use 'authentication' instead.
# File lib/simplify/fraudcheck.rb, line 50 def private_key return self.authentication.private_key end
Sets the private key used when accessing this object. Deprecated: please use 'authentication' instead.
# File lib/simplify/fraudcheck.rb, line 55 def private_key=(k) return self.authentication.private_key = k end
Returns the public key used when accessing this object. Deprecated: please use 'authentication' instead.
# File lib/simplify/fraudcheck.rb, line 40 def public_key return self.authentication.public_key end
Sets the public key used when accessing this object. Deprecated: please use 'authentication' instead.
# File lib/simplify/fraudcheck.rb, line 45 def public_key=(k) return self.authentication.public_key = k end
Updates this object
The properties that can be updated:
-
integratorAuthCode
Authorization
code for the transaction. [max length: 255] -
integratorAvsAddressResponse
AVS address response. [max length: 255] -
integratorAvsZipResponse
AVS zip response. [max length: 255] -
integratorCvcResponse
CVC response. [max length: 255] -
integratorDeclineReason
Reason for the decline if applicable. [max length: 255] -
integratorTransactionRef
Reference id for the transaction. [max length: 255] (required) -
integratorTransactionStatus
Status of the transaction, valid values are “APPROVED”, “DECLINED”, “SETTLED”, “REFUNDED” or “VOIDED”.
# File lib/simplify/fraudcheck.rb, line 138 def update() h = Simplify::PaymentsApi.execute("fraudCheck", 'update', self, self.authentication) self.merge!(h) self end