API ReferenceTransaction Events

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.

Headers

x-api-keystringRequired

Request

transactionStateenumRequired
Model for transaction states. E.g. Processing, Refunded, Successful etc.
timestampdoubleRequired>=315529200000<=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
riskScoreDetailsobject or null

Errors