Sign in

v1

latestOpenAPI 3.0.0Forter License2026-07-1333204516.7 KB
Merchants

3DS execution enrollment

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

post/merchants/{id}/3ds-execution

Path parameters

idstring required

Headers

api-versionstring required
Example:10.1

Specify the version of the API to target.

x-forter-siteidstring required
Example:a1b2c3d4e5f6

Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.

Authorizationstring required
Example:Basic <base64-encoded-api-key:>

Basic Authentiation in the form of a username and password. Use the API Key as the username and leave the password empty.

Request body

Example request

{
  "offerings": {
    "jp_regulation": {
      "acquirer_settings": [
        {
          "acquirer": "Acquirer Name",
          "scenario": "3DS_HIGH_RISK_S1"
        }
      ],
      "enabled": true
    },
    "policy_3ds": true,
    "psd2": true,
    "risk_3ds": true
  },
  "threeDsConfiguration": {
    "processors": [
      {
        "mids": [
          {
            "acquirerMerchantName": [
              {
                "cardScheme": "VISA",
                "value": "string"
              }
            ],
            "acquirerMid": "123456789",
            "merchantCategoryCode": "5661",
            "merchantEntityCountryNumericCode": "840",
            "requestorId": [
              {
                "cardScheme": "VISA",
                "value": "string"
              }
            ],
            "requestorName": [
              {
                "cardScheme": "VISA",
                "value": "string"
              }
            ],
            "requestorUrl": [
              {
                "cardScheme": "VISA",
                "value": "string"
              }
            ],
            "supportedCurrencies": [
              "USD"
            ],
            "supportedSchemes": [
              "VISA"
            ]
          }
        ]
      }
    ]
  }
}

Response

Example threeDsExecutionOnboardingRequestAccepted

requestIdstring required
statusstring required

Example response

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