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

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

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

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

This API exposes 5 operations across 2 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/.

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

Paths & Operations 5

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

recipients 5
GET
/v1/recipients/
List recipients
recipients_list 2 params → 200403
POST
/v1/recipients/
Create a recipient
recipients_create body → 201400403
GET
/v1/recipients/{uuid}/
Retrieve a recipient
recipients_retrieve 1 param → 200403404
PUT
/v1/recipients/{uuid}/
Update a recipient
recipients_update 1 param body → 200400403404
DELETE
/v1/recipients/{uuid}/
Delete a recipient
recipients_destroy 1 param → 204

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Recipient (8 properties), SwiftWireDestination (8 properties), FedwireRecipientAddress (7 properties), WireRecipientAddress (7 properties). Each schema is shown below with its type and property counts.

AccountTypeEnum
string
checking - Checking savings - Savings loan - Loan
NotFoundError
object
2 properties 1 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
PaginatedRecipientList
object
4 properties 2 required
AccountPurposeEnum
string
personal - Personal business - Business
RecipientTypeEnum
string
person - Person 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
PermissionDeniedError
object
2 properties
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
SwiftWireDestination
object
8 properties 3 required
FedwireRecipientAddress
object
7 properties 1 required
RecipientRequest
object
Updates to the achdestination and fedwiredestination fields are handled by the ACHDetailsSerializer and FedwireDestinationSerializer, respectively.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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