com.simplify.payments.domain

Class FraudCheck

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.String,java.lang.Object>

com.simplify.payments.PaymentsMap

com.simplify.payments.PaymentsObject

com.simplify.payments.domain.FraudCheck

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class FraudCheck
extends PaymentsObject

A FraudCheck object.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields inherited from class com.simplify.payments.PaymentsObject

authentication

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FraudCheck()
protected	FraudCheck(java.util.Map m)
protected	FraudCheck(PaymentsObject o)

Method Summary

Modifier and Type	Method and Description
static FraudCheck	create(Authentication auth, java.util.Map map) Creates an FraudCheck object
static FraudCheck	create(java.util.Map map) Creates an FraudCheck object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static FraudCheck	create(java.lang.String publicKey, java.lang.String privateKey, java.util.Map map) Deprecated. As of release 1.1, replaced by create(Authentication, Map)
static FraudCheck	find(Authentication auth, java.lang.String id) Retrieve a FraudCheck object.
static FraudCheck	find(java.lang.String id) Retrieve a FraudCheck object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static FraudCheck	find(java.lang.String publicKey, java.lang.String privateKey, java.lang.String id) Deprecated. As of release 1.1, replaced by find(Authentication, String)
protected java.lang.String	getObjectType()
static ResourceList<FraudCheck>	list() Retrieve FraudCheck objects using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively and the default criteria (max 20, offset 0, default sorting and no filtering).
static ResourceList<FraudCheck>	list(Authentication auth) Retrieve FraudCheck objects using the default criteria (max 20, offset 0, default sorting and no filtering).
static ResourceList<FraudCheck>	list(Authentication auth, java.util.Map criteria) Retrieve FraudCheck objects using the specified criteria.
static ResourceList<FraudCheck>	list(java.util.Map criteria) Retrieve FraudCheck objects using the specified criteria and using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static ResourceList<FraudCheck>	list(java.lang.String publicKey, java.lang.String privateKey) Deprecated. As of release 1.1, replaced by list(Authentication)
static ResourceList<FraudCheck>	list(java.lang.String publicKey, java.lang.String privateKey, java.util.Map criteria) Deprecated. As of release 1.1, replaced by list(Authentication, Map)
FraudCheck	update() Updates an FraudCheck object.

Methods inherited from class com.simplify.payments.PaymentsObject

createObject, deleteObject, findObject, getAuthentication, listObjects, listObjects, updateObject

Methods inherited from class com.simplify.payments.PaymentsMap

containsKey, get, normalize, put, remove, set

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Constructor Detail

FraudCheck

protected FraudCheck()

FraudCheck

protected FraudCheck(PaymentsObject o)

FraudCheck

protected FraudCheck(java.util.Map m)

Method Detail

getObjectType

protected java.lang.String getObjectType()

Specified by:

getObjectType in class PaymentsObject

create

public static FraudCheck create(java.util.Map map)
                         throws ApiCommunicationException,
                                AuthenticationException,
                                InvalidRequestException,
                                NotAllowedException,
                                SystemException

Creates an FraudCheck object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

map - a map of parameters, valid keys and types:

java.lang.Long 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.

payments.command.api.APICardCommand card

Credit or debit card being used to apply the payment to.

java.lang.String card.addressCity

City of the cardholder. [max length: 50, min length: 2]

java.lang.String card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]

java.lang.String card.addressLine1

Address of the cardholder. [max length: 255]

java.lang.String card.addressLine2

Address of the cardholder if needed. [max length: 255]

java.lang.String card.addressState

State of residence of the cardholder. State abbreviations should be used. [max length: 255]

java.lang.String 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]

java.lang.String card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123

java.lang.Integer card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12]

java.lang.Integer card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99]

java.lang.String card.name

Name as it appears on the card. [max length: 50, min length: 2]

java.lang.String card.number

Card number as it appears on the card. [max length: 19, min length: 13]

java.lang.String currency

Currency code (ISO-4217) for the transaction to be checked for fraud. This field is required if using “full” or “advanced” mode.

java.lang.String description

- Description of the fraud check. [max length: 255]

java.lang.String ipAddress

