Transaction ID

All requests sent from a specific API consumer must include a Transaction ID (in the Header) which will be included in the subsequent responses.

Header

Description

X-Transaction-ID

Represents the unique message identifier associated with the request.

It is expected that the client/API invoking this API would provide a valid X-Transaction-ID.

An option is the use of standard GUID strings as Transaction IDs, e.g. 381b23c6-a650-4a12-a93c-4854c49b05d0.

The use of unique Transaction IDs per request, makes tracking issues easier.

The X-Transaction-ID is limited to 40 characters.