EsmStateEvent

An event that indicates a state change of the ESM for a given transaction. An event contains information An event that indicates a state change of the ESM for a given transaction. An event contains information regarding the ESM's view of a given transaction as the state of the transaction changes.

apiVersion
required
string

The version of the Electrum Regulated Payments Events API which the event format conforms to i.e. the version of this API.

class
required
string

The class of the event.

actionDate
required
string <date>

The date at which the transaction should take effect. The date must be formatted as defined by date-time in RFC3339

creationDateTime
required
string <date-time>

The date and time at which the event was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

object (EventEsmPayload)
required
object (EventEsmIdentifiers)

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

required
object (EventEsmState)
required
object (EventEsmTransactionInfo)
{
  • "apiVersion": "string",
  • "class": "ESM_STATE",
  • "actionDate": "2019-08-24",
  • "creationDateTime": "2019-08-24T14:15:22Z",
  • "eftDataRecord": {
    },
  • "identifiers": {
    },
  • "state": {
    },
  • "transactionInfo": {
    }
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.