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

The deposits API from Narmi — 2 operation(s) for deposits.

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

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

This API exposes 3 operations across 2 paths, and defines 12 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/.

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

Paths & Operations 3

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

deposits 3
GET
/v1/deposits/
List deposits
deposits_list → 200422500503
POST
/v1/deposits/
Create a deposit
deposits_create body → 201403404422
GET
/v1/deposits/{deposit_id}/
Retrieve deposit
deposits_retrieve 1 param → 200404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Deposit (7 properties), CreateDepositRequestRequest (4 properties), DepositsResponse (3 properties), CheckDepositError (2 properties). Each schema is shown below with its type and property counts.

CheckDepositError
object
2 properties
NotFoundError
object
2 properties 1 required
InvalidRequestError
object
2 properties
Deposit
object
Returns data on a successful deposit.
7 properties
CreateDepositResponse
object
1 property 1 required
ErrorRequest
object
2 properties 1 required
PermissionDeniedError
object
2 properties
DepositsResponse
object
3 properties 3 required
DepositResponse
object
1 property 1 required
CreateDepositRequestRequest
object
4 properties 3 required
ObjectNotFoundError
object
2 properties
PageNumberPagination
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-deposits-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