Sign in

v1

latestOpenAPI 3.0.0Forter License2026-07-1333204516.7 KB
3DS

3DS result

Check the 3DS results using the managed order token returned in Forter's response to the order request.

post/v3/orders/{id}/results

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

managedOrderTokenstring required

The managedOrderToken returned from the create endpoint

Example request

{
  "managedOrderToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjIwMjMtMDUtMjMifQ.eyJmb3J0ZXJPcGFxdWVEYXRhIjoiZm9ydGVyT3BhcXVlRGF0YSIsImF1ZCI6ImNoZWNrb3V0dG9vbHMiLCJpc3MiOiJodHRwczovL2FwaS5jaGVja291dHRvb2xzLmNvbS92My9tYW5hZ2VkL29yZGVycyIsImV4cCI6MTczMzk0NzYxNH0.i3Q2KsUerRNQMfCGKQgoR_0AIENOKZ0C99kiRtlkuVQqbmhPRo0A4c42XHp0J_-kdJbCW2W1WckgglTy8GGRfwzVfZ2szSxJCB6QOd4uHwn0BN1GeTdY3qjtBHF48ihsDhfYXvII4Kl2zpL54aJfCePuYANedhxAWJZnUCcSKxFDYsj-gHGGApZbgPhnMI1QfUme2CHjpxu2vGTC0xC08OQuYO7vbESQU_YnLsc-xQYBrOy_4XuOEJDq8fK2O5saiZZEknNvLxouAzn16p5lzWJ3sp-tsJR-a9C_KgNqz_Nv4SaeSYQMhJwrYXXLhNP2ueTHdzEObtm7Skp_NQFdXBBF4vMO4HhKKBzNnfWjsKKCb6Utb__AZNbW4XYn9788wdHNVu-TVhiHRYOg19iOHaJS1l8DfHqMN0o-98Cmdu9prhGIvey64FrcEoAf9jhUjT4LN9u0zuH1jbwfpG-owmHEnpAY6dtZilK81zrf6A3OhRIB5_cECdutSa_UHXP1xapUsGoQMy3T5qaecnj6VqwXI1Cc3vrhsaewRCqJqDTeHG2slttrWBrigvXk4rFwWVazn_Y_PCy-WCfcazXK6nTCJTQ_mBoM24S-W6jRlOsfplDDl5cKGrvsulqXDuDqRzJnc_AmkVOWM9AvqqgkC5ef_2xcGprFi4xDjXkScz4"
}

Response

Example v3OrderResultsResponse

decisionReasonstring required

The main reason behind the Forter decision

forterDecision'APPROVE' | 'DECLINE' | 'NOT REVIEWED' required

The latest Forter decision regarding the attempted action

linkToEventInDashboardstring required

Link to the event in the decision dashboard

merchantPolicyIdstring required

UID of the custom policy created in Forter's Policies tool that resulted in this decision

orderIdstring required

Transaction/order ID. Note that Forter treats this ID as case-insensitive; Order123 and ORDER123 will be identified as the same order.

recommendationstring required

A specific recommendation for an action that might help the customer to complete their transaction/action (e.g. verify phone via SMS, verify via push notification, verify email, perform a 3DS check, etc.)

Example response

{
  "forterDecision": "APPROVE",
  "linkToEventInDashboard": "https://portal.forter.com/dashboard/:id",
  "merchantPolicyId": "0ee8ba28a8654c659addbae9253b707c",
  "orderId": "123456",
  "paymentRecommendations": {
    "processors": [
      {
        "priority": 1
      }
    ]
  },
  "verificationMethod": {
    "correlationId": "HGJ7512345H3DE",
    "status": "FRICTIONLESS",
    "statusCode": "100",
    "statusMessage": "Verification code sent",
    "type": "THREE_DS",
    "verificationId": "345H3DEHGJ7512",
    "verificationSpecificData": {
      "ThreeDS": {
        "ACSUrl": "https:/ /acs-us-east-1.nd.nds-sandbox-issuer.com/api/v1/acs/browser_sdk_challenges",
        "ECIValue": "02",
        "acsChallengeMandated": "Y",
        "acsReferenceNumber": "ftr-internal-acs-approval",
        "acsTransID": "6fd30e89-8171-4cc3-b86e-3d59582af2f6",
        "authenticationType": "01",
        "authenticationValue": "tSvPDt3PINNaoL+ERXdg0jVrmWc=",
        "bankLiabilityShift": true,
        "cardEnrolled": "Y",
        "cavvAlgorithm": "3",
        "challengeCancel": "01",
        "challengeStatus": "Y",
        "dsTransID": "38bbf46f-c023-4f4c-ae2c-35fb301632a5",
        "encodedChallengeRequest": "eyJhY3NUcmFuc0lEIjoiMTEyY2RiNWItMGFlYy00MTY5LThjMWYtYWMyN2JlNjAxMjhhIiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA0IiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsIm1lc3NhZ2VUeXBlIjoiQ1JlcSIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiZWRhM2MwMzYtZWMyYS00NmZkLTlmYWItNzBlZTgyYjJjNzQ5In0=",
        "exemption": "TRANSACTION_RISK_ANALYSIS",
        "interactionCounter": "01",
        "messageCategory": "01",
        "outOfScopeForPSD2": "ANONYMOUS_PREPAID_CARD",
        "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45",
        "threeDSecureMode": "sca",
        "threeDSecurePreference": "nopref",
        "threeDSecureResult": "590040",
        "transStatus": "Y",
        "transStatusReason": "01",
        "verifyStatus": "Y",
        "version": "2.1.0"
      },
      "email": {
        "email": "john_s@test.com",
        "emailVerification": {
          "sent": true,
          "timeSent": 1389567341
        }
      },
      "phone": {
        "phone": "15557654321",
        "smsVerified": {
          "sent": true,
          "timeSent": 1389567341
        }
      }
    }
  }
}