Retrieve enhanced location data

Requires the caas:enhanced_transactions:read scope. Retrieve enhanced location and merchant data for a transaction ID. This will fetch additional data from Google. Please note that the data returned from Google should not be cached or stored. This is a premium endpoint and incurs a cost per request.

All string fields include a documented maxLength. Fields sourced from Google Places have soft limits based on observed maximums with a safety margin, as Google does not define formal maximum lengths. Internally controlled fields (e.g. identifiers, format-constrained values) have hard limits.

Tiers (includeFieldTiers): Each tier is cumulative and maps to Google Places API SKUs. Only fields for the requested tier are returned in enhancedLocationData; each field's tier is shown in the response schema.

  • basic (Essentials SKU): address, location, viewport, plusCode, types, addressComponents, formattedAddress, etc.
  • search_pro (Pro SKU): adds businessStatus, displayName, primaryType, googleMapsUri, accessibilityOptions, utcOffsetMinutes, containingPlaces, etc.
  • search_enterprise (Enterprise SKU): adds rating, priceLevel, priceRange, openingHours, phoneNumbers, websiteUri, etc.
  • search_enterprise_plus (Enterprise + Atmosphere SKU): adds reviews, generativeSummary, reviewSummary, neighborhoodSummary, parkingOptions, paymentOptions, evChargeOptions, fuelOptions, amenity flags (dineIn, delivery, servesBeer, etc.). Note: routingSummaries is not returned — although it is a valid Google Places field at this tier, it requires routingParameters with an origin location which is not available in the enrichment flow (see https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/RoutingSummary).
Path Params
string
required
length between 8 and 36

The account ID as specified on the transaction

string
required
length between 8 and 36

The Transaction ID

Query Params
string
enum
Defaults to basic

Controls which Google Places API SKU fields are returned in enhancedLocationData. Each tier is cumulative. Defaults to basic. See endpoint description for tier summary; each field in the response schema indicates its tier.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*