API Reference
Log InContact Us

Create a checkout

post
https://api.neonpay.com/checkout

Create a checkout. Once the checkout is created, redirect the user to the redirectUrl. On success, we'll send a purchase.completed event to your webhook listener. On payment failure, we'll send a payment.failed event to your webhook listener. Don't use this API if you have a Neon storefront set up. Neon storefronts handle creating checkouts on your behalf.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
items
array of objects
required
length ≥ 1

Items being purchased

items*
integer
required

Item price, in 100x the base unit of the currency; read more about prices here

string
required

External identifier

string
required

Name of item, for display in checkout

integer
required
≥ 1

Number of this item in purchase

uri | null

Image URL for this item

bundleContents
array of objects
required
Defaults to []

Items in this bundle, if applicable

bundleContents*
string | null

A subtitle for this item, e.g. "Best Value"

string | null

The highlighted portion of the item subtitle, e.g. "+40%!"

string
enum

The tax category of this item

Allowed:
boolean

Whether to show the quantity badge in checkout if the quantity equals 1; defaults to true

string

A reference to this transaction, like an internal purchase ID

externalMetadata
object | null

Metadata associated with this transaction, like analytics or server data

uri

The URL of the store. Used for attribution and backlinking

string
required
length ≥ 1

A unique identifier for the player or account in your system who should receive the purchased items. Neon includes this value in fulfillment webhooks so you can credit the correct user.

string

The display name of the user's account, if available

string
required

The user's language, in IETF BCP 47 tag

string
required

The physical location of the player as an ISO 3166-1 alpha-2 code; also used to derive currency. See International Support & Currencies for a full list of supported countries.

string
required

The ISO 4217 currency code that you displayed to the user prior to initiating this checkout, if applicable. See Initiating a Checkout for more details on this field.

string | null

The default payment method for this checkout, if applicable. This is used to pre-select the payment method in the checkout flow.

boolean | null

Whether to hide the promo code input in checkout; defaults to false

contact
object
fraudMetadata
object

Metadata used to help prevent fraud.

string | null
uri | null
required

URL to redirect to upon successful checkout

uri

URL to redirect to upon checkout cancellation

Responses

Updated about 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago