How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neon Commerce Purchases API

The Purchases API from Neon Commerce — 6 operation(s) for purchases.

Neon Commerce Purchases 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 Purchases. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 6 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

6 operations 6 paths 26 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Neon Commerce Purchases API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Api-Key (EnvironmentApiKey). An API key is passed in the header as X-Client-Token (ClientToken). By default, every request must be authenticated.

  • EnvironmentApiKey — Your Environment API key, scoped to a particular environment. Sandbox keys are prefixed with pksandbox; production keys are prefixed with pk. Find your keys in…
  • ClientToken — A short-lived client token obtained from the /client/token endpoint, used for client-side requests to the Neon APIs.

Paths & Operations 6

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

Purchases 6
GET
/purchases/search
Search for a purchase by checkout ID or order number
findPurchase 2 params → 200400404
GET
/purchases/{purchaseId}
Get a purchase
getPurchase 1 param → 201400404
GET
/purchases/refunds
Get all available refunds for a specific environment
getPurchaseRefunds 5 params → 200400
GET
/purchases
Get all available purchases for a specific environment
getPurchases 5 params → 200400
POST
/purchases/{purchaseId}/refund
Refunds a purchase.
refundPurchase 1 param body → 200400404
POST
/purchases/webhooks
Subscribe to purchase lifecycle events
subscribeToWebhooks body → 201400

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are BasePurchase (29 properties), Refund (17 properties), SubscriptionExternal (15 properties), Invoice (12 properties). Each schema is shown below with its type and property counts.

PurchaseBundleItem
object
3 properties 3 required
CartAbandonedWebhook
object
Request body for event version 1
5 properties
PurchaseNotFoundError
object
1 property
PurchaseWebhookV1
object
Request body for event version 1
2 properties
Purchase
PurchaseEvent
object
5 properties 4 required
SubscriptionWebhook
object
Request body for event version 1
5 properties
CheckoutAbandonedWebhook
object
Request body for event version 1
5 properties
Dispute
object
9 properties 9 required
InvoiceRefundWebhook
object
Request body for event version 1
5 properties
InvoiceRefund
object
10 properties 8 required
RefundItem
object
9 properties 8 required
RefundWebhookV1
object
Request body for event version 1
2 properties
RefundWebhookV2
object
Request body for event version 2
5 properties
PaymentFailedWebhook
object
Request body for event version 1
5 properties 5 required
DisputeWebhook
object
Request body for event version 1
5 properties
Currency
string
ErrorDetail
object
2 properties 2 required
BasePurchase
object
29 properties 19 required
PurchaseItem
object
9 properties 9 required
PurchaseWebhookV2
object
Request body for event version 2
5 properties
Refund
object
17 properties 13 required
SubscriptionExternal
object
15 properties 10 required
APIError
object
4 properties 2 required
InvoiceWebhook
object
Request body for event version 1
5 properties
Invoice
object
12 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neon-commerce-purchases-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 Client API
Neon Commerce Payouts API
Neon Commerce Prices API
Neon Commerce Pricing Sheet API
Neon Commerce Reports API
Neon Commerce Status API
Neon Commerce Storefront API
Neon Commerce Subscriptions API
Where this information came from

This is an independent, third-party profile of Neon Commerce Purchases API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.