Forter

Forter account configuration

Before getting started with Spreedly and Forter, you will need to have your Site Id and Secret Key from Forter. These values are provided by Forter, and can be found in your developer portal in the Api Reference Section.

The Site Id and Secret Key will be used to create your Fraud Vendor token.

Create a Forter Fraud Vendor

To create a Forter Fraud Vendor, send a request to https://core.spreedly.com/v1/fraud_control/vendors.json. You will need your Forter Site Id and Secret Key API Key.

{  
  "fraud_control_vendor": {  
    "type": "forter", 
    "site_id":"<your site_id>",
    "api_key":"<your secret key>"
  }  
}

Spreedly will respond with a Fraud Vendor Token. Save the token for utilizing in your transactions:

{
    "fraud_control_vendor": {
        "token": "5SVN7FCAMF9M98VG67FS9MTA",
        "created_at": "2024-02-12T18:08:48Z",
        "updated_at": "2024-02-12T18:08:48Z",
        "type": "forter"
    }
}

Prepare your front end

Work with your Forter Support representative to add the Forter Fraud SDK to your site, or application.

Transacting

When utilizing Forter as a Fraud vendor, it is important that your transaction contain the information required to receive an accurate fraud determination. This information can be sent in Spreedly's fields and in the Forter-specific fields.

Spreedly Mappings

The following fields, if sent on a Spreedly transaction, will be sent to Forter. We recommend sending the most information available in order to get the most accurate fraud review.

email
shipping_address
billing_address
ip
user_agent
order_id
currency_code
payment_method_data

Please note that Kount expects two character country codes in the addresses.

Forter-Specific Fields for Transactions

Forter requires a variety of different fields in order to complete a fraud check.

"fraud_detection_parameters": {  
    "pre_authorization_check": true,  
     "vendor_specific_fields": {
        "forter": {
            "order_amount": 100,
            "checkout_time": 1655841719,
            "forter_token": "dsjhsudeu", // This is the forterTokenCookie or the ForterMobileUID
            "user_agent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36",
            "cart_items": [
               {
                    "name": "White GenericBrand handbag",
                    "quantity": 1,
                    "type": "TANGIBLE",
                    "price": "1000"
                },
                {
                    "name": "White GenericBrand handbag",
                    "quantity": 1,
                    "type": "TANGIBLE",
                    "price": "1000"
                }
            ],
            "delivery_type": "PHYSICAL",
            "delivery_method": "FedEx",
            "primary_recipient_first_name": "Joe",
            "primary_recipient_last_name": "Green",

            // Optional fields
            "primary_recipient_email": "[email protected]",
            "primary_recipient_country": "US",
            "primary_recipient_address1": "123 Test St",
            "primary_recipient_address2": "Apt.2",
            "primary_recipient_zip": "12345",
            "merchant_id": "eh629dK9",
            "merchant_domain": "HandbagsExpressDiscounts.com",
            "merchant_name": "Handbags Express Discounts",
            "merchant_device_identifier": "QWERTYIY",
            "additional_order_id": "RDSFHK12",
            "order_segment": "Regular Checkout",
            "coupon_code_used": "FATHERSDAY2022",
            "discount_type": "COUPON",
            "account_owner_first_name": "John",
            "account_owner_last_name": "Smith",
            "account_owner_email": "[email protected]",
            "account_owner_account_id": "e520-ba9a-367-60b",
            "account_owner_created": 1415273168,
            "account_owner_past_orders_count": 51,
            "account_owner_past_orders_sum": 1702.5,
            "account_owner_lastLogin_ip": "203.12.55.12",
            "account_owner_registration_ip": "203.12.55.12",
            "billing_region": "FL",
            "billing_address_type": "home",
            "suggested_correct_billing_address": true,
            "billing_address_creation_time": 1415273168,
            "billing_address_last_modified_time": 1415273168,
            "billing_address_last_used_time": 1415273168,
            "billing_address_removal_time": 1415273168,
            "used_saved_billing_address_data": true,
            "chose_to_save_billing_address_data": true,
            "billing_phone_type": "home",
            "billing_phone_extention": "23",
            "billing_phone_creation_time": 1415273168,
            "billing_phone_last_modified_time": 1415273168,
            "billing_phone_last_used_time": 1415273168,
            "billing_phone_removal_time": 1415273168,
            "loyalty_points_count": 10,
            "loyalty_points_source": "IN_ACCOUNT_PURCHASES",
            "loyalty_points_merchant_payment_id": "kskjd",
            "credit_used_amount": 1
        }
    }
}

Response Fields

The fraud_detection_pre_authorization nest will contain information about the request.

"fraud_detection_pre_authorization": {
     "created_at": "2024-09-10T18:15:33Z",
     "updated_at": "2024-09-10T18:15:33Z",
     "succeeded": true,
     "state": "succeeded",
     "token": "5mwDlmKsATtSspyeH7jGnS8mNa9",
     "amount": 100,
     "currency_code": "USD",
     "ip": null,
     "email": null,
     "order_id": null,
     "transaction_type": "FraudControl::Detection",
     "message": "Approved",
     "fraud_control_vendor_key": "7Y9KJQH01D935VMH220RF6E99M",
     "vendor_transaction_id": null,
     "vendor_response": {},
     "vendor_type": "forter"
}

Post Authorization

Spreedly will asynchronously send an "Order Status" update to Forter with the results of the authorization.

Fraud Detection During Card Add

You can also send information to Forter when you are creating a card via the API. For a full understanding of creating a payment method that includes an embedded fraud check, refer to adding a card in our Embedded Fraud Guide.

When utilizing Forter as a Fraud vendor, it is important that your payment method API call contain the information required to receive an accurate fraud determination. This information can be sent in Spreedly's fields and in the Forter-specific fields.

Currently, you can only do a fraud check while adding a credit card.

Spreedly Mappings

The following fields, if sent with the payment method, will be sent to Forter. We recommend sending the most information available in order to get the most accurate fraud review.

email
shipping_address
billing_address
ip

Forter-Specific Fields for Card Add

You should send the same forter specific fields when adding a card as you would during a transaction. You can send an empty array for car

Response Fields

In addition to the payment method creation fields Spreedly will also respond with standard fraud response fields.

Forter Dashboard

Transactions with Forter initiated by Spreedly will display in the Forter dashboard. If you have questions about the Forter Dashboard about its functionality, please contact Forter.

Troubleshooting

Make sure that your Spreedly account is enabled for Embedded Fraud services. Please contact your Customer Success Manager to enable this service.