Forter Orders API

openapi: 3.0.3
info:
  title: Forter Accounts Orders API
  description: 'Forter is a fraud prevention and digital identity platform for online commerce. Its Core API returns real-time trust decisions for orders, payments, account signups, and logins, and supports chargeback recovery, abuse prevention, and data-privacy workflows.


    GROUNDING NOTE: The paths, HTTP methods, and authentication scheme in this document are grounded in Forter''s public documentation at docs.forter.com (see each operation''s `x-forter-status`). Request and response BODY schemas are MODELED for orientation - Forter does not publish a machine-readable OpenAPI, and the full order/account payloads are large and provisioned per-integration. Treat the schemas below as representative, not authoritative; confirm exact fields against your account''s customized API reference in the Forter Portal.


    ACCESS: Forter is enterprise / contact-sales. Credentials (a per-account site ID and an API key) are provisioned by Forter during onboarding. Requests are sent to a dedicated per-tenant host by prepending your site ID to the API host - `https://{siteId}.api.forter.secure.com/{endpoint}`. The generic host `api.forter.secure.com` shown in the servers block is the documented form; the bare host does not resolve without the site-ID prefix.'
  version: '1.0'
  contact:
    name: Forter
    url: https://www.forter.com
servers:
- url: https://api.forter.secure.com
  description: 'Documented API host. In practice, prepend your account site ID: https://{siteId}.api.forter.secure.com'
security:
- basicAuth: []
tags:
- name: Orders
  description: Order and checkout fraud/abuse decisions and order status.
paths:
  /v2/orders/{orderId}:
    parameters:
    - $ref: '#/components/parameters/OrderId'
    post:
      operationId: submitOrderV2
      tags:
      - Orders
      summary: Submit an order for a decision (v2)
      description: Send order and checkout information at checkout to receive a real-time fraud or abuse decision. The response may also carry payment optimization or abuse-prevention recommendations.
      x-forter-status: Path/method confirmed against docs.forter.com. Request/response schema MODELED.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderInput'
      responses:
        '200':
          description: A Forter decision for the order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Decision'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v3/orders/{orderId}:
    parameters:
    - $ref: '#/components/parameters/OrderId'
    post:
      operationId: submitOrderV3
      tags:
      - Orders
      summary: Submit an order for a decision (v3)
      description: Version 3 of the order decision endpoint. Same intent as v2 - submit order/checkout data and receive a fraud or abuse decision - with the v3 request/response shape.
      x-forter-status: Path/method confirmed against docs.forter.com (Order v3). Request/response schema MODELED.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderInput'
      responses:
        '200':
          description: A Forter decision for the order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Decision'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v2/status/{orderId}:
    parameters:
    - $ref: '#/components/parameters/OrderId'
    post:
      operationId: submitOrderStatus
      tags:
      - Orders
      summary: Report order status
      description: Report the downstream lifecycle status of an order back to Forter (for example, that it was captured, shipped, cancelled, or refunded). No decision is returned; this input improves the model.
      x-forter-status: Path/method confirmed against docs.forter.com (Order status). Request schema MODELED.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderStatusInput'
      responses:
        '200':
          description: Acknowledgement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ack'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    OrderInput:
      type: object
      description: MODELED subset of the order/checkout payload. Real orders include detailed buyer, cart, payment, shipping, and connection information.
      properties:
        orderId:
          type: string
        checkoutTime:
          type: integer
          description: Epoch seconds when checkout occurred.
        totalAmount:
          $ref: '#/components/schemas/Amount'
        primaryDeliveryDetails:
          type: object
          additionalProperties: true
        cartItems:
          type: array
          items:
            type: object
            additionalProperties: true
        accountOwner:
          type: object
          additionalProperties: true
        payment:
          type: array
          items:
            type: object
            additionalProperties: true
        connectionInformation:
          type: object
          additionalProperties: true
    OrderStatusInput:
      type: object
      description: MODELED order status payload.
      properties:
        orderId:
          type: string
        updatedStatus:
          type: string
          enum:
          - AUTHORIZATION_REQUESTED
          - CAPTURED
          - CANCELED_BY_MERCHANT
          - CANCELED_BY_CUSTOMER
          - SHIPPED
          - REFUNDED
          - COMPLETED
        updateTime:
          type: integer
    Ack:
      type: object
      description: MODELED acknowledgement envelope.
      properties:
        status:
          type: string
          example: success
    Decision:
      type: object
      description: MODELED representation of a Forter decision response. The real payload includes richer recommendation and reason detail.
      properties:
        forterDecision:
          type: string
          description: The Forter recommendation.
          enum:
          - approve
          - decline
          - not reviewed
          - verification requested
        forterToken:
          type: string
          description: The Forter managed token correlating this event.
        reasonCode:
          type: string
        recommendation:
          type: string
    Amount:
      type: object
      description: MODELED monetary amount.
      properties:
        amountUSD:
          type: string
        currency:
          type: string
          example: USD
    Error:
      type: object
      description: MODELED error envelope.
      properties:
        status:
          type: string
        message:
          type: string
  parameters:
    OrderId:
      name: orderId
      in: path
      required: true
      description: A unique identifier for the order, generated by the merchant.
      schema:
        type: string
  responses:
    Unauthorized:
      description: Missing or invalid credentials (site ID / API key).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'HTTP Basic authentication with your Forter API key as the username (empty password). Requests must also carry the `x-forter-siteid` header (your site ID), an `api-version` header (for example `10.1`), and `Content-Type: application/json`. Credentials are provisioned by Forter during onboarding.'