Get a purchase

get https://api.neonpay.com/purchases/{purchaseId}

Get a purchase by its ID

Responses

Response body

object

uuid

required

date

date-time

required

The ISO timestamp of this purchase

orderNumber

string

required

The user-facing short ID associated with this purchase

checkoutId

uuid

required

The ID of the checkout this purchase originated from

subtotalAmount

number

required

The purchase subtotal (item total), expressed as 100x the currency's base unit; see here for more on currencies

taxAmount

number

required

The purchase tax amount, expressed as 100x the currency's base unit; see here for more on currencies

taxRate

number

required

The tax rate used for this checkout as a percentage

totalAmount

number

required

The total amount of this checkout (subtotal + tax), expressed as 100x the currency's base unit; see here for more on currencies

discountAmount

number | null

The amount this checkout was discounted, if applicable, expressed as 100x the currency's base unit; see here for more on currencies

promoCode

string | null

The promo code applied to this checkout, if applicable

fee

object

fxRate

number

required

The foreign-exchange rate used to convert this purchase from the purchase currency to your settlement currency

feeAmount

number

required

The fee amount we charged, expressed as 100x your settlement currency's base unit; see here for more on currencies

netProceedsAmount

number

required

The net proceeds you're credited, expressed as 100x your settlement currency's base unit; see here for more on currencies

settlementCurrency

string

required

Your settlement currency

currency

string

required

status

string

required

externalReferenceId

uuid | null

User-supplied reference ID

externalMetadata

string

accountId

string | null

The user's in-game account ID

string | null

The user's email address

ipAddress

string | null

The user's IP address

locale

string

required

The player's IETF BCP 47 locale

playerCountry

string

required

The player's ISO 3166-1 alpha-2 country

items

array of objects

required

The items acquired in this purchase

items*

object

string

required

The unique ID of this item

sku

string

required

The SKU of this item

name

string

required

The localized name of this item

price

number

required

The price of this item, expressed as 100x the smallest unit of the purchase currency

quantity

number

required

The total purchased quantity of this item

refundableQuantity

number

required

The purchased quantity of this item, excluding refunded units

referencePrice

number

required

The price of this item in the settlement currency

referenceCurrency

string

required

The settlement currency of this item

events

array of objects

required

events*

object

uuid

required

The ID of this event

date

date-time

The ISO timestamp of this event

type

string

required

sale refund chargeback

amount

number

required

The total amount of this event (either the purchase or refund total), expressed as 100x the currency's base unit; see here for more on currencies

currency

string

required

201The purchase object

400Response for bad requests. Should note what in the request was invalid.

404Purchase is not found