API Reference
Developer Console

Create a checkout using a client token

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

Create a checkout. Once the checkout is created, redirect the user to the redirectUrl. 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
offers
array of objects
required
length ≥ 1

Offers being purchased

offers*
string
required

The SKU identifier for the offer

integer
required
≥ 1

The quantity of the offer being purchased

string

A reference to this transaction, like an internal purchase ID

uri

The URL of the store. Used for attribution and backlinking

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 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
uri | null
required

URL to redirect to upon successful checkout

uri

URL to redirect to upon checkout cancellation

Headers
string
required

The token returned from the /client/token API

Responses

Updated 10 days ago

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

Updated 10 days ago