transactionEvents

Create a Transaction Event

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

No recorded changes to this operation across all 1 revision of this API.