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 instant transfers API

The instant transfers API from Narmi — 4 operation(s) for instant transfers.

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

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

This API exposes 4 operations across 4 paths, and defines 7 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 4 paths 7 schemas 4 GET

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 instant transfers 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 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

instant transfers 4
GET
/v1/fednow_transaction/{uuid}/
Retrieve a FedNow transfer
fednow_transaction_retrieve 1 param → 200
GET
/v1/transfers/instant/{payment_identification}/
Retrieve instant transfer details by payment identification
transfers_instant_retrieve 1 param → 200
GET
/v1/transfers/instant/eligibility/{routing_number}/
Check eligibility for instant transfers
transfers_instant_eligibility_retrieve 1 param → 200
GET
/v1/transfers/instant/fees/
Retrieve fee information for instant transfers
transfers_instant_fees_retrieve → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are FednowPayment (17 properties), FedNowTransaction (11 properties), FedNowEligibility (4 properties), TransfersFee (4 properties). Each schema is shown below with its type and property counts.

FedNowTransactionStateEnum
string
pending - Pending fraud evaluation accepted - Fraud evaluation passed declined - Fraud evaluation failed failed - Failed before FedNow processing was initiated…
TransfersFee
object
4 properties 1 required
FedNowEligibility
object
4 properties 2 required
KindEnum
string
free - free fixed - fixed percent - percent
FedNowTransaction
object
11 properties 6 required
EnrollmentLevelEnum
string
receive - Receive only send - Send only sendreceive - Send and Receive rfp - Request for payment and receive only rfpsend - Request for payment with send and r…
FednowPayment
object
17 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-instant-transfers-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