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

The Payments API from N3XT — 5 operation(s) for payments.

N3XT Payments API is one of 11 APIs that N3XT 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, an API reference, and a getting-started guide.

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

7 operations 5 paths 6 schemas 4 GET1 PATCH2 POST

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 Payments 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 7

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

Payments 7
POST
/payments/instant
Instant Payment
Instant Payment body → 202400401403404422500
POST
/payments/request
Request Payment
Create Payment Request body → 202400401403404500
GET
/payments/request
List Payment Requests
List Payment Requests 4 params → 200400401403404500
PATCH
/payments/request/{id}
Update Payment Request Status
Update Payment Request Status 1 param body → 202400401403404500
GET
/payments/request/{id}
Get Payment Request by ID
Get Payment Request by Id 1 param → 200400401403404422500
GET
/payments
List Payments
List Payments 14 params → 200400401404500
GET
/payments/{id}
Get Payment by ID
Get Payment by Id 1 param → 200400401403404422500

Schemas 6

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

RequestPaymentRequest
object
4 properties 4 required
Payment
object
16 properties 5 required
InstantPaymentRequest
object
5 properties 4 required
ErrorResponse
object
1 property 1 required
ApiWrapperOrderBy
string
PaymentStatusEnum
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

n3xt-payments-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 Programmable API
N3XT System API
N3XT Transfers API
N3XT Users API
N3XT Wallets API