Transaction Timeline (1.0)

Download OpenAPI specification:Download

Public api that deals with transaction timeline

Authentication

XCompleatApiKey

Security Scheme Type API Key
Header parameter name: x-api-compleat-key

Transaction Timeline

Get Transaction Timeline

Used to retrieve a transaction's timeline/s

Authorizations:
path Parameters
tenantId
required
string <guid>

The tenant id

transactionId
required
string <guid>

The transaction id

command
required
string

The command whether to return current or all timelines for a transaction

userId
required
string <guid>

The user id - optional (use NULL value if unavailable)

header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Responses

200

Successful api call returns a transaction timeline

400

Bad Request

401

Unauthorized. The secure credentials passed do not allow access to this resource.

500

An internal error has occurred.

get/api/transactiontimeline/{tenantId}/{transactionId}/{command}/{userId}
/api/transactiontimeline/{tenantId}/{transactionId}/{command}/{userId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Timelines":
    [
    ],
  • "MetaData":
    {
    }
}