Order v3

POST

Send order information at checkout to receive a fraud or abuse decision. The response may also include recommendations based on your payment optimization features or abuse prevention policies, or a managed order token to include when requesting the 3DS result.

Credentials

HTTP Basic basicAuth

Path Parameters

• id
  string

Header Parameters

• api-version
  string
• x-forter-siteid
  string

Body Parameters

• body
  v3OrderRequest

Description

Parameters

• accountOwner
  object
  All Of
  • additionalIdentifiers
    object
    All Of
  • additionalInformation
    object
    All Of
  • authorizationStep
    string<PRE_AUTHORIZATION | POST_AUTHORIZATION>
  • cartItems
    Item[]
  • checkoutTime
    number
  • connectionInformation
    ConnectionInformation
  • customerAccountData
    object
    All Of

Responses

• 200
  • Example v3OrderResponse

  {
      "decisionReason": "",
      "forterDecision": "APPROVE",
      "linkToEventInDashboard": "https://portal.forter.com/dashboard/:id",
      "managedOrderToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
      "merchantPolicyId": "0ee8ba28a8654c659addbae9253b707c",
      "orderId": "123456",
      "recommendation": "",
      "verificationMethod": {
          "correlationId": "HGJ7512345H3DE",
          "status": "FRICTIONLESS",
          "statusCode": "100",
          "statusMessage": "Verification code sent",
          "type": "THREE_DS",
          "verificationId": "345H3DEHGJ7512",
          "verificationSpecificData": {
              "ThreeDS": {},
              "email": {},
              "phone": {}
          }
      }
  }
  

• Responses
  • 400 - "Bad Request"
  • 401 - "Unauthorized"
  • 404 - "Not Found"
  • 500 - "Server Error"

Example Request

curl --request POST \
  --url https://api.forter-secure.com/v3/orders/{id} \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'api-version: 10.1' \
  --header 'x-forter-siteid: a1b2c3d4e5f6' \
  --data-raw '{
    "accountOwner": {
        "email": "john_s@test.com",
       ...
    }
}'