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

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

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

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

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

Paths & Operations 6

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

wire recipients 6
GET
/v1/wire_recipients/
List wire recipients
wire_recipients_list 1 param → 200403404
POST
/v1/wire_recipients/
Create wire recipients
wire_recipients_create body → 201
GET
/v1/wire_recipients/{uuid}/
Retrieve wire recipients
wire_recipients_retrieve 1 param → 200
PUT
/v1/wire_recipients/{uuid}/
Update wire recipients
wire_recipients_update 1 param body → 200
PATCH
/v1/wire_recipients/{uuid}/
Modify wire recipients
wire_recipients_partial_update 1 param body → 200
DELETE
/v1/wire_recipients/{uuid}/
Delete wire recipients
wire_recipients_destroy 1 param → 204

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are FedwireRecipientAddress (7 properties), WireRecipient (7 properties), FedwireRecipientAddressRequest (6 properties), WireRecipientRequest (5 properties). Each schema is shown below with its type and property counts.

FedwireRecipientAddressRequest
object
6 properties 1 required
NotFoundError
object
2 properties 1 required
WireRecipientRequest
object
This serializer supports backwards compatibility for the WireRecipientViewSet, which is deprecated and should be avoided in favor of RecipientViewSet. WireReci…
5 properties 4 required
WireRecipient
object
This serializer supports backwards compatibility for the WireRecipientViewSet, which is deprecated and should be avoided in favor of RecipientViewSet. WireReci…
7 properties 4 required
PermissionDeniedError
object
2 properties
PaginatedWireRecipientList
object
4 properties 2 required
FedwireRecipientAddress
object
7 properties 1 required
PatchedWireRecipientRequest
object
This serializer supports backwards compatibility for the WireRecipientViewSet, which is deprecated and should be avoided in favor of RecipientViewSet. WireReci…
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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