IP Address of the customer for which the fraud check is to be done. [max length: 45]

java.lang.String 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

java.lang.String sessionId

Session ID used during data collection. [max length: 255]

java.lang.String token

Card token representing card details for the card to be checked. [max length: 255]

Returns:

a FraudCheck object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

@Deprecated
public static FraudCheck create(java.lang.String publicKey,
                                            java.lang.String privateKey,
                                            java.util.Map map)
                                     throws ApiCommunicationException,
                                            AuthenticationException,
                                            InvalidRequestException,
                                            NotAllowedException,
                                            SystemException

Deprecated. As of release 1.1, replaced by create(Authentication, Map)

Creates an FraudCheck object

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

java.lang.Long 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.

payments.command.api.APICardCommand card

Credit or debit card being used to apply the payment to.

java.lang.String card.addressCity

City of the cardholder. [max length: 50, min length: 2]

java.lang.String card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]

java.lang.String card.addressLine1

Address of the cardholder. [max length: 255]

java.lang.String card.addressLine2

Address of the cardholder if needed. [max length: 255]

java.lang.String card.addressState

State of residence of the cardholder. State abbreviations should be used. [max length: 255]

java.lang.String 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]

java.lang.String card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123

java.lang.Integer card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12]

java.lang.Integer card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99]

java.lang.String card.name

Name as it appears on the card. [max length: 50, min length: 2]

java.lang.String card.number

Card number as it appears on the card. [max length: 19, min length: 13]

java.lang.String currency

Currency code (ISO-4217) for the transaction to be checked for fraud. This field is required if using “full” or “advanced” mode.

java.lang.String description

- Description of the fraud check. [max length: 255]

java.lang.String ipAddress

IP Address of the customer for which the fraud check is to be done. [max length: 45]

java.lang.String 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

java.lang.String sessionId

Session ID used during data collection. [max length: 255]

java.lang.String token

Card token representing card details for the card to be checked. [max length: 255]

Returns:

a FraudCheck object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

public static FraudCheck create(Authentication auth,
                                java.util.Map map)
                         throws ApiCommunicationException,
                                AuthenticationException,
                                InvalidRequestException,
                                NotAllowedException,
                                SystemException

Creates an FraudCheck object

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

java.lang.Long 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.

payments.command.api.APICardCommand card

Credit or debit card being used to apply the payment to.

java.lang.String card.addressCity

City of the cardholder. [max length: 50, min length: 2]

java.lang.String card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]

java.lang.String card.addressLine1

Address of the cardholder. [max length: 255]

java.lang.String card.addressLine2

Address of the cardholder if needed. [max length: 255]

java.lang.String card.addressState

State of residence of the cardholder. State abbreviations should be used. [max length: 255]

java.lang.String 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]

java.lang.String card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123

java.lang.Integer card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12]

java.lang.Integer card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99]

java.lang.String card.name

Name as it appears on the card. [max length: 50, min length: 2]

java.lang.String card.number

Card number as it appears on the card. [max length: 19, min length: 13]

java.lang.String currency

Currency code (ISO-4217) for the transaction to be checked for fraud. This field is required if using “full” or “advanced” mode.

java.lang.String description

- Description of the fraud check. [max length: 255]

java.lang.String ipAddress

IP Address of the customer for which the fraud check is to be done. [max length: 45]

java.lang.String 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

java.lang.String sessionId

Session ID used during data collection. [max length: 255]

java.lang.String token

Card token representing card details for the card to be checked. [max length: 255]

Returns:

a FraudCheck object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

list

public static ResourceList<FraudCheck> list()
                                     throws ApiCommunicationException,
                                            AuthenticationException,
                                            InvalidRequestException,
                                            NotAllowedException,
                                            SystemException

Retrieve FraudCheck objects using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively and the default criteria (max 20, offset 0, default sorting and no filtering).

Returns:

a ResourceList object which holds the list of FraudCheck objects and the total number of FraudCheck objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

@Deprecated
public static ResourceList<FraudCheck> list(java.lang.String publicKey,
                                                        java.lang.String privateKey)
                                                 throws ApiCommunicationException,
                                                        AuthenticationException,
                                                        InvalidRequestException,
                                                        NotAllowedException,
                                                        SystemException

