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

Neon Commerce Client API

The Client API from Neon Commerce — 4 operation(s) for client.

Neon Commerce Client API is one of 13 APIs that Neon Commerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 1.

Requests are made against a single base URL, https://api.neonpay.com.

4 operations 4 paths 10 schemas 1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1
Base URL
https://api.neonpay.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Neon Commerce Client API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (GlobalApiKey). By default, every request must be authenticated.

  • GlobalApiKey — Your Global API key, which spans across environments. Sandbox keys are prefixed with gksandbox; production keys are prefixed with gk. Find your keys in the Neo…

Paths & Operations 4

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

Client 4
POST
/client/token
Retrieve a client token
createClientToken body → 201400401500
POST
/client/checkout
Create a checkout using a client token
createCheckoutClient body → 201400
PATCH
/client/purchase/{purchaseId}/claim
Mark an unclaimed purchase as claimed
clientClaimPurchase 1 param → 200400404
GET
/client/purchases/unclaimed
Get all unclaimed purchases for a particular user
clientGetPurchasesUnclaimed → 200400404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are BasePurchase (29 properties), BaseClientCreateCheckoutRequest (9 properties), PurchaseItem (9 properties), PurchaseEvent (5 properties). Each schema is shown below with its type and property counts.

PurchaseItem
object
9 properties 9 required
ErrorDetail
object
3 properties 2 required
Purchase
BaseClientCreateCheckoutRequest
object
9 properties 4 required
PurchaseNotFoundError
object
1 property
PurchaseEvent
object
5 properties 4 required
BasePurchase
object
29 properties 19 required
APIError
object
4 properties 2 required
PurchaseBundleItem
object
3 properties 3 required
ClientCreateCheckoutRequest

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neon-commerce-client-api-openapi.yml Raw ↑

Other APIs Neon Commerce publishes across the network.

Neon Commerce Account API
Neon Commerce Assets API
Neon Commerce Auth API
Neon Commerce Checkout API
Neon Commerce Payouts API
Neon Commerce Prices API
Neon Commerce Pricing Sheet API
Neon Commerce Purchases API
Neon Commerce Reports API
Neon Commerce Status API
Neon Commerce Storefront API
Neon Commerce Subscriptions API