---
title: 3DS 実行登録
slug: 3ds
createdAt: 2025-08-12T21:15:13.774Z
---
{
"id": "t_QyKJ6pC9aelrdvHFWiA",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "https://api.forter-secure.com/merchants/{id}/3ds-execution",
"servers": [
{
"url": "https://api.forter-secure.com/merchants/{id}/3ds-execution"
}
],
"name": "3DS execution enrollment",
"description": "Enroll a merchant in Forter's 3DS execution services on their future orders. \nThe response will include a request ID that can be used to check on the status.",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "id",
"type": "string",
"description": ""
}
],
"headerParameters": [
{
"kind": "required",
"name": "api-version",
"type": "string",
"example": "10.1",
"description": "Specify the version of the API to target.",
"default": "10.1"
},
{
"kind": "required",
"name": "x-forter-siteid",
"type": "string",
"example": "a1b2c3d4e5f6",
"description": "Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.
",
"default": "8b47c6d423ba"
},
{
"kind": "required",
"name": "Authorization",
"type": "string",
"example": "Basic ",
"description": "Basic Authentiation in the form of a username and password. Use the API Key as the username and leave the password empty.",
"default": "Basic "
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "required",
"name": "body",
"type": "object",
"description": "Enroll a merchant in Forter's 3DS execution services on their future orders. \nThe response will include a request ID that can be used to check on the status.",
"customType": "threeDsExecutionOnboardingRequest",
"schema": [
{
"name": "offerings",
"kind": "required",
"type": "object",
"description": "Selection of offerings the merchant signed up for",
"modelRef": "#/components/schemas/ThreeDsOfferings",
"customType": "ThreeDsOfferings",
"schema": [
{
"name": "policy_3ds",
"kind": "required",
"type": "boolean",
"description": "Register 3DS for policy",
"example": "",
"default": true
},
{
"name": "psd2",
"kind": "required",
"type": "boolean",
"description": "Register 3DS for PSD2 regulation",
"example": "",
"default": true
},
{
"name": "risk_3ds",
"kind": "required",
"type": "boolean",
"description": "Register 3DS for risk",
"example": "",
"default": true
}
]
},
{
"name": "threeDsConfiguration",
"kind": "required",
"type": "object",
"description": "The 3DS configuration",
"modelRef": "#/components/schemas/ThreeDsConfiguration",
"customType": "ThreeDsConfiguration",
"schema": [
{
"name": "processors",
"kind": "required",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/Processor",
"customType": "Processor[]",
"schema": [
{
"name": "id",
"kind": "required",
"type": "string",
"description": "Internal Forter ID for your Processor. Ask it from your Implementation Manager.",
"example": ""
},
{
"name": "mids",
"kind": "required",
"type": "array",
"description": "Mids - merchant identifiers for 3DS",
"modelRef": "#/components/schemas/MerchantIdentifierFor3ds",
"customType": "MerchantIdentifierFor3ds[]",
"schema": [
{
"name": "acquirerId",
"kind": "required",
"type": "string",
"description": "Internal Forter ID for your Acquirer. Ask it from your Implementation Manager.",
"example": ""
},
{
"name": "acquirerMerchantName",
"kind": "required",
"type": "array",
"description": "Acquirer's merchant name for each card scheme",
"modelRef": "#/components/schemas/CardParameter",
"customType": "CardParameter[]",
"schema": [
{
"name": "cardScheme",
"kind": "required",
"type": "string",
"example": "",
"default": "VISA"
},
{
"name": "value",
"kind": "required",
"type": "string",
"example": "",
"default": "string"
}
]
},
{
"name": "acquirerMid",
"kind": "required",
"type": "string",
"description": "Acquirer Merchant Identifier (MID)",
"example": "",
"default": "123456789"
},
{
"name": "merchantCategoryCode",
"kind": "required",
"type": "string",
"description": "The merchants category code (MCC)",
"example": "",
"default": "5661"
},
{
"name": "merchantEntityCountryNumericCode",
"kind": "required",
"type": "string",
"description": "Merchant entity country code",
"example": "",
"default": "840"
},
{
"name": "requestorId",
"kind": "required",
"type": "array",
"description": "Requestor ids by card schema",
"modelRef": "#/components/schemas/CardParameter",
"customType": "CardParameter[]",
"schema": [
{
"name": "cardScheme",
"kind": "required",
"type": "string",
"example": "",
"default": "VISA"
},
{
"name": "value",
"kind": "required",
"type": "string",
"example": "",
"default": "string"
}
]
},
{
"name": "requestorName",
"kind": "required",
"type": "array",
"description": "Requestor ids by card schema",
"modelRef": "#/components/schemas/CardParameter",
"customType": "CardParameter[]",
"schema": [
{
"name": "cardScheme",
"kind": "required",
"type": "string",
"example": "",
"default": "VISA"
},
{
"name": "value",
"kind": "required",
"type": "string",
"example": "",
"default": "string"
}
]
},
{
"name": "requestorUrl",
"kind": "required",
"type": "array",
"description": "Requestor urls per card scheme",
"modelRef": "#/components/schemas/CardParameter",
"customType": "CardParameter[]",
"schema": [
{
"name": "cardScheme",
"kind": "required",
"type": "string",
"example": "",
"default": "VISA"
},
{
"name": "value",
"kind": "required",
"type": "string",
"example": "",
"default": "string"
}
]
},
{
"name": "supportedCurrencies",
"kind": "optional",
"type": "array",
"description": "Supported currency codes",
"example": "",
"default": [
"USD"
],
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "supportedSchemes",
"kind": "optional",
"type": "array",
"description": "Supported card schemes",
"example": "",
"default": [
"VISA"
],
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "supportedStates",
"kind": "optional",
"type": "array",
"description": "Supported states",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
}
]
}
]
}
]
}
],
"modelRef": "#/components/schemas/threeDsExecutionOnboardingRequest",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "basicAuth",
"name": "basicAuth",
"kind": "optional",
"type": "http",
"scheme": "basic"
}
]
},
"responses": [
{
"statusCode": "200",
"description": "Example threeDsExecutionOnboardingRequestAccepted",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "Response structure for merchant onboarding requests",
"customType": "threeDsExecutionOnboardingRequestAccepted",
"schema": [
{
"name": "requestId",
"kind": "required",
"type": "string",
"example": "",
"default": "my-request-id-1234"
},
{
"name": "status",
"kind": "required",
"type": "string",
"example": "",
"default": "success"
}
],
"modelRef": "#/components/schemas/threeDsExecutionOnboardingRequestAccepted",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "Bad Request (Often missing a required parameter)",
"jsonExample": "",
"isExpanded": true
},
{
"statusCode": "401",
"description": "Unauthorized (No valid API key provided)",
"jsonExample": "",
"isExpanded": true
},
{
"statusCode": "404",
"description": "Not Found (The requested item doesn't exist)",
"jsonExample": "",
"isExpanded": true
},
{
"statusCode": "500",
"description": "Server Error (Something went wrong on Forter's end)",
"jsonExample": "",
"isExpanded": true
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "example-0-curl",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url https://api.forter-secure.com/merchants/{id}/3ds-execution \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'api-version: 10.1' \\\n --header 'x-forter-siteid: 8b47c6d423ba' \\\n --header 'authorization: Basic ' \\\n --data '{\n \"offerings\": {\n \"policy_3ds\": true,\n \"psd2\": true,\n \"risk_3ds\": true\n },\n \"threeDsConfiguration\": {\n \"processors\": [\n {\n \"id\": \"\",\n \"mids\": [\n {\n \"acquirerId\": \"\",\n \"acquirerMerchantName\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"acquirerMid\": \"123456789\",\n \"merchantCategoryCode\": \"5661\",\n \"merchantEntityCountryNumericCode\": \"840\",\n \"requestorId\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"requestorName\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"requestorUrl\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"supportedCurrencies\": [\n \"USD\"\n ],\n \"supportedSchemes\": [\n \"VISA\"\n ]\n }\n ]\n }\n ]\n }\n }'"
},
{
"id": "example-1-javascript",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"api-version\", \"10.1\");\nmyHeaders.append(\"x-forter-siteid\", \"8b47c6d423ba\");\nmyHeaders.append(\"authorization\", \"Basic \");\n\nvar raw = JSON.stringify({\n \"offerings\": {\n \"policy_3ds\": true,\n \"psd2\": true,\n \"risk_3ds\": true\n },\n \"threeDsConfiguration\": {\n \"processors\": [\n {\n \"id\": \"\",\n \"mids\": [\n {\n \"acquirerId\": \"\",\n \"acquirerMerchantName\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"acquirerMid\": \"123456789\",\n \"merchantCategoryCode\": \"5661\",\n \"merchantEntityCountryNumericCode\": \"840\",\n \"requestorId\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"requestorName\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"requestorUrl\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"supportedCurrencies\": [\n \"USD\"\n ],\n \"supportedSchemes\": [\n \"VISA\"\n ]\n }\n ]\n }\n ]\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.forter-secure.com/merchants/{id}/3ds-execution\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "example-2-ruby",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.forter-secure.com/merchants/{id}/3ds-execution\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"api-version\"] = \"10.1\"\nrequest[\"x-forter-siteid\"] = \"8b47c6d423ba\"\nrequest[\"authorization\"] = \"Basic \"\nrequest.body = JSON.dump({\n \"offerings\": {\n \"policy_3ds\": true,\n \"psd2\": true,\n \"risk_3ds\": true\n },\n \"threeDsConfiguration\": {\n \"processors\": [\n {\n \"id\": \"\",\n \"mids\": [\n {\n \"acquirerId\": \"\",\n \"acquirerMerchantName\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"acquirerMid\": \"123456789\",\n \"merchantCategoryCode\": \"5661\",\n \"merchantEntityCountryNumericCode\": \"840\",\n \"requestorId\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"requestorName\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"requestorUrl\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"supportedCurrencies\": [\n \"USD\"\n ],\n \"supportedSchemes\": [\n \"VISA\"\n ]\n }\n ]\n }\n ]\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "example-3-python",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.forter-secure.com/merchants/{id}/3ds-execution\"\n\npayload = json.dumps({\n \"offerings\": {\n \"policy_3ds\": True,\n \"psd2\": True,\n \"risk_3ds\": True\n },\n \"threeDsConfiguration\": {\n \"processors\": [\n {\n \"id\": \"\",\n \"mids\": [\n {\n \"acquirerId\": \"\",\n \"acquirerMerchantName\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"acquirerMid\": \"123456789\",\n \"merchantCategoryCode\": \"5661\",\n \"merchantEntityCountryNumericCode\": \"840\",\n \"requestorId\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"requestorName\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"requestorUrl\": [\n {\n \"cardScheme\": \"VISA\",\n \"value\": \"string\"\n }\n ],\n \"supportedCurrencies\": [\n \"USD\"\n ],\n \"supportedSchemes\": [\n \"VISA\"\n ]\n }\n ]\n }\n ]\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'api-version': '10.1',\n 'x-forter-siteid': '8b47c6d423ba',\n 'authorization': 'Basic '\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "example-0-curl"
},
"results": {
"languages": [
{
"id": "response-0-200",
"language": "200",
"code": "// Example threeDsExecutionOnboardingRequestAccepted\n{\n \"requestId\": \"\",\n \"status\": \"\"\n}"
},
{
"id": "response-1-400",
"language": "400",
"code": "// Bad Request (Often missing a required parameter)\n"
},
{
"id": "response-2-401",
"language": "401",
"code": "// Unauthorized (No valid API key provided)\n"
},
{
"id": "response-3-404",
"language": "404",
"code": "// Not Found (The requested item doesn't exist)\n"
},
{
"id": "response-4-500",
"language": "500",
"code": "// Server Error (Something went wrong on Forter's end)\n"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"id": "gAT8biUidkOkqAW5ytIrF",
"type": "paragraph",
"children": [
{
"text": "将商家注册到Forter的3DS执行服务，以便他们的未来订单。\n响应将包括一个请求ID，可用于检查状态。"
}
]
}
]
}