Retrieve a token

post

https://api.neonpay.com/auth/token

In order to authenticate a shop user with your game, you need to link the player "code" with your internal player account ID. This endpoint does that linking and returns a unique token that can be used to redirect the player back to the shop with an authenticated session.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

code

string | null

The authentication code provided by the player via deep link or manually.

accountId

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.

accountDisplayName

string | null

The display name for the player. This will be used instead of the accountId for display if provided. This can be used when the player ID is not meant to be player-facing. Some common examples are a custom gamertag (e.g. "GreatGamer123"), the player's name (e.g. "John Smith"), or an email address (e.g. "[email protected]").

pricingSheetName

string

metadata

object | null

Additional metadata that you'd like to track alongside events for this user. This data will be included in analytics events and webhooks. It should not include any sensitive or internal data like internal authentication tokens. Common use cases are analytics session IDs or device IDs.

fraudMetadata

object

Metadata used to help prevent fraud.

Headers

X-Api-Key

string

required

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The authentication token was successfully created

400Response for API errors

401Response for API errors

500Response for API errors