Skip to main content

Transaction Object Show

idinteger<int32>

Unique transaction id.

Example: 1234
gateway_uuidstring

The universally unique ID (UUID) that represents a unique tranasction with the payment gateway.

Example: 123e4567-e89b-12d3-a456-426614174000
gateway_namestring

The gateway that processed the transaction.

Example: tilia
account_idinteger<int32>

The unique monetization account id that actioned the transaction.

Example: 12345
gross_amountinteger<int32>

The gross amount of the transaction.

Example: 199
net_amountinteger<int32>

The net amount of the transaction.

Example: 199
platform_feeinteger<int32>

The platform fee of the transaction.

Example: 20
gateway_feeinteger<int32>

The gateway fee of the transaction.

Example: 30
taxinteger<int32>

The tax amount of the transaction.

Example: 0
tax_typestring

The tax type on the processed transaction.

Example: sales
currencystring

The currency type on the processed transaction.

Example: usd
tokensinteger<int32>

The amount of virtual currency associated with the transaction. Will be omitted when no tokens are involved.

Example: 0
transaction_typestring

The transaction status type on the processed transaction. I.e. is it paid, pending, refunded or cleared.

Example: paid
monetization_typestring

The monetizaton type on the processed transaction. I.e. is it fiat, tokens or external.

Example: paid
purchase_datestring

The beginging purchase date the transaction started on in a human reabled date time stamp.

Example: 2024-10-07 02:29:11
created_atstring

The timestamp of date the transaction status was recorded in micro time precsion.

Example: 1728268151123456
payment_method object[]

Array containing payment method objects.

  • Array [
  • namestring

    The pretty name of the payment method that was used.

    Example: Visa ending in 1111
    idstring

    The UUID of the payment method id that was used.

    Example: 123e4567-e89b-12d3-a456-426614174000
    amountinteger

    The amount the payment method was charged.

    Example: 199
    display_amountstring

    A pretty string of the amount the payment method was charged.

    Example: USD 1.99
  • ]
  • items object[]

    Array containing Transaction items objects.

  • Array [
  • idinteger

    Unique identifier for the transaction.

    Example: 1234
    gateway_uuidstring<uuid>

    UUID of the payment gateway.

    gateway_namestring

    Name of the payment gateway.

    Example: tilia
    sale_pricenumber<float>

    Sale price of the item.

    gateway_feenumber<float>

    Fee charged by the gateway.

    platform_feenumber<float>

    Fee charged by the platform.

    currencystring

    Currency code for the transaction.

    Example: usd
    tokensinteger

    Number of tokens involved in the transaction.

    token_team_idinteger

    ID of the token team.

    sale_typestring

    Type of sale, e.g., bought or sold.

    Example: bought
    monetization_typestring

    Type of monetization, e.g., fiat.

    Example: fiat
    transaction_typestring

    Type of transaction, e.g., paid or cleared.

    Example: paid
    purchase_datestring<date-time>

    Date and time of the purchase.

    created_atinteger<int64>

    Creation timestamp with microseconds.

    Example: 1728268151123456
    line_items object[]

    Array of line item objects.

  • Array [
  • mod_idinteger

    Mod ID.

    Example: 1234
    game_idinteger

    Game ID.

    Example: 4567
    buyer_idinteger

    Buyer ID.

    Example: 8910
    mod_namestring

    Name of the mod.

    Example: my mod
    game_namestring

    Name of the game.

    Example: my game
    buyer_namestring

    Name of the buyer.

    Example: buyers name
  • ]
  • breakdown object[]

    Array containing breakdown of revenues.

  • Array [
  • platform object
    revenuenumber<float>

    Platform revenue.

    Example: 99
    store object[]

    Array of store revenue objects.

  • Array [
  • revenuenumber<float>

    Store revenue.

    Example: 99
    users object[]

    Array of user revenue details.

  • Array [
  • account_namestring

    Account name.

    Example: name
    account_idinteger

    Account ID.

    Example: 123
    revenuenumber<float>

    User revenue.

    Example: 99
  • ]
  • ]
  • ]
  • revenuenumber<float>

    Total revenue for the transaction.

    Example: 99
  • ]
  • line_items object[]

    Array containing line item objects.

  • Array [
  • game_idinteger<int32>

    The game id of the transaction.

    Example: 0
    buyer_idinteger<int32>

    The buyer id of the transaction.

    Example: 0
    game_namestring

    The name of the game the purchase occured on.

    Example: my game
    buyer_namestring

    The username of the buyer.

    Example: smith
    token_namestring

    The pretty name of the virtual currency used in the transaction.

    Example: mio
    token_pack_idinteger<int32>

    The id of the virtual currency pack used in the transaction.

    Example: 0
    token_pack_namestring

    The pretty name of the virtual currency pack used in the transaction.

    Example: 200 Pack
  • ]
  • Transaction Object Show
    {
    "id": 1234,
    "gateway_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "gateway_name": "tilia",
    "account_id": "12345",
    "gross_amount": 199,
    "net_amount": 199,
    "platform_fee": 20,
    "gateway_fee": 30,
    "tax": 0,
    "tax_type": "sales",
    "currency": "usd",
    "tokens": 0,
    "transaction_type": "paid",
    "monetization_type": "paid",
    "purchase_date": "2024-10-07 02:29:11",
    "created_at": "1728268151123456",
    "payment_method": [
    {
    "name": "Visa ending in 1111",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "amount": 199,
    "display_amount": "USD 1.99"
    }
    ],
    "items": [
    {
    "id": 1234,
    "gateway_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "gateway_name": "tilia",
    "sale_price": 0,
    "gateway_fee": 0,
    "platform_fee": 0,
    "currency": "usd",
    "tokens": 0,
    "token_team_id": 0,
    "sale_type": "bought",
    "monetization_type": "fiat",
    "transaction_type": "paid",
    "purchase_date": "2024-07-29T15:51:28.071Z",
    "created_at": 1728268151123456,
    "line_items": [
    {
    "mod_id": 1234,
    "game_id": 4567,
    "buyer_id": 8910,
    "mod_name": "my mod",
    "game_name": "my game",
    "buyer_name": "buyers name"
    }
    ],
    "breakdown": [
    {
    "platform": {
    "revenue": 99
    },
    "store": [
    {
    "revenue": 99,
    "users": [
    {
    "account_name": "name",
    "account_id": 123,
    "revenue": 99
    }
    ]
    }
    ]
    }
    ],
    "revenue": 99
    }
    ],
    "line_items": [
    {
    "game_id": 0,
    "buyer_id": 0,
    "game_name": "my game",
    "buyer_name": "smith",
    "token_name": "mio",
    "token_pack_id": 0,
    "token_pack_name": "200 Pack"
    }
    ]
    }