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

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

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

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

This API exposes 3 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/.

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

Paths & Operations 3

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

payments 3
GET
/v1/payments/
List bill payments
payments_list 3 params → 200
POST
/v1/payments/
Creates a bill payment
payments_create body → 201403422
DELETE
/v1/payments/{id}/
Delete a bill payment
payments_destroy 1 param → 200422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are BillPayment (9 properties), PaymentCreateDocRequest (7 properties), PaginatedBillPaymentList (3 properties), ErrorRequest (2 properties). Each schema is shown below with its type and property counts.

PaymentCreateDocRequest
object
7 properties 6 required
InvalidRequestError
object
2 properties
PaginatedBillPaymentList
object
3 properties 3 required
ErrorRequest
object
2 properties 1 required
BillPayment
object
9 properties 6 required
Payment
object
1 property 1 required
BillPayDestroy
object
1 property
BillPaymentStateEnum
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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