3DS recommendation enrollment

POST

https://api.forter-secure.com/merchants/{id}/3ds-recommendation

Enroll a merchant in Forter's 3DS recommendation services on their future orders. The response will include a request ID that can be used to check on the status.

Path Parameters

idstringrequired

Header Parameters

api-versionstringrequired
Example
10.3
Description
Specify the version of the API to target.
x-forter-siteidstringrequired
Example
a1b2c3d4e5f6
Description
Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.

Body Parameters

bodythreeDsRecommendationOnboardingRequestrequired
Description
Enroll a merchant in Forter's 3DS recommendation services on their future orders. The response will include a request ID that can be used to check on the status.
- offeringsThreeDsOfferingsrequired
  Description
  Selection of offerings the merchant signed up for
  - jp_regulationobject
    - JpRegulationOffering
      - acquirer_settingsJpAcquireSetting[]
        Description
        Acquirer-specific settings for JP regulation. If not provided, the setting will be inherited from the parent site.
        acquirerstringrequired
        Example
        Acquirer Name
        Description
        The name of the acquirer.
        Min Length
        1
        Max Length
        50
        force_3ds_on_guest_checkoutboolean
        Description
        If true, forces 3DS on guest checkout flows. This will take effect only for scenario '3DS_NEW_CARD_S2'
        scenariostring<3DS_HIGH_RISK_S1 | 3DS_NEW_CARD_S2 | 3DS_MANDATORY_S3>required
        Example
        3DS_HIGH_RISK_S1
        Description
        The scenario for the JP regulation offering
        Allowed
        3DS_HIGH_RISK_S13DS_NEW_CARD_S23DS_MANDATORY_S3
      - enabledbooleanrequired
        Example
        true
        Description
        Register for JP regulation.
  - policy_3dsbooleanrequired
    Example
    true
    Description
    Register 3DS for policy
  - psd2booleanrequired
    Example
    true
    Description
    Register 3DS for PSD2 regulation
  - risk_3dsbooleanrequired
    Example
    true
    Description
    Register 3DS for risk

Responses

200Example threeDsRecommendationOnboardingRequestAccepted

threeDsRecommendationOnboardingRequestAccepted
Description
Response structure for merchant onboarding requests
- requestIdstringrequired
  Example
  my-request-id-1234
- statusstringrequired
  Example
  success

400

Bad Request (Often missing a required parameter)

401

Unauthorized (No valid API key provided)

404

Not Found (The requested item doesn't exist)

500

Server Error (Something went wrong on Forter's end)

curl

curl --request POST \
     --url https://api.forter-secure.com/merchants/{id}/3ds-recommendation \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'api-version: 10.3' \
     --header 'x-forter-siteid: a1b2c3d4e5f6' \
     --data '{
     "offerings": {
     "jp_regulation": {
     "acquirer_settings": [
     {
     "acquirer": "Acquirer Name",
     "scenario": "3DS_HIGH_RISK_S1"
     }
     ],
     "enabled": true
     },
     "policy_3ds": true,
     "psd2": true,
     "risk_3ds": true
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("api-version", "10.3");
myHeaders.append("x-forter-siteid", "a1b2c3d4e5f6");

var raw = JSON.stringify({
   "offerings": {
      "jp_regulation": {
         "acquirer_settings": [
            {
               "acquirer": "Acquirer Name",
               "scenario": "3DS_HIGH_RISK_S1"
            }
         ],
         "enabled": true
      },
      "policy_3ds": true,
      "psd2": true,
      "risk_3ds": true
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.forter-secure.com/merchants/{id}/3ds-recommendation", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.forter-secure.com/merchants/{id}/3ds-recommendation")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["api-version"] = "10.3"
request["x-forter-siteid"] = "a1b2c3d4e5f6"
request.body = JSON.dump({
   "offerings": {
      "jp_regulation": {
         "acquirer_settings": [
            {
               "acquirer": "Acquirer Name",
               "scenario": "3DS_HIGH_RISK_S1"
            }
         ],
         "enabled": true
      },
      "policy_3ds": true,
      "psd2": true,
      "risk_3ds": true
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.forter-secure.com/merchants/{id}/3ds-recommendation"

payload = json.dumps({
   "offerings": {
      "jp_regulation": {
         "acquirer_settings": [
            {
               "acquirer": "Acquirer Name",
               "scenario": "3DS_HIGH_RISK_S1"
            }
         ],
         "enabled": True
      },
      "policy_3ds": True,
      "psd2": True,
      "risk_3ds": True
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'api-version': '10.3',
   'x-forter-siteid': 'a1b2c3d4e5f6'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Example threeDsRecommendationOnboardingRequestAccepted
{
  "requestId": "my-request-id-1234",
  "status": "success"
}

400

// Bad Request (Often missing a required parameter)

401

// Unauthorized (No valid API key provided)

404

// Not Found (The requested item doesn't exist)

500

// Server Error (Something went wrong on Forter's end)