This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Point-in-time snapshot of the browser context of the client that submitted a transaction, as
observed from the request that created it.
The two header members are supplied by the client (a request header on the hosted payment page and the
virtual terminal, a request body field on the API), so neither is trustworthy evidence of
anything on its own. They exist because external fraud screening providers score on them: a
user agent is one of the inputs FraudLabs Pro and Riskified both weight, and the request that
carries no device context is scored as if it came from nowhere.
Like `ClientIpGeoSnapshot` this is a snapshot of what was observed at create time,
not a live reading. Subsequent transaction operations (capture, refund, reversal, repeat,
recurring-billing materializations) must not overwrite it.
Values
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description
userAgentrequired
string
The `User-Agent` header sent by the submitting browser, or `null` when
none was observed. Null is the normal state for system-initiated transactions (recurring
billing, offline batch) and for API callers that do not send one.nullablemax length 512
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
acceptLanguagerequired
string
The `Accept-Language` header sent by the submitting browser, or
`null` when none was observed. Carried verbatim, weighting and all, because
a screening provider scores the header as sent rather than a language the platform picked
out of it.nullablemax length 64
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
deviceFingerprintrequired
string
A platform device fingerprint: a keyed hash of the user agent, the accept-language and the
network prefix of the client IP address, as 64 lowercase hexadecimal characters. Null when no
user agent was observed, which is the normal state for system-initiated transactions.nullableread only
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.