Simplify Node.js API Docs

API Docs for:
Show:

FraudCheck Class

Defined in: simplify.js:981

This is a Simplify domain object. In order to get access to a domain object, a client needs to be created. The client is then used to invoke the different methods e.g.

var client = Simplify.getClient({
                            publicKey: 'YOUR_PUBLIC_API_KEY',
                            privateKey: 'YOUR_PRIVATE_API_KEY'
                        });
                        
                        client.fraudcheck.METHOD_NAME(params, function(error, data){
                            if(error){
                                // handle the error
                            }
                        
                            // Awesome...no error, handle the data
                        });
                        

Constructor

FraudCheck

(
  • appKeys
)

Defined in simplify.js:981

Parameters:

  • appKeys Object

    Object containing the public & private API keys

Item Index

Methods

create

(
  • params
  • callback
)

Defined in simplify.js:1007

Function to create a FraudCheck object.

Parameters:

  • params Object

    A map of parameters in which to create the FraudCheck from.

    Valid parameters include:

    • 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]

    NOTE: Any parameters with a sub-parameter (e.g. param.subParam) need to be nested when passed as an argument in e.g.

    {
                                                        param: {
                                                        subParam1: 'value', 
                                                        subParam2: 'value'
                                                    }
                                                }
  • callback Function

    A function to handle success/error responses from the API.
    The function takes 2 parameters, the first is an error object. This is null if no error occurs. The second parameter is the response data. This is null if an error occurs.

find

(
  • id
  • callback
)

Defined in simplify.js:1079

Function to retrieve a FraudCheck object from the API.

Parameters:

  • id String

    The ID of the FraudCheck to retrieve

  • callback Function

    A function to handle success/error responses from the API.
    The function takes 2 parameters, the first is an error object. This is null if no error occurs. The second parameter is the response data. This is null if an error occurs.

list

(
  • params
  • callback
)

Defined in simplify.js:1050

Function to retrieve a list FraudCheck objects.

Parameters:

  • params Object

    A map of parameters in which to define the FraudCheck list from.

    Valid parameters include:

    • 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 (either 'asc' for ascending or 'desc' for descending).
      Sortable properties are:
      • amount
      • dateCreated
      • fraudResult

    NOTE: Any parameters with a sub-parameter (e.g. param.subParam) need to be nested when passed as an argument in e.g.

    {
                                                        param: {
                                                        subParam1: 'value', 
                                                        subParam2: 'value'
                                                    }
                                                }
  • callback Function

    A function to handle success/error responses from the API.
    The function takes 2 parameters, the first is an error object. This is null if no error occurs. The second parameter is the response data. This is null if an error occurs.

update

(
  • params
  • callback
)

Defined in simplify.js:1096

Function to update a FraudCheck object.

Parameters:

  • params Object

    A map of parameters on which to update the FraudCheck object.

    Valid parameters include:

    • id : A string ID of the FraudCheck object to update
    • 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".

    NOTE: Any parameters with a sub-parameter (e.g. param.subParam) need to be nested when passed as an argument in e.g.

    {
                                                        param: {
                                                        subParam1: 'value', 
                                                        subParam2: 'value'
                                                    }
                                                }
  • callback Function

    A function to handle success/error responses from the API.
    The function takes 2 parameters, the first is an error object. This is null if no error occurs. The second parameter is the response data. This is null if an error occurs.