Skip to main content

Refund Object

transaction_idinteger<int32>

The transaction id.

Example: 987654321
gross_amountinteger<int32>

The gross amount of the purchase in the lowest denomination of currency.

Example: 2500
net_amountinteger<int32>

The net amount of the purchase in the lowest denomination of currency.

Example: 2300
platform_feeinteger<int32>

The platform fee of the purchase in the lowest denomination of currency.

Example: 100
gateway_feeinteger<int32>

The gateway fee of the purchase in the lowest denomination of currency.

Example: 50
taxinteger<int32>

The tax amount of the purchase in cents.

Example: 150
tax_typestring

The tax type.

Example: GST
transaction_typeMonetization Transaction Type Enum (string)

The state of the transaction that was processed.

Enum ValueDescription
CANCELLEDPayment cancelled by seller
CLEAREDPayment taken and earned funds released
FAILEDPayment failed to process
PAIDPayment taken but funds not released
PENDINGPending transaction no payment taken
REFUNDEDPayment refunded to buyer

Possible values: [CANCELLED, CLEARED, CREDITED, FAILED, PAID, PENDING, REFUNDED]

meta object[]

A metadata array of objects returned from the transaction.

  • 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
    token_namestring

    Name of the token.

    Example: token name
  • ]
  • purchase_dateinteger<int32>

    The time of the purchase.

    Example: 1626667557
    Refund Object
    {
    "transaction_id": 987654321,
    "gross_amount": 2500,
    "net_amount": 2300,
    "platform_fee": 100,
    "gateway_fee": 50,
    "tax": 150,
    "tax_type": "GST",
    "transaction_type": "CANCELLED",
    "meta": [
    {
    "mod_id": 1234,
    "game_id": 4567,
    "buyer_id": 8910,
    "mod_name": "Body Armour",
    "game_name": "Half-Life",
    "buyer_name": "Gordon Freeman",
    "token_name": ".22 Magazine"
    }
    ],
    "purchase_date": 1626667557
    }