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 cards API

The cards API from Narmi — 10 operation(s) for cards.

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

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

This API exposes 14 operations across 10 paths, and defines 25 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/.

14 operations 10 paths 25 schemas 1 DELETE7 GET5 POST1 PUT

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 cards API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 14

Across 10 paths, the API surfaces 14 operations — 1 DELETE, 7 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

cards 14
GET
/v1/cards/
List cards for a user
cards_list 1 param → 200403404500
GET
/v1/cards/{card_id}/
Retrieve specified card
cards_retrieve 1 param → 200403500
PUT
/v1/cards/{card_id}/deprecated
Activate or deactivate card
cards_update 1 param body → 200403404422406500
GET
/v1/cards/{card_id}/address/
Retrieve card address
cards_address_retrieve 1 param → 200403404500
GET
/v1/cards/{card_id}/limits/
Get specified card limits
cards_limits_retrieve 1 param → 200403404500
POST
/v1/cards/{card_id}/limits/
Update card limits
cards_limits_create 1 param → 200400403404422500
POST
/v1/cards/{card_id}/lock/
Lock a card
cards_lock_create 1 param → 200403404500
POST
/v1/cards/{card_id}/replace_card/
Replace a missing card
cards_replace_card_create 1 param body → 200400403404500
GET
/v1/cards/{card_id}/sensitive/
Retrieve card PAN
cards_sensitive_retrieve 1 param → 200404500
GET
/v1/cards/{card_id}/subscriptions/
Retrieve card subscriptions
cards_subscriptions_retrieve 3 params → 200400403404500
GET
/v1/cards/{card_id}/travel_note/
Get a card's travel notice
cards_travel_note_list 2 params → 200403404500
POST
/v1/cards/{card_id}/travel_note/
Create travel note
cards_travel_note_create 1 param body → 200400403404500
DELETE
/v1/cards/{card_id}/travel_note/
Delete travel note
cards_travel_note_destroy 1 param → 204403404500
POST
/v1/cards/{card_id}/unlock/
Unlock a card
cards_unlock_create 1 param → 200403404500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are CardInfo (9 properties), CommonCard (8 properties), Card (8 properties), Address (7 properties). Each schema is shown below with its type and property counts.

Address
object
7 properties 4 required
CardShippingInfo
object
integrations.cards.apimessages.Shipping
3 properties 2 required
RecurringTransaction
object
6 properties 6 required
CardSubscriptionsAndTransactions
object
2 properties 2 required
CardRequest
object
1 property 1 required
CardTravelNote
object
For getting and setting integrations.cards.apimessages.CardTravelNote
2 properties 2 required
CardSubscriptions
object
7 properties 7 required
PaginatedCardInfoList
object
4 properties 2 required
CardInfo
object
integrations.cards.apimessages.CardInfo
9 properties 4 required
MissingCardRequest
object
1 property 1 required
CommonCard
object
integrations.cards.common.Card
8 properties 7 required
CardTransactionsByMonth
object
4 properties 4 required
CardStateEnum
string
active - active inactive - inactive
CardTravelNoteRequest
object
For getting and setting integrations.cards.apimessages.CardTravelNote
3 properties 3 required
Card
object
8 properties 1 required
StateBd5Enum
string
locked - locked normal - normal shipped - shipped cancelled - cancelled damaged - damaged
CardSubscriptionsStateEnum
string
current - current new - new cancelled - cancelled
SensitiveCardInfo
object
3 properties 3 required
ReasonEnum
string
damaged - damaged lost - lost stolen - stolen
TravelDestinationCodesEnum
string
AW - AW AF - AF AO - AO AI - AI AX - AX AL - AL AD - AD AE - AE AR - AR AM - AM AS - AS AQ - AQ TF - TF AG - AG AU - AU AT - AT AZ - AZ BI - BI BE - BE BJ - BJ…
CardLimits
object
For getting and setting card limits
5 properties
LegacyUpdateCardResponse
object
1 property
BlankEnum
RecurrenceFrequencyEnum
string
daily - daily semi-monthly - semi-monthly monthly - monthly bimonthly - bimonthly quarterly - quarterly biannually - biannually annually - annually -
PaginatedCardTravelNoteList
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-cards-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 card linked offers API
Narmi data access management API
Narmi deposits API