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

N3XT Programmable API

The Programmable API from N3XT — 5 operation(s) for programmable.

N3XT Programmable API is one of 11 APIs that N3XT publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Programmable. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and a getting-started guide.

This API exposes 6 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version v1.0.1-3514-g824039216.

Requests are made against a single base URL, https://openapi.n3xt.io.

6 operations 5 paths 4 schemas 2 GET1 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.0.1-3514-g824039216
Base URL
https://openapi.n3xt.io
Authentication
HTTP Bearer
License
ISC
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — Bearer auth - insert ONLY the token (the word Bearer will automatically be added)

Paths & Operations 6

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

Programmable 6
GET
/payments/programmable/{id}
Get Programmable Payment
Get Programmable Payment 1 param → 200400401404500
GET
/payments/programmable
List Programmable Payments
List Programmable Payments 4 params → 200400401403404422500
POST
/payments/programmable
Create Programmable Payment Request
Create Programmable Payment Request 1 param body → 202400401403404422500
PUT
/payments/programmable/{id}/fulfillment
Fulfill Programmable Payment Delivery
Fulfill Programmable Payment 1 param → 202400401404500
PUT
/payments/programmable/{id}/cancellation
Cancel Programmable Payment
Cancel Programmable Payment 1 param → 202400401404500
PATCH
/payments/programmable/request/{id}
Update Request Status
Update Payment Request Status 2 params body → 202400401403404422500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are PayerRequestPayload (6 properties), RecipientRequestPayload (6 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

ApiWrapperOrderBy
string
RecipientRequestPayload
object
Request body for creating a recipient-initiated programmable payment.
6 properties 3 required
PayerRequestPayload
object
Request body for creating a payer-initiated programmable payment.
6 properties 3 required
ErrorResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

n3xt-programmable-api-openapi.yml Raw ↑

Other APIs N3XT publishes across the network.

N3XT Approvals API
N3XT AuditTrail API
N3XT Businesses API
N3XT Contacts API
N3XT Ndd Routes API
N3XT Payments API
N3XT System API
N3XT Transfers API
N3XT Users API
N3XT Wallets API