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 ach payments API

The ach payments API from Narmi — 5 operation(s) for ach payments.

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

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

This API exposes 8 operations across 5 paths, and defines 13 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/.

8 operations 5 paths 13 schemas 1 DELETE4 GET3 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 ach payments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 8

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

ach payments 8
GET
/v1/ach_payments/
List ACH payments
ach_payments_list 1 param → 200
POST
/v1/ach_payments/
Send an ACH Payment
ach_payments_create body → 201400409
GET
/v1/ach_payments/{uuid}/
Retrieve an ACH payment
ach_payments_retrieve 1 param → 200
GET
/v1/ach_payments/scheduled/
List scheduled ACH payments
ach_payments_scheduled_list 1 param → 200
POST
/v1/ach_payments/scheduled/
Create a scheduled ACH payment
ach_payments_scheduled_create body → 201400
GET
/v1/ach_payments/scheduled/{uuid}/
Retrieve a scheduled ACH payment
ach_payments_scheduled_retrieve 1 param → 200
DELETE
/v1/ach_payments/scheduled/{uuid}/
Delete a scheduled ACH payment
ach_payments_scheduled_destroy 1 param → 204
POST
/v1/loan_payments/ach/
Create an ACH loan payment
loan_payments_ach_create body → 201

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ACHPayment (17 properties), UnverifiedACHTransaction (17 properties), ScheduledACHPayment (16 properties), ScheduledACHPaymentRequest (11 properties). Each schema is shown below with its type and property counts.

ACHPayment
object
17 properties 5 required
State40dEnum
string
analyzing - Analyzing pending - Pending processing - Processing processed - Processed (in transit) rejected - Rejected by staff review - Review canceled - Canc…
PaginatedScheduledACHPaymentList
object
4 properties 2 required
GeneralError
object
2 properties 1 required
UnverifiedACHTransaction
object
17 properties 6 required
StdEntClsCodeEnum
string
PPD - Batch Personal CCD - Batch Corporate ARC - Batch Accounts Receivable CTX - Batch Corporate Exchange POS - Batch Point Of Sale WEB - Batch Internet Initia…
LoanPaymentACH
object
8 properties 4 required
LoanPaymentACHRequest
object
8 properties 4 required
PaginatedACHPaymentList
object
4 properties 2 required
TransactionTypeEnum
string
debit - Pull (debit) credit - Push (credit)
ACHPaymentRequest
object
10 properties 5 required
ScheduledACHPaymentRequest
object
11 properties 6 required
ScheduledACHPayment
object
16 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-ach-payments-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 transfers API
Narmi alerts API
Narmi automatic savings enrollment API
Narmi card linked offers API
Narmi cards API
Narmi data access management API
Narmi deposits API