Payouts

Review your Payout history and get detailed reporting.

Reports

We provide Payout Reports to see detailed information about what goes into your Payout.

Retrieve the Payout Report

You can download your Payout Reports using the Console or via our Payouts and Reports APIs.

All Payouts

The Payouts section allows you to review payouts made by Neon to your account.

In the All Payouts view, you can see payouts at the environment level (i.e., per selected game title). This section displays a table of payouts, with the ability to inspect each payout in more detail - including the individual transactions that make up that payout.

You can also export payout data using two report types: Payout Summary and Detailed Report.

  • The Payout Summary report provides a high-level overview of payouts, aggregated by currency and transaction type.
  • The Detailed Report provides a transaction-level breakdown of all entries included in a payout.

Neon Console: Summary

You can generate a payout summary report across all selected environments and titles.

API

Alternatively, you can generate query for reports via our API.

  1. List your Payouts using the /payouts endpoint. That endpoint will return a list of Payout objects.
  2. Find the Payout you want and make a note of the reportId.
  3. Use the reportId to fetch Report details from the /reports/{reportId} endpoint. That endpoint will return a url field which you can use to download the report as a CSV. Note that the CSV URL expires after one hour so you should copy it into your system. You can also make another request to the /reports/{reportId} endpoint to receive a new url with a fresh expiration date.

Understand the Payout Report

Your Payout Report is formatted as a CSV and contains the following columns. You can see an example Report here.

📘

CSV and API monetary formats differ

The Payout Report formats monetary amounts in major currency units as a decimal number. For example, $12.34 will be displayed in reports as 12.34. In the API, it would be displayed as 1234.

Column

Type

Description

date

ISO 8601 date

The date of the transaction

sourceType

string

Either purchase, refund, chargeback, invoice (subscriptions only), invoice_refund (subscriptions only), payout, payout_carryover, or adjustment.

sourceId

string (optional)

The unique identifier for the source of this transaction. For purchase transactions it is the purchase ID, for refund transactions it is the refund ID, and for payout/payout_carryover this is the payout ID

description

string (optional)

The transaction description

subtotal

number (optional)

The subtotal of the source purchase or refund in the source currency

tax

number (optional)

The tax amount for the purchase or refund in the source currency

total

number (optional)

The total amount for the purchase or refund (i.e., tax + total) in the source currency

sourceCurrency

string (optional)

The currency of the source. For example, if the player purchased an item in Canada the currency would be CAD

payoutCurrency

string

The currency that you are paid out with. For example, if you are paid out in USD then this field will be USD

fxRate

number

The fx rate used for converting from the sourceCurrency to payoutCurrency

fee

number

The fee applied to this transaction in the payout currency

type

string

credit or debit

netAmount

number

Your net proceeds for this transaction in the payout currency. A negative number for debits and positive number for credits

amount

number

The total amount for this transaction in the payout currency. This number is always positive

propertyId

string (optional)

The ID of the property (game) that this transaction applied to

propertyDisplayName

string (optional)

The display name of the property (game) that this transaction applied to

originalPurchaseId

string (optional)

For refunds, this will include the original purchase ID of the transaction

metadata

string (optional)

Additional information about a purchase

netFee

number

Fee with sign (negative for debits, positive for credits)

itemsSubtotal

number
(optional)

Sum of item prices × quantities (before discounts/tax)

totalExcludingTax

number
(optional)

Subtotal amount from source purchase/invoice

country

string
(optional)

Player's country

items

string
(optional)

Human-readable list of purchased items (e.g. 1x Shield (sku-a), 2x Sword (sku-b))

environmentDisplayName

string
(optional)

Display name of the environment

environmentId

string
(optional)

ID of the environment

Payout Frequency

Neon supports three payout frequencies:

  • Weekly: we pay out at the start of every week
  • Bimonthly: we pay out on the 1st and 15th of every month
  • Monthly (default): we pay out on the 1st of every month

The amount of each payout is calculated by summing over all unpaid transactions (purchases, refunds, etc.) up to the end of the payout period, which is set to midnight UTC on the day of the payout (exclusive).

For example, suppose you have the following transactions:

IDDate (UTC)TypeNet Proceeds Amount
AJan. 1 @ 12:30pmpurchase$5.00
BJan. 15 @ 12:30pmrefund($5.00)
CJan. 31 @ 11:59pmpurchase$10.00
DFeb. 1 @ 12:00ampurchase$5.00

On a monthly payout schedule, you'd receive the following payouts:

Payout DateAmountIncluded Transactions
Jan. 1$0.00(n/a)
Feb. 1$10.00A, B, C
Mar. 1$5.00D

Note the following:

  • Refunds are dated to their processing date, not to the purchase date. For example, assuming a monthly payout frequency, if a purchase made on Jan. 1 is refunded on Feb. 1, the refund will be reflected on the March payout (which covers February), not the February payout (which covers January).
  • While the end of the payout period is always set to midnight UTC on the payout day, the start of the payout period is set to your account creation date. This is by design, to avoid any "orphaned" transactions that were added outside of their payout period. Thus, you may see transactions on a payout from before the implied start date of that payout.