WinkPG Docs

View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

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.

`ClientIpGeoSnapshot`

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 geolocation and ISP/ASN data resolved from the transaction's `clientIpAddress` at the enrichment stage of the orchestration pipeline. This snapshot is <b>immutable</b> after creation. Subsequent updates to the transaction (capture, refund, reversal, repeat, recurring-billing materializations) MUST NOT overwrite it: the snapshot captures the geo intelligence as it was at the moment the original transaction ran. If the underlying IP intelligence database changes (DB-IP MMDB upgrade, ASN reassignment, ISP rebrand, etc.) the persisted snapshot is preserved so historical transactions remain auditable against the data the system saw at runtime. All fields are nullable because not every IP record carries every column: fine-grained fields like `city` are sparse for IP ranges that DB-IP can only localize to a country or region.

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

countryA2 required

string

ISO 3166-1 alpha-2 country code (e.g. `"US"`). nullable

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.

countryName required

string

Country name in English (e.g. `"United States"`). nullable

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.

region required

string

First-level administrative subdivision name (e.g. US state, Canadian province, German Land). May be the ISO subdivision code in some records and the localized name in others. nullable

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.

city required

string

City name (e.g. `"Minneapolis"`). nullable

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.

latitude required

number (double)

Approximate latitude of the IP block centroid in decimal degrees. Resolution depends on the database tier: country, city, or block. nullable

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.

longitude required

number (double)

Approximate longitude of the IP block centroid in decimal degrees. nullable

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.

timeZone required

string

IANA time zone (e.g. `"America/Chicago"`). nullable

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.

isp required

string

Internet Service Provider name. Available in editions that include ISP data (Location+ISP / Full). nullable

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.

organization required

string

Organization name registered for the IP block. May coincide with `isp` for residential blocks but typically diverges for hosting / corporate blocks. nullable

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.

asNumber required

integer (int64)

Autonomous System Number (e.g. `15169` for Google). nullable

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.

connectionType required

string

Connection / usage type as classified by DB-IP. Typical values: `"Residential"`, `"Business"`, `"Hosting"`, `"Mobile"`, `"Education"`, `"Government"`. The exact vocabulary is supplied by the database; consumers should treat unknown values as opaque. nullable

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.