/v1/evaluate

post

https://api-sandbox.flexfactor.io/v1/evaluate

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

isDeclined

boolean | null

mid

uuid | null

orderId

string | null

siteUrl

string | null

siteId

uuid | null

orderSource

string | null

customerIp

string | null

The cardholder's IP address as captured on the checkout page. Must be the end-user browser IP, not the merchant server IP.

deviceDetails

object

affiliate

object

transaction

object

payer

object

orderItems

array of objects | null

orderItems

billingInformation

object

shippingInformation

object

isMIT

boolean | null

isRecurring

boolean | null

subscription

object

additionalFields

array of objects | null

additionalFields

userDefinedFields

array of objects | null

Array of key/value objects with the same shape as additionalFields.

userDefinedFields

extraData

string | null

Open-ended string that accepts a serialized JSON array of objects with any additional context you want stored with the order.

idempotencyKey

uuid | null

Optional but recommended GUID. Reusing the same key on a retry replays the original response within the 24-hour window; a reused key with a different payload returns 409. A value that is not a GUID returns 400.

senseKey

string | null

SenseJS session key; echoed back in the response.

merchant

object

paymentMethod

object

expiryDateUtc

date-time | null

MIT only. End of the window in which FlexFactor retries the transaction, ISO 8601 in UTC. When omitted, the merchant default expiry applies.

threeDsecure

object

transactionType

string | null

enum

Defaults to PURCHASE. Send AUTHORIZATION only if your account is configured for authorize and capture. PREEVALUATE runs a lightweight screening pass.

Allowed:

attemptNumber

int32 | null

The authorization attempt number this request represents: 1 for the original attempt, 2 for the first retry, and so on.

caller

string

enum

Channel that submitted the order. Omit it on direct API calls.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

500

Server Error

200Success

400Bad Request. The request failed validation; the body names the fields in error.

401Unauthorized

404Not Found

409Conflict. An idempotent request with the same key is still in progress, or the idempotency key was reused with a materially different payload.

503Service Unavailable. The duplicate-request check is temporarily unavailable; honor the Retry-After header and retry.