Headers

The system supports standard FDX headers. For a complete list of headers, see the Header section of the latest FDX API Specification.

It is helpful to be aware of the following headers when building a client app to work with the FDX API.

Interaction id header

The FDX interaction type header is supported. The system returns an value that is an auto-generated interaction identifier and unique to each request. You can use the for your own logging purposes, and it also allows support to trace a path of interactions for troubleshooting. The can be sent in the request from the client and returned in a response from the system. The value is the same as the corresponding client request header value, when the client request includes the value.

When implementing your app, we recommend storing the of each response. Please include the associated with the response in any support requests.

Interaction type header

The FDX interaction type request header FDX-API-Actor-Type is supported. The client sends this request header to inform the system that the source of the API traffic is either a USER or BATCH. USER indicates a customer is present and has requested the operation, normally through a user interface. BATCH indicates a customer is not present and a batch job triggered the operation.

The system uses this information to route the request to the appropriate infrastructure and prioritize the real-time request over the batch request during congestion.

Changelog