Create a Transaction Event | Flagright

from flagright import DeviceData, Flagright
client = Flagright(
    api_key="YOUR_API_KEY",
)
client.transaction_events.create(
    transaction_state="SUCCESSFUL",
    timestamp=1752526580000.0,
    transaction_id="443dea26147a406b957d9ee3a1247b11",
    event_id="aaeeb166147a406b957dd9147a406b957",
    event_description="Transaction created",
    meta_data=DeviceData(
        battery_level=76.3,
        device_latitude=13.009711,
        device_longitude=76.102898,
        ip_address="79.144.2.20",
        vpn_used=True,
    ),
)

{
  "eventId": "7b80a539eea6e78acbd6d458e5971482",
  "transaction": {
    "type": "DEPOSIT",
    "transactionId": "7b80a539eea6e78acbd6d458e5971482",
    "timestamp": 1752526580000,
    "originUserId": "8650a2611d0771cba03310f74bf6",
    "destinationUserId": "9350a2611e0771cba03310f74bf6",
    "originAmountDetails": {
      "transactionAmount": 2000,
      "transactionCurrency": "EUR",
      "country": "DE"
    },
    "destinationAmountDetails": {
      "transactionAmount": 68351.34,
      "transactionCurrency": "INR",
      "country": "IN"
    },
    "originPaymentDetails": {
      "method": "CARD",
      "cardFingerprint": "20ac00fed8ef913aefb17cfae1097cce",
      "cardIssuedCountry": "US",
      "transactionReferenceField": "Deposit",
      "3dsDone": true
    },
    "destinationPaymentDetails": {
      "method": "CARD",
      "cardFingerprint": "20ac00fed8ef913aefb17cfae1097cce",
      "cardIssuedCountry": "IN",
      "transactionReferenceField": "Deposit",
      "3dsDone": true
    },
    "promotionCodeUsed": true,
    "reference": "loan repayment",
    "originDeviceData": {
      "batteryLevel": 95,
      "deviceLatitude": 13.0033,
      "deviceLongitude": 76.1004,
      "ipAddress": "10.23.191.2",
      "deviceIdentifier": "3c49f915d04485e34caba",
      "vpnUsed": false,
      "operatingSystem": "Android 11.2",
      "deviceMaker": "ASUS",
      "deviceModel": "Zenphone M2 Pro Max",
      "deviceYear": "2018",
      "appVersion": "1.1.0"
    },
    "destinationDeviceData": {
      "batteryLevel": 95,
      "deviceLatitude": 13.0033,
      "deviceLongitude": 76.1004,
      "ipAddress": "10.23.191.2",
      "deviceIdentifier": "3c49f915d04485e34caba",
      "vpnUsed": false,
      "operatingSystem": "Android 11.2",
      "deviceMaker": "ASUS",
      "deviceModel": "Zenphone M2 Pro Max",
      "deviceYear": "2018",
      "appVersion": "1.1.0"
    },
    "tags": [
      {
        "key": "customKey",
        "value": "customValue"
      }
    ]
  },
  "executedRules": [
    {
      "ruleInstanceId": "string",
      "ruleName": "Proof of funds for high value transactions",
      "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
      "ruleAction": "BLOCK",
      "ruleHit": true,
      "ruleId": "R-1a"
    }
  ],
  "hitRules": [
    {
      "ruleInstanceId": "string",
      "ruleName": "Proof of funds for high value transactions",
      "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
      "ruleAction": "BLOCK",
      "ruleId": "R-1a"
    }
  ]
}

POST Transaction Events

/events/transaction endpoint allows you to operate on the Transaction Events entity.

Transaction events are created after the initial POST /transactions call (which creates a transaction) and are used to:

Update the STATE of the transaction, using the transactionState field and manage the Transaction Lifecycle
Update the transaction details, using the updatedTransactionAttributes field.

If you have neither of the above two use cases, you do not need to use transaction events.

Payload

Each transaction event needs three mandatory fields:

transactionState - STATE of the transaction -> value is set to CREATED after POST /transactions call
timestamp- the timestamp of when the event was created or occured in your system
transactionId - The ID of the transaction for which this event is generated.

In order to make individual events retrievable, you also need to pass in a unique eventId to the request body.

## POST Transaction Events `/events/transaction` endpoint allows you to operate on the [Transaction Events entity.](/guides/overview/entities#transaction-event) Transaction events are created after the initial `POST /transactions` call (which creates a transaction) and are used to: * Update the STATE of the transaction, using the `transactionState` field and manage the [Transaction Lifecycle](/guides/overview/entities#transaction-lifecycle-through-transaction-events) * Update the transaction details, using the `updatedTransactionAttributes` field. > If you have neither of the above two use cases, you do not need to use transaction events. ### Payload Each transaction event needs three mandatory fields: * `transactionState` - STATE of the transaction -> value is set to `CREATED` after `POST /transactions` call * `timestamp`- the timestamp of when the event was created or occured in your system * `transactionId` - The ID of the transaction for which this event is generated. In order to make individual events retrievable, you also need to pass in a unique `eventId` to the request body.

Authentication

x-api-keystring

API Key authentication via header

Request

transactionStateenumRequired

Model for transaction states. E.g. Processing, Refunded, Successful etc.

timestampdoubleRequired315529200000-4133890801000

Timestamp of the event

transactionIdstringRequired>=1 character

Transaction ID the event pertains to

eventIdstringOptional

Unique event ID

reasonstringOptional

Reason for the event or a state change

eventDescriptionstringOptional

Event description

updatedTransactionAttributesobjectOptional

Model for transaction additional payload

metaDataobjectOptional

Model for device data

Response

Created

eventIdstring

transactionobject

executedRuleslist of objects

Unique transaction identifier

hitRuleslist of objects

Unique transaction identifier

statusenum or null

Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst

Allowed values:

riskScoreDetailsobject or null

POST Transaction Events

Payload

Authentication

Request

Response

Errors

POST Transaction Events

Payload