TransactionCompletedNotification

When a transaction has progressed through the system, we use a callback mechanism to notify you that the transaction has completed.

Callbacks take the form of a HTTP request to a server you have specified. The TransactionNotification data type forms the body of these requests and contains details of the transaction request id, whether the request succeeded or failed, and a link to where further details of the transaction can be found.

This callback indicates that the transaction has completed, which means that we have finished processing it. The Succeeded flag is set to define whether the completion was successful or whether there was a failure.

Please note there is a separate notification for returned transactions.

📘
Setup Required
Callbacks are not enabled by default. You will need to login to the Merchant Administration System and enable them.

Property	Type	Description
TransactionRequestId	String	The ID of the transaction request.
Succeeded	Boolean	Flag to indicate if the transaction succeeded - true if it did, false otherwise.
FailureReason	String (optional)	For failed transactions, text indicating the reason the transaction failed.
Link	String	A URL (location link) to the transaction in the API.
ExternalReference1	String (optional)	The ExternalReference1 field provided to the original API call. This will be omitted if no value was provided.
ExternalReference2	String (optional)	The ExternalReference2 field provided to the original API call. This will be omitted if no value was provided.
ExternalReference3	String (optional)	The ExternalReference2 field provided to the original API call. This will be omitted if no value was provided.
CompletedOnUTC	DateTime	The datetime when the transaction completed.

{
  "TransactionRequestId": "xxxx",
  "Succeeded": true,
  "Link": "https://staging-api.vitessepsp.com/api/transactions/xxxxxx",
  "ExternalReference1": "yyyyy",
  "CompletedOnUTC": "2017-10-16T20:44:48.9809421Z"
}

The above is what would be returned from the system for a transaction request that had complete processing successfully. In the event that an error occurred whilst processing, a failure response will be returned...

{
  "TransactionRequestId": "xxxx",
  "Succeeded": "false",
  "FailureReason": "Recipient account closed",
  "Link": "https://staging-api.vitessepsp.com/api/transactions/xxxxxx",
  "ExternalReference1": "yyyyy",
  "CompletedOnUTC": "2017-10-16T20:44:48.9809421Z"
}