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 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.1.0, at version 1.

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.1.0
API Version
1
Base URL
https://api.neonpay.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Neon Commerce Purchases 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 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.

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

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