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

The transactions API from Narmi — 3 operation(s) for transactions.

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

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

This API exposes 4 operations across 3 paths, and defines 15 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 3 paths 15 schemas 3 GET1 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 transactions 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 3 paths, the API surfaces 4 operations — 3 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

transactions 4
GET
/v1/transactions/
List user transactions
transactions_list_2 10 params → 200404422500
GET
/v1/transactions/{uuid}/
Retrieve transaction
transactions_retrieve 2 params → 200404
PUT
/v1/transactions/{uuid}/
Update transaction
transactions_update 1 param body → 200422
GET
/v1/transactions/{uuid}/images/
Retrieve transaction image
transactions_images_list 1 param → 200404422503

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Transaction (20 properties), PatchedTransactionRequest (3 properties), TransactionsResponse (3 properties), TransactionResponseMeta (3 properties). Each schema is shown below with its type and property counts.

AccountsNotFoundError
object
2 properties
NotFoundError
object
2 properties 1 required
InvalidRequestError
object
2 properties
PageNumberPagination
object
2 properties 2 required
Location
object
3 properties
Transaction
object
Representation of a non-pending monetary transaction.
20 properties
TransactionResponseMeta
object
3 properties 1 required
TransactionImagesResponse
object
1 property 1 required
TransactionsResponse
object
3 properties 3 required
Type61cEnum
string
TransactionsDetail
object
1 property 1 required
Check
object
1 property
CheckImage
object
2 properties
PatchedTransactionRequest
object
Representation of a non-pending monetary transaction.
3 properties
NullEnum

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-transactions-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 cards API
Narmi data access management API