FLflagright
transactionEvents

Create a Transaction Event

Changed on

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/events/transaction

Request

  • Base URL
    https://sandbox.api.flagright.com
  • URL
    https://sandbox.api.flagright.com/events/transaction
  • Auth
    API key in header x-api-key

Request body

transactionState'CREATED' | 'PROCESSING' | 'SENT' | 'EXPIRED' | 'DECLINED' | 'SUSPENDED' | 'REFUNDED' | 'SUCCESSFUL' | 'REVERSED' required

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

timestampnumber double required

Timestamp of the event

transactionIdstring required

Transaction ID the event pertains to

eventIdstring

Unique event ID

reasonstring

Reason for the event or a state change

eventDescriptionstring

Event description

externalLinksstring[]

External links related to the transaction

Response

Created

eventIdstring required
status'ALLOW' | 'FLAG' | 'BLOCK' | 'SUSPEND'

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

Changes

  • 1c04818a93a7Revision changes
    • warning

      added the new ANUBIS enum value to the /// response property for the response status

    • warning

      added the new ANUBIS enum value to the /// response property for the response status

    • warning

      added the new APTOS enum value to the /// response property for the response status

    • warning

      added the new APTOS enum value to the /// response property for the response status

    • warning

      added the new ARC enum value to the /// response property for the response status

    • warning

      added the new ARC enum value to the /// response property for the response status

    • warning

      added the new ARWEAVE enum value to the /// response property for the response status

    • warning

      added the new ARWEAVE enum value to the /// response property for the response status

    • warning

      added the new BERACHAIN enum value to the /// response property for the response status

    • warning

      added the new BERACHAIN enum value to the /// response property for the response status

    • warning

      added the new BIFROST_NETWORK enum value to the /// response property for the response status

    • warning

      added the new BIFROST_NETWORK enum value to the /// response property for the response status

    • warning

      added the new BITTENSOR enum value to the /// response property for the response status

    • warning

      added the new BITTENSOR enum value to the /// response property for the response status

    • warning

      added the new BLAST enum value to the /// response property for the response status

    • warning

      added the new BLAST enum value to the /// response property for the response status

    • warning

      added the new BOT_CHAIN enum value to the /// response property for the response status

    • warning

      added the new BOT_CHAIN enum value to the /// response property for the response status

    • warning

      added the new CANTON_NETWORK enum value to the /// response property for the response status

    • warning

      added the new CANTON_NETWORK enum value to the /// response property for the response status

    • warning

      added the new CELO enum value to the /// response property for the response status

    • warning

      added the new CELO enum value to the /// response property for the response status

    • warning

      added the new CHAINFLIP enum value to the /// response property for the response status

    • warning

      added the new CHAINFLIP enum value to the /// response property for the response status

    • warning

      added the new CRONOS enum value to the /// response property for the response status

    • warning

      added the new CRONOS enum value to the /// response property for the response status

    • warning

      added the new DYDX enum value to the /// response property for the response status

    • warning

      added the new DYDX enum value to the /// response property for the response status

    • warning

      added the new ETHEREUM_CLASSIC enum value to the /// response property for the response status

    • warning

      added the new ETHEREUM_CLASSIC enum value to the /// response property for the response status

    • warning

      added the new ETHERLINK enum value to the /// response property for the response status

    • warning

      added the new ETHERLINK enum value to the /// response property for the response status

    • warning

      added the new FILECOIN enum value to the /// response property for the response status

    • warning

      added the new FILECOIN enum value to the /// response property for the response status

    • warning

      added the new FLARE enum value to the /// response property for the response status

    • warning

      added the new FLARE enum value to the /// response property for the response status

    • warning

      added the new FLOW enum value to the /// response property for the response status

    • warning

      added the new FLOW enum value to the /// response property for the response status

    • warning

      added the new FRAXTAL enum value to the /// response property for the response status

    • warning

      added the new FRAXTAL enum value to the /// response property for the response status

    • warning

      added the new GNOSIS_CHAIN enum value to the /// response property for the response status

    • warning

      added the new GNOSIS_CHAIN enum value to the /// response property for the response status

    • warning

      added the new HYDRATION enum value to the /// response property for the response status

    • warning

      added the new HYDRATION enum value to the /// response property for the response status

    • warning

      added the new IMMUTABLE_X enum value to the /// response property for the response status

    • warning

      added the new IMMUTABLE_X enum value to the /// response property for the response status

    • warning

      added the new INJECTIVE enum value to the /// response property for the response status

    • warning

      added the new INJECTIVE enum value to the /// response property for the response status

    • warning

      added the new INK enum value to the /// response property for the response status

    • warning

      added the new INK enum value to the /// response property for the response status

    • warning

      added the new INTERNET_COMPUTER enum value to the /// response property for the response status

    • warning

      added the new INTERNET_COMPUTER enum value to the /// response property for the response status

    • warning

      added the new IOTA enum value to the /// response property for the response status

    • warning

      added the new IOTA enum value to the /// response property for the response status

    • warning

      added the new KAIA enum value to the /// response property for the response status

    • warning

      added the new KAIA enum value to the /// response property for the response status

    • warning

      added the new KATANA enum value to the /// response property for the response status

    • warning

      added the new KATANA enum value to the /// response property for the response status

    • warning

      added the new KAVA enum value to the /// response property for the response status

    • warning

      added the new KAVA enum value to the /// response property for the response status

    • warning

      added the new LINEA enum value to the /// response property for the response status

    • warning

      added the new LINEA enum value to the /// response property for the response status

    • warning

      added the new MANTLE enum value to the /// response property for the response status

    • warning

      added the new MANTLE enum value to the /// response property for the response status

    • warning

      added the new MEGAETH enum value to the /// response property for the response status

    • warning

      added the new MEGAETH enum value to the /// response property for the response status

    • warning

      added the new MEZO enum value to the /// response property for the response status

    • warning

      added the new MEZO enum value to the /// response property for the response status

    • warning

      added the new MIXIN enum value to the /// response property for the response status

    • warning

      added the new MIXIN enum value to the /// response property for the response status

    • warning

      added the new MONAD enum value to the /// response property for the response status

    • warning

      added the new MONAD enum value to the /// response property for the response status

    • warning

      added the new MORPH enum value to the /// response property for the response status

    • warning

      added the new MORPH enum value to the /// response property for the response status

    • warning

      added the new MULTIVERSX enum value to the /// response property for the response status

    • warning

      added the new MULTIVERSX enum value to the /// response property for the response status

    • warning

      added the new OSMOSIS enum value to the /// response property for the response status

    • warning

      added the new OSMOSIS enum value to the /// response property for the response status

    • warning

      added the new PHAROS enum value to the /// response property for the response status

    • warning

      added the new PHAROS enum value to the /// response property for the response status

    • warning

      added the new PLASMA enum value to the /// response property for the response status

    • warning

      added the new PLASMA enum value to the /// response property for the response status

    • warning

      added the new PROVENANCE enum value to the /// response property for the response status

    • warning

      added the new PROVENANCE enum value to the /// response property for the response status

    • warning

      added the new PULSECHAIN enum value to the /// response property for the response status

    • warning

      added the new PULSECHAIN enum value to the /// response property for the response status

    • warning

      added the new RISE enum value to the /// response property for the response status

    • warning

      added the new RISE enum value to the /// response property for the response status

    • warning

      added the new ROBINHOOD_CHAIN enum value to the /// response property for the response status

    • warning

      added the new ROBINHOOD_CHAIN enum value to the /// response property for the response status

    • warning

      added the new ROLLUX enum value to the /// response property for the response status

    • warning

      added the new ROLLUX enum value to the /// response property for the response status

    • warning

      added the new ROOTSTOCK enum value to the /// response property for the response status

    • warning

      added the new ROOTSTOCK enum value to the /// response property for the response status

    • warning

      added the new SCROLL enum value to the /// response property for the response status

    • warning

      added the new SCROLL enum value to the /// response property for the response status

    • warning

      added the new SEI enum value to the /// response property for the response status

    • warning

      added the new SEI enum value to the /// response property for the response status

    • warning

      added the new STABLE enum value to the /// response property for the response status

    • warning

      added the new STABLE enum value to the /// response property for the response status

    • warning

      added the new STACKS enum value to the /// response property for the response status

    • warning

      added the new STACKS enum value to the /// response property for the response status

    • warning

      added the new STARKNET enum value to the /// response property for the response status

    • warning

      added the new STARKNET enum value to the /// response property for the response status

    • warning

      added the new STORY enum value to the /// response property for the response status

    • warning

      added the new STORY enum value to the /// response property for the response status

    • warning

      added the new STRATO_CHAIN enum value to the /// response property for the response status

    • warning

      added the new STRATO_CHAIN enum value to the /// response property for the response status

    • warning

      added the new TAIKO enum value to the /// response property for the response status

    • warning

      added the new TAIKO enum value to the /// response property for the response status

    • warning

      added the new THORCHAIN enum value to the /// response property for the response status

    • warning

      added the new THORCHAIN enum value to the /// response property for the response status

    • warning

      added the new TON enum value to the /// response property for the response status

    • warning

      added the new TON enum value to the /// response property for the response status

    • warning

      added the new UNICHAIN enum value to the /// response property for the response status

    • warning

      added the new UNICHAIN enum value to the /// response property for the response status

    • warning

      added the new WORLD_CHAIN enum value to the /// response property for the response status

    • warning

      added the new WORLD_CHAIN enum value to the /// response property for the response status

    • warning

      added the new XDC_NETWORK enum value to the /// response property for the response status

    • warning

      added the new XDC_NETWORK enum value to the /// response property for the response status

    • warning

      added the new XPR_NETWORK enum value to the /// response property for the response status

    • warning

      added the new XPR_NETWORK enum value to the /// response property for the response status

    • warning

      added the new X_LAYER enum value to the /// response property for the response status

    • warning

      added the new X_LAYER enum value to the /// response property for the response status

    • warning

      added the new ZKSYNC_ERA enum value to the /// response property for the response status

    • warning

      added the new ZKSYNC_ERA enum value to the /// response property for the response status

    • info

      added the new ANUBIS enum value to the request property ///

    • info

      added the new ANUBIS enum value to the request property ///

    • info

      added the new APTOS enum value to the request property ///

    • info

      added the new APTOS enum value to the request property ///

    • info

      added the new ARC enum value to the request property ///

    • info

      added the new ARC enum value to the request property ///

    • info

      added the new ARWEAVE enum value to the request property ///

    • info

      added the new ARWEAVE enum value to the request property ///

    • info

      added the new BERACHAIN enum value to the request property ///

    • info

      added the new BERACHAIN enum value to the request property ///

    • info

      added the new BIFROST_NETWORK enum value to the request property ///

    • info

      added the new BIFROST_NETWORK enum value to the request property ///

    • info

      added the new BITTENSOR enum value to the request property ///

    • info

      added the new BITTENSOR enum value to the request property ///

    • info

      added the new BLAST enum value to the request property ///

    • info

      added the new BLAST enum value to the request property ///

    • info

      added the new BOT_CHAIN enum value to the request property ///

    • info

      added the new BOT_CHAIN enum value to the request property ///

    • info

      added the new CANTON_NETWORK enum value to the request property ///

    • info

      added the new CANTON_NETWORK enum value to the request property ///

    • info

      added the new CELO enum value to the request property ///

    • info

      added the new CELO enum value to the request property ///

    • info

      added the new CHAINFLIP enum value to the request property ///

    • info

      added the new CHAINFLIP enum value to the request property ///

    • info

      added the new CRONOS enum value to the request property ///

    • info

      added the new CRONOS enum value to the request property ///

    • info

      added the new DYDX enum value to the request property ///

    • info

      added the new DYDX enum value to the request property ///

    • info

      added the new ETHEREUM_CLASSIC enum value to the request property ///

    • info

      added the new ETHEREUM_CLASSIC enum value to the request property ///

    • info

      added the new ETHERLINK enum value to the request property ///

    • info

      added the new ETHERLINK enum value to the request property ///

    • info

      added the new FILECOIN enum value to the request property ///

    • info

      added the new FILECOIN enum value to the request property ///

    • info

      added the new FLARE enum value to the request property ///

    • info

      added the new FLARE enum value to the request property ///

    • info

      added the new FLOW enum value to the request property ///

    • info

      added the new FLOW enum value to the request property ///

    • info

      added the new FRAXTAL enum value to the request property ///

    • info

      added the new FRAXTAL enum value to the request property ///

    • info

      added the new GNOSIS_CHAIN enum value to the request property ///

    • info

      added the new GNOSIS_CHAIN enum value to the request property ///

    • info

      added the new HYDRATION enum value to the request property ///

    • info

      added the new HYDRATION enum value to the request property ///

    • info

      added the new IMMUTABLE_X enum value to the request property ///

    • info

      added the new IMMUTABLE_X enum value to the request property ///

    • info

      added the new INJECTIVE enum value to the request property ///

    • info

      added the new INJECTIVE enum value to the request property ///

    • info

      added the new INK enum value to the request property ///

    • info

      added the new INK enum value to the request property ///

    • info

      added the new INTERNET_COMPUTER enum value to the request property ///

    • info

      added the new INTERNET_COMPUTER enum value to the request property ///

    • info

      added the new IOTA enum value to the request property ///

    • info

      added the new IOTA enum value to the request property ///

    • info

      added the new KAIA enum value to the request property ///

    • info

      added the new KAIA enum value to the request property ///

    • info

      added the new KATANA enum value to the request property ///

    • info

      added the new KATANA enum value to the request property ///

    • info

      added the new KAVA enum value to the request property ///

    • info

      added the new KAVA enum value to the request property ///

    • info

      added the new LINEA enum value to the request property ///

    • info

      added the new LINEA enum value to the request property ///

    • info

      added the new MANTLE enum value to the request property ///

    • info

      added the new MANTLE enum value to the request property ///

    • info

      added the new MEGAETH enum value to the request property ///

    • info

      added the new MEGAETH enum value to the request property ///

    • info

      added the new MEZO enum value to the request property ///

    • info

      added the new MEZO enum value to the request property ///

    • info

      added the new MIXIN enum value to the request property ///

    • info

      added the new MIXIN enum value to the request property ///

    • info

      added the new MONAD enum value to the request property ///

    • info

      added the new MONAD enum value to the request property ///

    • info

      added the new MORPH enum value to the request property ///

    • info

      added the new MORPH enum value to the request property ///

    • info

      added the new MULTIVERSX enum value to the request property ///

    • info

      added the new MULTIVERSX enum value to the request property ///

    • info

      added the new OSMOSIS enum value to the request property ///

    • info

      added the new OSMOSIS enum value to the request property ///

    • info

      added the new PHAROS enum value to the request property ///

    • info

      added the new PHAROS enum value to the request property ///

    • info

      added the new PLASMA enum value to the request property ///

    • info

      added the new PLASMA enum value to the request property ///

    • info

      added the new PROVENANCE enum value to the request property ///

    • info

      added the new PROVENANCE enum value to the request property ///

    • info

      added the new PULSECHAIN enum value to the request property ///

    • info

      added the new PULSECHAIN enum value to the request property ///

    • info

      added the new RISE enum value to the request property ///

    • info

      added the new RISE enum value to the request property ///

    • info

      added the new ROBINHOOD_CHAIN enum value to the request property ///

    • info

      added the new ROBINHOOD_CHAIN enum value to the request property ///

    • info

      added the new ROLLUX enum value to the request property ///

    • info

      added the new ROLLUX enum value to the request property ///

    • info

      added the new ROOTSTOCK enum value to the request property ///

    • info

      added the new ROOTSTOCK enum value to the request property ///

    • info

      added the new SCROLL enum value to the request property ///

    • info

      added the new SCROLL enum value to the request property ///

    • info

      added the new SEI enum value to the request property ///

    • info

      added the new SEI enum value to the request property ///

    • info

      added the new STABLE enum value to the request property ///

    • info

      added the new STABLE enum value to the request property ///

    • info

      added the new STACKS enum value to the request property ///

    • info

      added the new STACKS enum value to the request property ///

    • info

      added the new STARKNET enum value to the request property ///

    • info

      added the new STARKNET enum value to the request property ///

    • info

      added the new STORY enum value to the request property ///

    • info

      added the new STORY enum value to the request property ///

    • info

      added the new STRATO_CHAIN enum value to the request property ///

    • info

      added the new STRATO_CHAIN enum value to the request property ///

    • info

      added the new TAIKO enum value to the request property ///

    • info

      added the new TAIKO enum value to the request property ///

    • info

      added the new THORCHAIN enum value to the request property ///

    • info

      added the new THORCHAIN enum value to the request property ///

    • info

      added the new TON enum value to the request property ///

    • info

      added the new TON enum value to the request property ///

    • info

      added the new UNICHAIN enum value to the request property ///

    • info

      added the new UNICHAIN enum value to the request property ///

    • info

      added the new WORLD_CHAIN enum value to the request property ///

    • info

      added the new WORLD_CHAIN enum value to the request property ///

    • info

      added the new XDC_NETWORK enum value to the request property ///

    • info

      added the new XDC_NETWORK enum value to the request property ///

    • info

      added the new XPR_NETWORK enum value to the request property ///

    • info

      added the new XPR_NETWORK enum value to the request property ///

    • info

      added the new X_LAYER enum value to the request property ///

    • info

      added the new X_LAYER enum value to the request property ///

    • info

      added the new ZKSYNC_ERA enum value to the request property ///

    • info

      added the new ZKSYNC_ERA enum value to the request property ///