Visa Offers Network API Reference

Visa Offers Network

Search API Reference

API Reference

Consent Service
- getRetrieve a Specific Consent Status for a User
- delDelete a Specific Consent Record for a User
- getRetrieve All Consent Status for a User
- delRemove All Consent for a User
- postCreate Consent
Consumer Enrollment Service
- delDelete Consumer Enrollment Opt-In
- postAdd PAN for a User
- getGet User Consents
- postConsumer Enrollment Opt-In
- postConsumer Enrollment - Opt In - Generic
Eligibility Service
- getGet Segments By Card ID
- getGet Merchant Ranks by Card ID
- getGet Merchant Ranks by User ID
- getGet Segments By User ID
- postGet Offers for User
Ledger Service
- postLedger Add Event
- postLedger Add Event - Generic
- getConsumer Dashboard
Merchant Service
- postCreate Merchants - Generic
- patchUpdate Merchants - Generic
- postCreate Merchants
- patchUpdate Merchants
- getGet a Merchant
- delDelete a Merchant
Offers Service
- getGet Offer by GOR Merchant ID
- delDelete Offer
- postCreate Offers Under a Merchant - Generic
- patchUpdate Offers for a Merchant - Generic
- getGet and Filter Offers
- postCreate New Offers
- putUpdate Offers
- putUpdate Offers - Generic
- postCreate New Offers - Generic
- getGet Offers for a Specific Merchant
- delDelete Offer For a Merchant
- postCreate Offers under a Merchant
- patchUpdate Offers for a Merchant
Payout Service
- postPayout Request
- postPayout Request - Generic

Consent Service

Provides endpoints to manage user consents.

Retrieve a Specific Consent Status for a User v1 - Latest

Retrieve a specific consent record for a user by consent type.

Request

Path Parameters

Parameter	Description
clientAppId required	Client Application ID
consentType required	Consent type (Enum: "PERSONALIZATION", "LOCATION", "MEASUREMENT", "MARKETING", "THIRD_PARTY_SHARING")
externalId required	External ID

Header Parameters

Parameter	Description
EX-CORRELATION-ID	External correlation ID for request tracking
X-GOR-API-KEY required	API key provided during onboarding by the VON team
X-GOR-SHARED-SECRET required	Shared secret provided during onboarding by the VON team

Responses

200
Consent retrieved successfully

Response Schema: application/json

Property	Description
clientId	Client application ID (Example: "LOYALTY_APP")
consentChoice	User's consent choice (true=consent given, false=consent denied) (Example: true)
consentType	Type of consent (Enum: "PERSONALIZATION", "LOCATION", "MEASUREMENT", "MARKETING", "THIRD_PARTY_SHARING") (Example: "PERSONALIZATION")
createdAt	Record creation timestamp (Example: "2026-01-06T15:45:00")
id	Consent record ID (Example: "550e8400-e29b-41d4-a716-446655440000")
isActive	Whether the consent record is active (true=active, false=inactive) (Example: true)
updatedAt	Record last update timestamp (Example: "2026-01-06T15:45:00")
validAndGranted

404
Consent not found
500
Internal server error

Response samples

200

{
  "consentChoice": true,
  "createdAt": "2026-03-19T04:23:19",
  "clientId": "2cc8b3fa-c22d-4797-a834-3875e91daab7",
  "validAndGranted": true,
  "consentType": "PERSONALIZATION",
  "id": "d6079c00-2ec1-42d3-ab45-5c1f71cf2414",
  "isActive": true,
  "updatedAt": "2026-03-19T07:23:19"
}