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

Notch Payments API

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

Notch Payments API is one of 6 APIs that Notch 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 and API documentation.

This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.1, at version 0.0.0-unreconciled.

Requests are made against a single base URL, https://api.notch.financial.

3 operations 2 paths 1 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
0.0.0-unreconciled
Server
https://api.notch.financial
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Notch Payments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Illustrative Bearer API key scheme. Notch's actual authentication mechanism is not publicly documented and is unverified.

Paths & Operations 3

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

Payments 3
GET
/payments
List payments (unreconciled).
listPayments → 200
POST
/payments
Collect or record a payment (unreconciled).
createPayment body → 201
GET
/payments/{paymentId}
Retrieve a payment (unreconciled).
getPayment 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Payment (9 properties). Each schema is shown below with its type and property counts.

Payment
object
A payment collected against one or more invoices (illustrative).
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

notch-financial-payments-api-openapi.yml Raw ↑

Other APIs Notch publishes across the network.

Notch Bank Accounts API
Notch Customers API
Notch Invoices API
Notch Payment Methods API
Notch Webhooks API