Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Narmi card linked offers API

The card linked offers API from Narmi — 2 operation(s) for card linked offers.

Narmi card linked offers API is one of 44 APIs that Narmi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include card linked offers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.sandbox.narmi.dev/.

4 operations 2 paths 6 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.sandbox.narmi.dev/
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Narmi card linked offers API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

card linked offers 4
GET
/v1/card-linked-offers/
Get card offers
card_linked_offers_retrieve 1 param → 200403422503
GET
/v1/card-linked-offers/enrollment/
Check enrollment status
card_linked_offers_enrollment_retrieve → 200403422503
POST
/v1/card-linked-offers/enrollment/
Enroll user in card linked offers
card_linked_offers_enrollment_create → 201403422503
DELETE
/v1/card-linked-offers/enrollment/
Unenroll user from card linked offers
card_linked_offers_enrollment_destroy → 200403404422503

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CardOffer (16 properties), CardOfferAsset (3 properties), CardOfferEnrollmentStatus (1 property). Each schema is shown below with its type and property counts.

PurchaseChannelsEnum
string
online - online instore - instore
CardOfferEnrollmentStatus
object
Serializer for enrollment status response
1 property
CategoriesEnum
string
Arts & Entertainment - Arts & Entertainment Baby, Kids & Toys - Baby, Kids & Toys Books & Digital Media - Books & Digital Media Clothing, Shoes & Accessories -…
CardOfferAsset
object
Serializer for card offer assets.
3 properties 3 required
RewardTypeEnum
string
flat - flat percentage - percentage
CardOffer
object
Serializer for card offers returned by the API.
16 properties 16 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-card-linked-offers-api-openapi.yml Raw ↑

Other APIs Narmi publishes across the network.

Narmi account balances API
Narmi accounts API
Narmi ach companies API
Narmi ach destinations API
Narmi ach import API
Narmi ach payments API
Narmi ach transfers API
Narmi alerts API
Narmi automatic savings enrollment API
Narmi cards API
Narmi data access management API
Narmi deposits API