Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Transactions » Card Transactions »

Helcim Fraud Defender

This API call let's you retrieve the details of the Helcim Transaction Defender for a specific transaction. The response is an XML of the available Helcim Transaction Defender information for a transaction. For more information on how Fraud Defender works, please click here.

Request Fields

Field Name Type Required Description
action String Yes transactionDefender
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 
transactionId String Yes The transaction ID.

Response Fields (XML)

Field Name Type Description
transactions - XML structure
transaction - XML structure
id Integer The transaction ID.
dateCreated String The date the transaction was created.
status String Approved/Denied.
user String The customer's name.
type String The transaction type (Purchase, Pre-auth, Capture, Refund).
amount Decimal The transaction amount.
approvalCode String The approval code.
avsResponse String Address verification response.
cvvResponse String Card verification value response.
test Integer 1 or 0. Whether or not the transaction is processed as test. 
acquirerTransactionId Integer  Transaction Id assigned by the acquirer to the transaction. 
responseMessage String Approved/Denied.
ipAddress String The IP address.
defender - XML structure
score Decimal The Helcim Transaction Defender score (out of 10).
details - XML structure
cvv - XML structure
score Decimal The CVV score (out of 10).
message String Info regarding CVV. 
cvv - XML structure
avs - XML structure
score Decimal The AVS score (out of 10).
message String Info regarding AVS. 
avs - XML structure
transactionSize - XML structure
score Decimal The transaction size score (out of 10).
message String Info regarding transaction Size. 
transactionSize - XML structure
billingLocation - XML structure
score String The billing location score (out of 10).
message String Info regarding billing location. 
billingLocation - XML structure
shippingLocation - XML structure
score String The shipping location score (out of 10).
message String Info regarding shipping location. 
shippingLocation - XML structure
bankBin - XML structure
score String The bank bin score (out of 10).
message String Info regarding the bank bin location.
bankBin - XML structure
ipLocation - XML structure
score String The IP location score (out of 10).
message String Info regarding the IP location. 
ipLocation - XML structure
details XML structure
issuingBank - XML structure
cardBrand String The card brand.
cardType String The type of credit card.
bankName String The name of the issuing Bank.
location String The country the card was issued in.
website String The bank website.
telephone String The bank phone number.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description
0 - Invalid Transaction ID The transaction ID is invalid, or not entered.
0 - User Access Error - Transaction cannot be viewed by this user. The user does not have permission to view this transaction.

Code Samples

Sample Transaction Defender Response XML

<?xml version="1.0"?>
<transactions>
    <transaction>
        <id>112094</id>
        <dateCreated>2017-06-30 14:21:27</dateCreated>
        <status>APPROVED</status>
        <user>Rodolfo Ferro Casagrande</user>
        <type>PURCHASE</type>
        <amount>500.00</amount>
        <approvalCode>T1E8ST</approvalCode>
        <avsResponse>X</avsResponse>
        <cvvResponse></cvvResponse>
        <test>0</test>
        <acquirerTransactionId></acquirerTransactionId>
        <responseMessage>APPROVED</responseMessage>
        <ipAddress>216.123.206.20</ipAddress>
        <defender>
            <score>6.9</score>
            <details>
                <cvv>
                    <score>1.00</score>
                    <message>CVV not present</message>
                </cvv>
                <avs>
                    <score>10.00</score>
                    <message>Exact AVS Match</message>
                </avs>
                <transactionSize>
                    <score>10.00</score>
                    <message>Amount less than average of: $671.61</message>
                </transactionSize>
                <billingLocation>
                    <score>N/A</score>
                    <message>Billing Info is Not Set</message>
                </billingLocation>
                <shippingLocation>
                    <score>N/A</score>
                    <message>Shipping Info is Not Set</message>
                </shippingLocation>
                <bankBin>
                    <score>N/A</score>
                    <message>Billing Info is Not set</message>
                </bankBin>
                <ipLocation>
                    <score>N/A</score>
                    <message>Billing Info is Not set</message>
                </ipLocation>
            </details>
            <issuingBank>
                <cardBrand>MASTERCARD</cardBrand>
                <cardType>Credit</cardType>
                <bankName>Capital One Bank Canada Branch</bankName>
                <location>Canada</location>
                <website></website>
                <telephone></telephone>
            </issuingBank>
        </defender>
    </transaction>
</transactions>

HTML Form Sample HTML

<input type="hidden" name="accountId" value="YOUR-ACCOUNT-ID">
<input type="hidden" name="apiToken" value="YOUR-API-TOKEN">
<input type="hidden" name="action" value="transactionDefender">
<input type="hidden" name="transactionId" value="112094">