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

The ach import API from Narmi — 6 operation(s) for ach import.

Narmi ach import 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 import. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 6 paths, and defines 23 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/.

7 operations 6 paths 23 schemas 1 DELETE2 GET4 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 import API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 7

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

ach import 7
POST
/v1/ach_import/csv/import/
Import ACH CSV
ach_import_csv_import_create body → 200
GET
/v1/ach_import/csv/mappings/
List saved CSV mappings
ach_import_csv_mappings_list 1 param → 200
POST
/v1/ach_import/csv/mappings/
Create a saved CSV mapping
ach_import_csv_mappings_create body → 201
DELETE
/v1/ach_import/csv/mappings/{uuid}/
Delete a saved CSV mapping
ach_import_csv_mappings_destroy 1 param → 204
POST
/v1/ach_import/csv/parse/
Parse ACH CSV
ach_import_csv_parse_create body → 200
GET
/v1/ach_import/nacha/download/{file_name}/
Download NACHA file
ach_import_nacha_download_retrieve 1 param → 200
POST
/v1/ach_import/nacha/import/
Import NACHA file
ach_import_nacha_import_create body → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are CSVFieldMapping (21 properties), CSVFieldMappingRequest (18 properties), ACHImportCSVParsedRow (13 properties), Recipient (8 properties). Each schema is shown below with its type and property counts.

ACHImportSuggestedMapping
object
3 properties 3 required
PaginatedCSVFieldMappingList
object
4 properties 2 required
WireRecipientAddress
object
7 properties 1 required
Recipient
object
Updates to the achdestination and fedwiredestination fields are handled by the ACHDetailsSerializer and FedwireDestinationSerializer, respectively.
8 properties 1 required
RecipientTypeEnum
string
person - Person business - Business
ACHImportNACHAPaymentRow
object
7 properties 7 required
CSVFieldMapping
object
21 properties 1 required
CSVFieldMappingRequest
object
18 properties 1 required
ACHImportCSVParseRequest
object
3 properties 2 required
AccountTypeEnum
string
checking - Checking savings - Savings loan - Loan
ACHImportNACHAUploadRequest
object
6 properties 3 required
ACHImportNACHAUploadResponse
object
6 properties 6 required
ACHImportCSVUploadResponse
object
6 properties 6 required
ACHImportColumnMapping
object
3 properties 3 required
FedwireDestination
object
In addition to the standard FedwireDestination fields you'd expect for a create/updated request, this serializer also requires a recipient (passed in as the uu…
5 properties 3 required
AccountPurposeEnum
string
personal - Personal business - Business
ACHDetails
object
In addition to the standard ACHDetails fields you'd expect for a create/updated request, this serializer also requires a recipient (passed in as the uuid of th…
6 properties 4 required
ACHImportCSVUploadRequest
object
2 properties 1 required
ACHImportCSVParsedRow
object
13 properties 13 required
ACHImportCSVParseResponse
object
2 properties 2 required
ACHImportColumnMappingRequest
object
3 properties 3 required
SwiftWireDestination
object
8 properties 3 required
FedwireRecipientAddress
object
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-ach-import-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 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
Narmi deposits API