Overview
Onboard your merchants to provide them Forter services
Integration Steps
Provide Forter with an outline of your merchant portfolio
This should include information about verticals, traffic, and payment methods accepted on your merchant sites. Forter will use this information to start training its models.
Register Merchants
In order to use Forter services on behalf of your merchants, you'll first need to register them with Forter using the Merchant API endpoint.
In the API response, Forter will return to you an id that Forter will use as that merchant's subsite ID, and they will be enrolled for Fraud Management services. Forter allows up to 10K sites to be created via the API. Please reach out to your Forter team if you need to exceed the 10K default site limit.
{
"merchantId": "eh629dK9", // Internal ID in your system provided in request
"defaultMerchantCategoryCode": "5655",
"merchantAccountCreation": {
"timestamp": 1415273179,
"ip": "10.0.0.128"
},
"id": "abcde1234567", // Forter ID to be included in a dedicated header in API requests
"name": "T-Shirts Express"
}Enroll Merchants in 3DS services
If you are utilizing Forter's 3DS Recommendation or Execution services as part of your Element integration, you'll also need to enroll each merchant that will be using these services through the 3DS recommendation enrollment and 3DS execution enrollment API endpoints. Include the merchant's subsite ID as the id in the URL path.
curl -X POST https://api.forter-secure.com/merchants/[id]/3ds-recommendation
-u "{secret-key-value}"
-H "api-version: 10.3"
-H "x-forter-siteid: {your site ID}"
-H "Content-Type: application/json"
-d '{
"offerings": {
"policy_3ds": true,
"psd2": true,
"risk_3ds": true,
"jp_regulation": {
"enabled": true,
"acquirer_settings": [
{
"acquirer": "acquirer name",
"scenario": "3DS_HIGH_RISK_S1"
}
]
}
}
}'
The API response will indicate whether the request was received, but does not yet indicate if the enrollment is complete. You can follow up on the request by calling the 3DS recommendation enrollment status or 3DS execution enrollment status endpoints to confirm that the merchant is successfully onboarded to this feature.
Front-end Integration with Merchant's Subsite ID
For Forter Element, the minimum requirement is that the Javascript is added to the checkout page so that the Forter token can be retrieved and included in the backend order data for each of your merchants' sites. Be sure to include the merchant's subsite ID in the script placed on their website.
Checkout Integration with Merchant's Subsite ID
Complete the Checkout Integration for Fraud Management, 3DS Recommendation, or 3DS Execution , depending on the services you are offering to your merchants.
When sending API calls to Forter on behalf of a merchant, include their subsite ID as the x-forter-sub-merchant-siteid in the header of the API request.
curl -X POST "https://{site-id}.api.forter-secure.com/{endpoint}"
-u "{api-key}:"
-H "api-version: 10.3"
-H "content-type: application/json"
-H "x-forter-siteid: {site-id}"
-H "x-forter-sub-merchant-siteid: {subsite-id}"
-d @filepost.dataPost-purchase Updates with Merchant's Subsite ID
As you receive payment authentication updates (pre-auth flows) and the order fulfillment status changes, it's important to keep Forter notified, so that this information can be used in future decisions. Please also include
Dispute Notifications with Merchant's Subsite ID
Notifying Forter of disputes (also called claims, chargebacks, or fraud alerts) is extremely important because it enables Forter's system to learn and continually improve future decisions, tailoring our system to your company's needs. You can send these updates to Forter via a webhook from your PSP or via Forter's Dispute API endpoint.
Share Historical Data
Share historical order data (approximately last 12 months) from your first 50 sites.