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

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

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

Tagged areas include payees. 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 12 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 12 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 payees 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.

payees 5
GET
/v1/payees/
List bill payment payees
payees_list 2 params → 200500
POST
/v1/payees/
Create a bill payment payee
payees_create body → 201422500
GET
/v1/payees/{id}/
Retrieve a bill payment payee
payees_retrieve 1 param → 200422500
PUT
/v1/payees/{id}/
Update a bill payment payee
payees_update 1 param body → 201422500
DELETE
/v1/payees/{id}/
Delete a bill payment payee
payees_destroy 1 param → 200422500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are BillPayee (11 properties), PayeeCreateDocRequest (10 properties), AddressRequest (9 properties), Address (7 properties). Each schema is shown below with its type and property counts.

Address
object
7 properties 4 required
Type905Enum
string
AddressRequest
object
9 properties 4 required
PayeeCreateDocRequest
object
10 properties 2 required
InvalidRequestError
object
2 properties
BillDeliveryOptionRequest
object
1 property 1 required
BillDeliveryOption
object
4 properties 1 required
PaginatedBillPayeeList
object
3 properties 3 required
Payee
object
1 property 1 required
ErrorRequest
object
2 properties 1 required
BillPayDestroy
object
1 property
BillPayee
object
11 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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