Digital cards are created through order placement, not directly. To create a new digital card, place an order for a digital card variant via
POST /v3/orders. The digital card entity is created and activated as part of the order flow and can then be retrieved via this API.Authentication methods
Every digital card is redeemed with one of two authentication methods. The method is set for your Company during onboarding by the Snappy team and applies to all your digital cards — you don’t need to checkauthentication.method per card, and changing methods later requires coordination with Snappy.
OTP— the recipient authenticates by entering a one-time password. When they open the digital card page in Snappy’s UI, Snappy sends a fresh, single-use code; a new code is issued on each access attempt. Snappy manages the entire flow end-to-end: notifications, code generation and delivery, and any recipient support. This is Snappy’s default configuration for most integrations.accessCode— the recipient authenticates with a static code that Snappy generates at order placement and returns to you via this API. From that point on, you own the recipient communication (email, SMS, in-app message, or however your platform reaches recipients) and any related support. This setup fits integrations that want to embed the code in a single, unified notification they send themselves rather than a separate Snappy email.
When to use
Whether you need these endpoints depends on your Company’s authentication method:- If your Company is on
OTP: Snappy handles the entire redemption flow, so you don’t need to call these endpoints to complete a redemption. They’re still available for auditing — use them to verify that a digital card was created for an order, or to keep a local record for reporting. - If your Company is on
accessCode: use this API to retrieve access codes after order placement, then send them to recipients through your own channel. Typical flow:- Place an order for a digital card variant via
POST /v3/orders. - List digital cards with
GET /v3/digital-cards?filter[orderId]={orderId}to get eachdigitalCardId. - Call
GET /v3/digital-cards/{digitalCardId}/access-codeto retrieve the code. - Include the code in your notification to the recipient.
- Place an order for a digital card variant via
GET /v3/products?filter[catalog]=digitalCards to browse available digital card products and their variants before placing an order.
Endpoints
List digital cardsfilter[orderId] to scope to a specific order, include=brand to expand brand details, and page[number] / page[size] for pagination (max 150, default 100).
Get digital card by ID
include=brand to expand brand details on the response.
Get digital card access code
422 if your Company is on OTP authentication.
Permissions
All Digital Cards endpoints require thedigital-card:read scope.