TransactionReturnedNotification

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

Callbacks take the form of a HTTP request to a server you have specified. The TransactionReturnNotification data type forms the body of these requests and contains details of the transaction request id, the value of the return, the reason for return and a link to where further details of the transaction can be found.

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

Property	Type	Description
ReturnedOnUTC	DateTime	The datetime when the return was completed.
ReturnReason	String	Text indicating the reason the transaction was returned.
ReturnValue	Number and String	Number and text indicating the value and currency of the return.
TransactionRequestId	String (optional)	The ID of the transaction request.
TimestampUTC	DateTime	The datetime when the notification was triggered.
Link	String	A URL (location link) to the transaction in the API.

{
  "ReturnedOnUTC": "2024-02-16T09:04:40.02637Z",
  "ReturnReason": "Return reason 1",
  "ReturnValue": {"Value":500.0,"Currency":"GBP"},
  "TransactionRequestId": "3698f31c-1845-4f47-a4b1-cade6f805d57",
  "TimestampUTC": "2024-02-16T09:04:40.3941987Z",
  "Link": "https://staging-api.vitessepsp.com/api/transactions/3698f31c-1845-4f47-a4b1-cade6f805d57"
}