Evaluate a transaction

Request

Submit a backend transaction for real-time risk evaluation and receive a recommendation (TRUST, ALLOW, CHALLENGE, or DENY) together with the transaction action token and evaluation context.

Security

risk_access_token

Bodyapplication/jsonrequired

transaction_dataobjectrequired

custom_attributesobject

Custom attributes add context to an action but must match the schema defined in the Portal. Invalid attributes are ignored.

correlation_idstring, [ 1 .. 255 ] characters

Any ID that could help relate the action with external context or session

Example:"550e8400-e29b-41d4-a716-446655440000"

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/risk/v1/transaction-monitoring/evaluate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transaction_data": {
      "type": "purchase",
      "method": "card",
      "reason": "Monthly subscription payment",
      "amount": 1500.75,
      "currency": "USD",
      "payer": {
        "name": "John Doe",
        "bankIdentifier": "CHASEUS33",
        "branchIdentifier": "123456",
        "accountNumber": "1234567890123456",
        "accountId": "USER_983245",
        "accountCountryCode": "US",
        "card": {
          "holderName": "John Doe",
          "bin": "411111",
          "last4": "1234"
        },
        "billingInfo": {
          "name": "John Doe",
          "addressLine1": "123 Main St",
          "addressLine2": "Apt 4B",
          "city": "New York",
          "state": "NY",
          "zipPostalCode": "10001",
          "country": "US",
          "email": "john.doe@example.com",
          "phone": "+1234567890"
        },
        "customerTier": "premium"
      },
      "payee": {
        "name": "John Doe",
        "bankIdentifier": "CHASEUS33",
        "branchIdentifier": "123456",
        "accountNumber": "1234567890123456",
        "accountId": "USER_983245",
        "accountCountryCode": "US",
        "card": {
          "holderName": "John Doe",
          "bin": "411111",
          "last4": "1234"
        }
      },
      "channelId": "MOBILE_APP",
      "transactionDate": 1712594340000,
      "purchase": {
        "totalItems": 3,
        "products": [
          {
            "id": "PROD_12345",
            "name": "iPhone 15",
            "amount": 1,
            "price": 999.99
          }
        ],
        "shippingInfo": {
          "name": "John Doe",
          "addressLine1": "123 Main St",
          "addressLine2": "Apt 4B",
          "city": "New York",
          "state": "NY",
          "zipPostalCode": "10001",
          "country": "US",
          "email": "john.doe@example.com",
          "phone": "+1234567890"
        }
      },
      "avs": {
        "code": "Y",
        "provider": "Stripe",
        "matchLevel": "full"
      }
    },
    "custom_attributes": {
      "property1": "string",
      "property2": "string"
    },
    "correlation_id": "550e8400-e29b-41d4-a716-446655440000"
  }'

Responses

Transaction evaluated successfully

Bodyapplication/json

action_tokenstringrequired

The token returned when the transaction event was reported.

Example:"ea49707f023f48d64a7a817a2e7a5ff4277281a8f8ac1848ccac407967d9d2ce"

recommendationobjectrequired

Response

{
  "action_token": "ea49707f023f48d64a7a817a2e7a5ff4277281a8f8ac1848ccac407967d9d2ce",
  "recommendation": {
    "id": "string",
    "issued_at": 0,
    "recommendation": { … },
    "risk_score": 0,
    "context": { … },
    "reasons": [ … ],
    "threats": [ … ],
    "transaction_data": { … },
    "custom_attributes": {},
    "triggered_rules": [ … ]
  }
}