TransactionsTransaction Timeline

Transaction Timeline

This endpoint retrieves the timeline or outline of a specific transaction using either its unique ID or its reference.

API Endpoint

GET https://backendapi.sayswitchgroup.com/api/v1/transaction/timeline/:id_or_reference

Path Parameter:

  • :id_or_reference: The unique identifier (id) or the reference code of the transaction you want to retrieve the timeline for (e.g., 2280 or SSW_17471703346211972).

Sample Request

curl -X GET https://backendapi.sayswitchgroup.com/api/v1/transaction/timeline/SSW_17471703346211972 
  -H "Authorization: Bearer `YOUR_SECRET_KEY`"

Sample Response

{
  "success": true,
  "message": "Timeline retrieved",
  "data": {
    "time_spent": 0,
    "attempts": 0,
    "authentication": null,
    "errors": 0,
    "success": false,
    "channel": null,
    "history": []
  }
}

Explanation of the Response

FieldTypeDescription
time_spentintegerThe total time spent processing the transaction (in milliseconds).
attemptsintegerThe number of attempts made to process the transaction.
authenticationmixedDetails about any authentication steps involved (may be null).
errorsintegerThe total number of errors encountered during the transaction processing.
successbooleanIndicates whether the transaction was ultimately successful (within this timeline context).
channelstringThe channel used for the transaction (e.g., “card”, “bank”, may be null).
historyarrayAn array containing a chronological record of events and statuses for the transaction. Each element in the array will likely be an object with details about a specific event (timestamp, status, message, etc.).
Get Transaction by ReferenceTransaction Total