Cardlytics Documentation
Geocoordinates
Initializing search
Platform Solutions
Ad Server API
Publisher Solution
Powered By
Publisher Management
SDK
BSP CSR API
Cardlytics Documentation
Platform Solutions
Ad Server API
Ad Server API
Overview
Common API Features
Common API Features
Versions
Health Check
HTTP Responses
Customize API Responses
Custom Http Headers
Endpoints
Endpoints
Security API
Security API
Get Security Token
Get Remote Authentication Token
Customers API
Customers API
Customer Information
Start Customer's Session
Opt Customer In/Out
Update Primary Account
Update Customer Preferences
Ads API
Ads API
Get Ads
Get Ad Count for State
Get Ad Counts for all States
Mark Ads as Served
Park Ads for Customer
Un-Park Ads for Customer
Activate Ad/Ads
Get Ad Collection
Get Nearby Merchants
Get Nearby Merchants for Ad
Get Reward Summary
Get Redemptions
Events API
Events API
Logging Client Events
Data
Data
Types
Types
Account
Ad
AdCount
AdCounts
AdImage
AdLink
AdList
Beacons
CategoryGroup
ClientEventMessage
Creative
Collection
CollectionMetadata
Customer
DisplayServingAd
MerchantLocation
Program
PurchaseRequirement
Tags
RedemptionList
Redemption
RewardSummary
RewardSummaryTotals
Enumerations
Enumerations
AdStatus
AdType
Channel
ClientEvent
DisplayType
GroupType
Location
OfferPromotion
PurchaseChannel
Publisher Solution
Publisher Solution
Platform v2.0
Integrations
Integrations
Overview
Connect via mTLS
Create a Sandbox Environment
Use the Sandbox APIs
Learn about SDK 3.0
Getting Started
Getting Started
Start a Session
Get Scopes for API Access
Integration Processes & Services
Transaction Share
Data Model, Services & Flow
SDK
SDK
Learn about SDK 3.0
API
API
Overview
Ads
Ads
Overview
Get ads
Customers
Customers
Overview
Get customer profile
Get customer ad redemption
Get customer reward summary
Data
Data
Overview
Create customers
Create customer events
Create customer transactions
Update accounts
Update customers
Update cards
Events
Events
Create customer events
Support
Support
Overview
Get customer offers
Settle customer rewards
Objects
Objects
Overview
Types
Types
Account
Ad
AdRankings
AdAssetList
Image
AdText
AdTextValue
CallsToAction
Beacons
Card
CategoryGroup
ClientEventMessage
ClientEventMetadata
Collection
CollectionMetadata
Customer
Geocoordinates
MerchantLocation
Program
Redemption
RewardSummary
RewardSummaryTotals
SessionToken
Offer
Portfolio
PortfolioEnrollment
Purchase Requirements
PurchaseChannel
StoreLocationAddress
StoreLocation
Ticket
TransactionRedemption
TransactionNotification
UpdateAdStatesErrorResponses
UpdateAdStatesRequestParameters
UpdateCustomerParameters
Enumerations
Enumerations
AdActivationState
AdRedemptionState
AdRewardType
AdType
AdStatusLegacy
AssetType
AdVisibilityState
AlertOptInStatus
CallToActionLinkType
CardPresentIndicator
CardStatus
CardType
Channel
ClientEventType
ClientEvent
CustomerAccountUpdateType
CustomerStatus
CustomerTargetingIndicator
ClientEventType
DisplayType
EnrollmentOptInStatus
EventType
FIAccountStatus
FIAccountType
GroupType
IncludeExpiredAds
IssueType
OfferStatus
Online-Indicator
PaymentType
PurchaseChannel
RealTimeMessagingEventType
RedemptionStatus
ResolutionType
RewardCurrencyUnit
Section
TicketIdType
TicketStatus
TransactionType
Developer Tools
Developer Tools
Overview
Data transactions
Notifications
Reporting
Realtime-Messaging
Reward settlements
Partners
Partners
Overview
Error Handling & Debugging
Error Handling & Debugging
Overview
In Development
In Development
Overview
Ad Rankings feature
Transaction Disposition feature
Release Notes
Release Notes
Latest
Powered By
Powered By
Overview
How it Works
PoweredBy for FIs
PoweredBy for FIs
User Experience
User Experience
Overview
Authentication
Mobile SDK
Mobile SDK
Integration
Optional Modules
Optional Modules
Account Summary
Alternative Browsers
Custom Callbacks
Error Callbacks
Deep Linking
Locked Offers
User Location
Theming
Releases
Web Experience
Web Experience
Integration
Theming
Debugging
API Reference
API Reference
Authentication
Webhooks
Webhooks
Notify Reward
Push Notifications
Endpoints
Endpoints
Notify Transaction
Marketing Offers Search
Disposition Lookup
Test Endpoints
Test Endpoints
Validate Sandbox Token
Sandbox Notify Transactions
PoweredBy for AnyCard
PoweredBy for AnyCard
User Experience
User Experience
Card Management
Card Vaulting
API Reference
API Reference
Webhooks
Webhooks
Notify Enrollment
Endpoints
Endpoints
Search Dispositions
Test Endpoints
Test Endpoints
Sandbox Notify Reward
Sandbox Notify Enrollment
Availability Rate
Analytics & Data Share
Reconciliation Report
Zendesk Integration
Publisher Management
Publisher Management
Endpoints
Endpoints
/v2
/v2
Institution
Organization
Portfolio
SDK
SDK
Overview
How it Works
User Experience
User Experience
Overview
Web SDK
Web SDK
Integration
Optional Modules
Optional Modules
Widget
Theming
Authentication
Mobile SDK
Mobile SDK
Integration
Optional Modules
Optional Modules
Widget
Alternative Browsers
Error Callbacks
Deep Linking
User Location
Theming
Releases
Authentication API
Analytics & Data Share
BSP CSR API
BSP CSR API
Overview
Common API Features
Common API Features
Versions
Authentication
Health Check
Endpoints
Endpoints
Offers API
Offers API
Get Offers
Get Offer By Id
Get Offer Redemptions
Redemptions API
Redemptions API
Get Redemptions
Get Redemptions By Id
Transactions API
Transactions API
Get Transactions
Tickets API
Tickets API
Get Tickets
Get Customer Tickets
Get Ticket By Id
Add Ticket
Update Ticket
Lock API
Lock API
Add Resource Lock
Delete Resource Lock
Data
Data
Types
Types
OfferFilterResponse
OfferResponse
OfferRedemptionResponse
TransactionResponse
RedemptionResponse
TicketResponse
TicketDetailsResponse
Enumerations
Enumerations
ResolutionType
IssueType
OfferStatus
RedemptionStatus
ResourceType
RewardType
CaseEntryType
TicketIdType
TicketStatus
Geocoordinates
Property
Type
Description
latitude
number
longitude
number