Deprecated. As of release 1.1, replaced by list(Authentication)

Retrieve FraudCheck objects using the default criteria (max 20, offset 0, default sorting and no filtering).

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

Returns:

a ResourceList object which holds the list of FraudCheck objects and the total number of FraudCheck objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<FraudCheck> list(Authentication auth)
                                     throws ApiCommunicationException,
                                            AuthenticationException,
                                            InvalidRequestException,
                                            NotAllowedException,
                                            SystemException

Retrieve FraudCheck objects using the default criteria (max 20, offset 0, default sorting and no filtering).

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

Returns:

a ResourceList object which holds the list of FraudCheck objects and the total number of FraudCheck objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<FraudCheck> list(java.util.Map criteria)
                                     throws ApiCommunicationException,
                                            AuthenticationException,
                                            InvalidRequestException,
                                            NotAllowedException,
                                            SystemException

Retrieve FraudCheck objects using the specified criteria and using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

Filters to apply to the list.

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map sorting

Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: amount dateCreated fraudResult .

Returns:

a ResourceList object which holds the list of FraudCheck objects and the total number of FraudCheck objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<FraudCheck> list(java.lang.String publicKey,
                                            java.lang.String privateKey,
                                            java.util.Map criteria)
                                     throws ApiCommunicationException,
                                            AuthenticationException,
                                            InvalidRequestException,
                                            NotAllowedException,
                                            SystemException

Deprecated. As of release 1.1, replaced by list(Authentication, Map)

Retrieve FraudCheck objects using the specified criteria.

Parameters:

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

Filters to apply to the list.

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map sorting

Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: amount dateCreated fraudResult .

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

Returns:

a ResourceList object which holds the list of FraudCheck objects and the total number of FraudCheck objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<FraudCheck> list(Authentication auth,
                                            java.util.Map criteria)
                                     throws ApiCommunicationException,
                                            AuthenticationException,
                                            InvalidRequestException,
                                            NotAllowedException,
                                            SystemException

Retrieve FraudCheck objects using the specified criteria.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

Filters to apply to the list.

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map sorting

Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: amount dateCreated fraudResult .

Returns:

a ResourceList object which holds the list of FraudCheck objects and the total number of FraudCheck objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

find

public static FraudCheck find(java.lang.String id)
                       throws ApiCommunicationException,
                              AuthenticationException,
                              InvalidRequestException,
                              ObjectNotFoundException,
                              NotAllowedException,
                              SystemException

Retrieve a FraudCheck object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

id - the id of the FraudCheck object to retrieve

Returns:

a FraudCheck object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

@Deprecated
public static FraudCheck find(java.lang.String publicKey,
                                          java.lang.String privateKey,
                                          java.lang.String id)
                                   throws ApiCommunicationException,
                                          AuthenticationException,
                                          InvalidRequestException,
                                          ObjectNotFoundException,
                                          NotAllowedException,
                                          SystemException

Deprecated. As of release 1.1, replaced by find(Authentication, String)

Retrieve a FraudCheck object.

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

id - the id of the FraudCheck object to retrieve

Returns:

a FraudCheck object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

public static FraudCheck find(Authentication auth,
                              java.lang.String id)
                       throws ApiCommunicationException,
                              AuthenticationException,
                              InvalidRequestException,
                              ObjectNotFoundException,
                              NotAllowedException,
                              SystemException

Retrieve a FraudCheck object.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

id - the id of the FraudCheck object to retrieve

Returns:

a FraudCheck object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

update

public FraudCheck update()
                  throws ApiCommunicationException,
                         AuthenticationException,
                         InvalidRequestException,
                         ObjectNotFoundException,
                         NotAllowedException,
                         SystemException

Updates an FraudCheck object. The properties that can be updated:

• integratorAuthCode
• integratorAvsAddressResponse
• integratorAvsZipResponse
• integratorCvcResponse
• integratorDeclineReason
• integratorTransactionRef (required)
• integratorTransactionStatus

Returns:

a FraudCheck object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException