TransactionEvent

During processing of a transaction we can provide callbacks to you for a selection of events. The format of the callback in each case is the same and is shown in the following table.

Element	Datatype	Description
TransactionRequestId	Guid	The unique identifier for the transaction
EventType	String	The event that has occurred.
TimestampUTC	Date/Time	This defines the instant that the event was recorded by our system.
Link	String	Fully qualified URI to the transaction that raised the event. You can use this value to query our system for full details of the transaction.
ExternalReference1	String	This optional field is provided if you sent the value in the initial transaction request.
ExternalReference2	String	This optional field is provided if you sent the value in the initial transaction request
ExternalReference3	String	This optional field is provided if you sent the value in the initial transaction request

An example event callback is shown below.

{
    "TransactionRequestId": "ef3f0690-ea25-406b-b71d-6a645081cabb",
    "EventType": "GroupingInitiated",
    "TimestampUTC": "2018-01-15T08:46:10.974809Z",
    "Link": "https://staging-api.vitessepsp.com/api/transactions/ef3f0690-ea25-406b-b71d-6a645081cabb",
    "ExternalReference1": "xxx",
    "ExternalReference2": "yyy",
    "ExternalReference3": "zzz"
}

The value of the EventType element can be one of the following values...

Event	Description
GroupingInitiated	When a deferred transaction is added to the system it's "waiting" to be grouped. This callback provides details of the transaction.
GroupingCompleted	When a deferred transaction (or transactions) are grouped, this callback notifies you of the event.
LiquidityAwaited	Once grouped, we are then awaiting payment for the deferred transaction group. This event signifies that we are waiting for payment to arrive.
LiquidityProvided	Once payment has arrived for a deferred transaction group, a callback is made for each transaction in that group to indicate that liquidity has arrived.
LiquidityFailed	Deferred transactions have a discrete lifetime, and we require payment to be made by a specific point (detailed in the response of the grouping call). If payment has not reached us by this point we will provide a callback indicating that liquidity was not provided in time for the transaction.