API Documentation
\

\Simplify_FraudCheck

Base class for all domain objects.

Summary

Methods
Properties
Constants
createFraudCheck()
listFraudCheck()
findFraudCheck()
updateFraudCheck()
setAll()
getProperties()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$properties
N/A

Properties

$properties

$properties

Methods

createFraudCheck()

createFraudCheck(array $hash, mixed $authentication) : \FraudCheck

Creates an Simplify_FraudCheck object

Parameters

array $hash

a map 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.00. 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. State abbreviations should be used. [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]
card.expYear
Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99]
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]
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, SIMPLE, ADVANCED, FULL] required
sessionId
Session ID used during data collection. [max length: 255]
token
Card token representing card details for the card to be checked. [max length: 255]
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.<i/>

Returns

\FraudCheck —

a FraudCheck object.

listFraudCheck()

listFraudCheck( $criteria, mixed $authentication) : \ResourceList

Retrieve Simplify_FraudCheck objects.

Parameters

$criteria
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\ResourceList —

a ResourceList object that holds the list of FraudCheck objects and the total number of FraudCheck objects available for the given criteria.

findFraudCheck()

findFraudCheck( $id, mixed $authentication) : \FraudCheck

Retrieve a Simplify_FraudCheck object from the API

Parameters

$id
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\FraudCheck —

a FraudCheck object

updateFraudCheck()

updateFraudCheck(mixed $authentication) : \FraudCheck

Updates an Simplify_FraudCheck 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".

Parameters

mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\FraudCheck —

a FraudCheck object.

setAll()

setAll(mixed $hash)

Updates the object's properties with the values in the specified map.

Parameters

mixed $hash

array Map of values to set.

getProperties()

getProperties() : array

Returns the object's properties as a map.

Returns

array —

map of properties.