FraudCheck
BETA. Test Mode only.
INPUT PARAMETERS
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.
optional
card
Credit or debit card being used to apply the payment to.
optional
card.addressCity
City of the cardholder.
[max length: 50, min length: 2]
optional
card.addressCountry
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
[max length: 2, min length: 2]
optional
card.addressLine1
Address of the cardholder.
[max length: 255]
optional
card.addressLine2
Address of the cardholder if needed.
[max length: 255]
optional
card.addressState
State of residence of the cardholder. State abbreviations should be used.
[max length: 255]
optional
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]
optional
card.cvc
CVC security code of the card. This is the code on the back of the card. Example: 123
optional
card.expMonth
Expiration month of the card. Format is MM. Example: January = 01
[min value: 1, max value: 12]
optional
card.expYear
Expiration year of the card. Format is YY. Example: 2013 = 13
[min value: 0, max value: 99]
optional
card.name
Name as it appears on the card.
[max length: 50, min length: 2]
optional
card.number
Card number as it appears on the card.
[max length: 19, min length: 13]
optional
currency
Currency code (ISO-4217) for the transaction to be checked for fraud. This field is required if using “full” or “advanced” mode.
optional
description
- Description of the fraud check.
[max length: 255]
optional
ipAddress
IP Address of the customer for which the fraud check is to be done.
[max length: 45]
optional
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.
required
sessionId
Session ID used during data collection.
[max length: 255]
optional
token
Card token representing card details for the card to be checked.
[max length: 255]
optional
OUTPUT
card.customer.id
Customer ID
card.id
Unique ID of the card associated with the payment
customer.id
Customer ID
fraudResult.id
ID of the fraud record.
id
Fraud check unique Id
transaction.id
Transaction ID
amount
Amount of the transaction to be checked for fraud (in the smallest unit of your currency). Example: 100 = $1.00.
card
Card details
card.addressCity
City of the cardholder.
card.addressCountry
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
card.addressLine1
Address of the cardholder.
card.addressLine2
Address of the cardholder if needed.
card.addressState
State of residence of the cardholder. State abbreviations should be used.
card.addressZip
Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters.
card.customer
Customer associated with the card
card.customer.email
Email address of the customer
card.customer.name
Name of the customer
card.dateCreated
Creation date in UTC millis of the card in the system
card.expMonth
Expiration month of the card. Format is MM. Example: January = 01
card.expYear
Expiration year of the card. Format is YY. Example: 2013 = 13
card.indicator
Card indicator, i.e. DEBIT, CREDIT or CHARGE CARD.
card.indicatorSource
Card indicator source.
card.last4
Last 4 digits of the card number
card.name
Name as appears on the card.
card.type
Type of credit or debit card
currency
Currency code (ISO-4217) for the transaction to be checked for fraud.
customer
Customer details sent for fraud check.
customer.email
Email address of the customer
customer.name
Name of the customer
dateCreated
Date of the fraud check.
description
Description of the fraud check.
fraudResult
Fraud results.
fraudResult.avsMatchCode
AVS check code: “M” for match, “N” for no match, “W” zip code match only, “Z” address match only, “U” data unavailable, “S” not supported, “R” retry, “E” error.
fraudResult.cvcMatchCode
CVC check code.
fraudResult.dateCreated
Date the fraud result record was created.
fraudResult.detail
Details regarding transaction and the fraud detection carried out.
fraudResult.fraudulent
Flag indicating whether the transaction is considered fraudulent or not.
fraudResult.lastUpdated
Date the fraud result record was last updated.
fraudResult.mapName
Map showing the zip code of the billing address, shipping address and IP location, if available.
fraudResult.score
Fraud detection score.
fraudResult.status
Fraud status.
integratorAuthCode
Authorization code for the transaction.
integratorAvsAddressResponse
AVS address response.
integratorAvsZipResponse
AVS zip response.
integratorCvcResponse
CVC response.
integratorDeclineReason
Reason for the decline if applicable.
integratorTransactionRef
Integrator's reference id for the transaction.
integratorTransactionStatus
Status of the transaction, valid values are "APPROVED", "DECLINED", "SETTLED", "REFUNDED" or "VOIDED".
lastUpdated
Last updated date.
mode
Fraud check mode used.
transaction
Transaction details sent for fraud check.
INPUT PARAMETERS
filter
Filters to apply to the list.
optional
max
Allows up to a max of 50 list items to return.
[min value: 0, max value: 50, default:
optional
20]
offset
Used in paging of the list. This is the start offset of the page.
[min value: 0, default:
optional
0]
sorting
Allows for ascending or descending sorting of the list.
The value is a map between the property name and the sorting direction (either 'asc' for ascending or 'desc' for descending). Sortable properties are:
amount, dateCreated, fraudResult
optional
OUTPUT
filter
Filters to apply to the list.
list
Object list
max
Allows up to a max of 50 list items to return.
offset
Used in paging of the list. This is the start offset of the page.
sorting
Allows for ascending or descending sorting of the list.
total
Total number of records available
INPUT PARAMETERS
id
ID of the fraud check to retrieve.
required
OUTPUT
card.customer.id
Customer ID
card.id
Unique ID of the card associated with the payment
customer.id
Customer ID
fraudResult.id
ID of the fraud record.
id
Fraud check unique Id
transaction.id
Transaction ID
amount
Amount of the transaction to be checked for fraud (in the smallest unit of your currency). Example: 100 = $1.00.
card
Card details
card.addressCity
City of the cardholder.
card.addressCountry
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
card.addressLine1
Address of the cardholder.
card.addressLine2
Address of the cardholder if needed.
card.addressState
State of residence of the cardholder. State abbreviations should be used.
card.addressZip
Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters.
card.customer
Customer associated with the card
card.customer.email
Email address of the customer
card.customer.name
Name of the customer
card.dateCreated
Creation date in UTC millis of the card in the system
card.expMonth
Expiration month of the card. Format is MM. Example: January = 01
card.expYear
Expiration year of the card. Format is YY. Example: 2013 = 13
card.indicator
Card indicator, i.e. DEBIT, CREDIT or CHARGE CARD.
card.indicatorSource
Card indicator source.
card.last4
Last 4 digits of the card number
card.name
Name as appears on the card.
card.type
Type of credit or debit card
currency
Currency code (ISO-4217) for the transaction to be checked for fraud.
customer
Customer details sent for fraud check.
customer.email
Email address of the customer
customer.name
Name of the customer
dateCreated
Date of the fraud check.
description
Description of the fraud check.
fraudResult
Fraud results.
fraudResult.avsMatchCode
AVS check code: “M” for match, “N” for no match, “W” zip code match only, “Z” address match only, “U” data unavailable, “S” not supported, “R” retry, “E” error.
fraudResult.cvcMatchCode
CVC check code.
fraudResult.dateCreated
Date the fraud result record was created.
fraudResult.detail
Details regarding transaction and the fraud detection carried out.
fraudResult.fraudulent
Flag indicating whether the transaction is considered fraudulent or not.
fraudResult.lastUpdated
Date the fraud result record was last updated.
fraudResult.mapName
Map showing the zip code of the billing address, shipping address and IP location, if available.
fraudResult.score
Fraud detection score.
fraudResult.status
Fraud status.
integratorAuthCode
Authorization code for the transaction.
integratorAvsAddressResponse
AVS address response.
integratorAvsZipResponse
AVS zip response.
integratorCvcResponse
CVC response.
integratorDeclineReason
Reason for the decline if applicable.
integratorTransactionRef
Integrator's reference id for the transaction.
integratorTransactionStatus
Status of the transaction, valid values are "APPROVED", "DECLINED", "SETTLED", "REFUNDED" or "VOIDED".
lastUpdated
Last updated date.
mode
Fraud check mode used.
transaction
Transaction details sent for fraud check.
INPUT PARAMETERS
id
Id of the Fraud Check to update
required
integratorAuthCode
Authorization code for the transaction.
[max length: 255]
optional
integratorAvsAddressResponse
AVS address response.
[max length: 255]
optional
integratorAvsZipResponse
AVS zip response.
[max length: 255]
optional
integratorCvcResponse
CVC response.
[max length: 255]
optional
integratorDeclineReason
Reason for the decline if applicable.
[max length: 255]
optional
integratorTransactionRef
Reference id for the transaction.
[max length: 255]
required
integratorTransactionStatus
Status of the transaction, valid values are "APPROVED", "DECLINED", "SETTLED", "REFUNDED" or "VOIDED".
optional
OUTPUT
card.customer.id
Customer ID
card.id
Unique ID of the card associated with the payment
customer.id
Customer ID
fraudResult.id
ID of the fraud record.
id
Fraud check unique Id
transaction.id
Transaction ID
amount
Amount of the transaction to be checked for fraud (in the smallest unit of your currency). Example: 100 = $1.00.
card
Card details
card.addressCity
City of the cardholder.
card.addressCountry
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
card.addressLine1
Address of the cardholder.
card.addressLine2
Address of the cardholder if needed.
card.addressState
State of residence of the cardholder. State abbreviations should be used.
card.addressZip
Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters.
card.customer
Customer associated with the card
card.customer.email
Email address of the customer
card.customer.name
Name of the customer
card.dateCreated
Creation date in UTC millis of the card in the system
card.expMonth
Expiration month of the card. Format is MM. Example: January = 01
card.expYear
Expiration year of the card. Format is YY. Example: 2013 = 13
card.indicator
Card indicator, i.e. DEBIT, CREDIT or CHARGE CARD.
card.indicatorSource
Card indicator source.
card.last4
Last 4 digits of the card number
card.name
Name as appears on the card.
card.type
Type of credit or debit card
currency
Currency code (ISO-4217) for the transaction to be checked for fraud.
customer
Customer details sent for fraud check.
customer.email
Email address of the customer
customer.name
Name of the customer
dateCreated
Date of the fraud check.
description
Description of the fraud check.
fraudResult
Fraud results.
fraudResult.avsMatchCode
AVS check code: “M” for match, “N” for no match, “W” zip code match only, “Z” address match only, “U” data unavailable, “S” not supported, “R” retry, “E” error.
fraudResult.cvcMatchCode
CVC check code.
fraudResult.dateCreated
Date the fraud result record was created.
fraudResult.detail
Details regarding transaction and the fraud detection carried out.
fraudResult.fraudulent
Flag indicating whether the transaction is considered fraudulent or not.
fraudResult.lastUpdated
Date the fraud result record was last updated.
fraudResult.mapName
Map showing the zip code of the billing address, shipping address and IP location, if available.
fraudResult.score
Fraud detection score.
fraudResult.status
Fraud status.
integratorAuthCode
Authorization code for the transaction.
integratorAvsAddressResponse
AVS address response.
integratorAvsZipResponse
AVS zip response.
integratorCvcResponse
CVC response.
integratorDeclineReason
Reason for the decline if applicable.
integratorTransactionRef
Integrator's reference id for the transaction.
integratorTransactionStatus
Status of the transaction, valid values are "APPROVED", "DECLINED", "SETTLED", "REFUNDED" or "VOIDED".
lastUpdated
Last updated date.
mode
Fraud check mode used.
transaction
Transaction details sent for fraud check.
