diff --git a/index.html b/index.html index 4e1519e..04d62e4 100644 --- a/index.html +++ b/index.html @@ -910,6 +910,9 @@
  • Get Team Members
    • +
  • + Get Transactions +
  • Get User Events
    • @@ -937,6 +940,9 @@
  • Key-Value Pair Object
    • +
  • + Line Items Object +
  • Logo Object
    • @@ -991,9 +997,15 @@
  • Multipart Upload Part Object
    • +
  • + Pagination Object +
  • Pay Object
    • +
  • + Payment Method Object +
  • Preview Object
    • @@ -1021,6 +1033,9 @@
  • Theme Object
    • +
  • + Transaction Object +
  • User Access Object
    • @@ -21084,7 +21099,7 @@

    Responses

    Transaction Commit

    @@ -21251,7 +21266,7 @@

    Responses

    Transaction Clawback

    @@ -21439,7 +21454,7 @@

    Responses

    Disconnect User

    @@ -24572,6 +24587,78 @@

    Get Team Members

    +

    Get Transactions

    +

    +
    {
+  "data": [
+    {
+      "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": "1728268151",
+      "payment_method": [
+        {
+          "name": "Visa ending in 1111",
+          "id": "123e4567-e89b-12d3-a456-426614174000",
+          "amount": 199,
+          "display_amount": "USD 1.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"
+        }
+      ]
+    }
+  ],
+  "download": {
+    "per_page": "15",
+    "current_page": "/v1/s2s/monetization-teams/{monetization-team-id}/transactions?cursor=eyJjcmVhdGVkX2F0IjoiMjAyNC0xMC0wMiAwMDo1NTozMiIsIl9wb2ludHNUb05leHRJdaAJdsa10",
+    "next_page_url": "/v1/s2s/monetization-teams/{monetization-team-id}/transactions?cursor=eyJjcmVhdGVkX2F0IjoiMjAyNC0xMC0wMiAwMDo1NTozMiIsIl9wb2ludHNUb05leHRJdaAJdsa10",
+    "prev_page_url": "/v1/s2s/monetization-teams/{monetization-team-id}/transactions?cursor=eyJjcmVhdGVkX2F0IjoiMjAyNC0xMC0wMiAwMDo1NTozMiIsIl9wb2ludHNUb05leHRJdaAJdsa10"
+  }
+} 
+

    Properties

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    downloadPagination ObjectContains pagination data.
    data +Transaction Object[]Array containing transaction objects.

    Get User Events

    {
@@ -24593,7 +24680,7 @@ 
    Get User Events
    
       "result_limit": 100,
   "result_total": 70
 } 
-

    Properties

    +

    Properties

    @@ -24649,7 +24736,7 @@

    Get User Ratings

    "result_limit": 100, "result_total": 70 } -

    Properties

    +

    Properties

    @@ -24742,7 +24829,7 @@

    Guide Object

    } ] } -

    Properties

    +

    Properties

    @@ -24850,7 +24937,7 @@

    Guide Stats Object

    "visits_total": 0, "comments_total": 0 } -

    Properties

    +

    Properties

    @@ -24889,7 +24976,7 @@

    Guide Tag Object

    "date_added": 1499841487, "count": 22 } -

    Properties

    +

    Properties

    @@ -24922,7 +25009,7 @@

    Header Image Object

    "filename": "modio-logo-bluedark.png", "original": "https://assets.modcdn.io/images/branding/modio-logo-bluedark.png" } -

    Properties

    +

    Properties

    @@ -24953,7 +25040,7 @@

    Icon Object

    "thumb_128x128": "https://assets.modcdn.io/images/placeholder/icon.png", "thumb_256x256": "https://assets.modcdn.io/images/placeholder/icon.png" } -

    Properties

    +

    Properties

    @@ -24998,7 +25085,7 @@

    Image Object

    "thumb_320x180": "https://assets.modcdn.io/images/placeholder/card.png", "thumb_1280x720": "https://assets.modcdn.io/images/placeholder/card.png" } -

    Properties

    +

    Properties

    @@ -25036,7 +25123,7 @@

    Key-Value Pair Object

    "key": "retry-after", "value": "98" } -

    Properties

    +

    Properties

    @@ -25058,6 +25145,64 @@

    Key-Value Pair Object

    +

    Line Items Object

    +

    +
    {
+  "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"
+} 
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    game_idintegerThe game id of the transaction.
    buyer_idintegerThe buyer id of the transaction.
    game_namestringThe name of the game the purchase occured on.
    buyer_namestringThe username of the buyer.
    token_namestringThe pretty name of the virtual currency used in the transaction.
    token_pack_idintegerThe id of the virtual currency pack used in the transaction.
    token_pack_namestringThe pretty name of the virtual currency pack used in the transaction.

    Logo Object

    {
@@ -25067,7 +25212,7 @@ 
    Logo Object
    
       "thumb_640x360": "https://assets.modcdn.io/images/placeholder/card.png",
   "thumb_1280x720": "https://assets.modcdn.io/images/placeholder/card.png"
 } 
-

    Properties

    +

    Properties

    @@ -25110,7 +25255,7 @@

    Message Object

    "code": 200, "message": "Your request was successful." } -

    Properties

    +

    Properties

    @@ -25139,7 +25284,7 @@

    Metadata KVP Object

    "metakey": "pistol-dmg", "metavalue": "800" } -

    Properties

    +

    Properties

    @@ -25179,7 +25324,7 @@

    Mod Dependants Object

    "thumb_1280x720": "https://assets.modcdn.io/images/placeholder/card.png" } } -

    Properties

    +

    Properties

    @@ -25235,7 +25380,7 @@

    Mod Dependants Object

    Mod Dependencies Object

    {} 
-

    Properties

    +

    Properties

    @@ -25261,7 +25406,7 @@

    Mod Event Object

    "date_added": 1499846132, "event_type": "MODFILE_CHANGED" } -

    Properties

    +

    Properties

    @@ -25316,7 +25461,7 @@

    Mod Media Object

    } ] } -

    Properties

    +

    Properties

    @@ -25473,7 +25618,7 @@

    Mod Object

    "date_expires": 1492564103 } } -

    Properties

    +

    Properties

    @@ -25646,7 +25791,7 @@

    Mod Platforms Object

    "platform": "windows", "modfile_live": 1 } -

    Properties

    +

    Properties

    @@ -25685,7 +25830,7 @@

    Mod Stats Object

    "ratings_display_text": "Very Positive", "date_expires": 1492564103 } -

    Properties

    +

    Properties

    @@ -25769,7 +25914,7 @@

    Mod Tag Object

    "name_localized": "Unity", "date_added": 1499841487 } -

    Properties

    +

    Properties

    @@ -25838,7 +25983,7 @@

    Mod User Preview Object

    "subscribed": false, "date_added": 1499841487 } -

    Properties

    +

    Properties

    @@ -25906,7 +26051,7 @@

    Modfile Object

    } ] } -

    Properties

    +

    Properties

    @@ -26010,7 +26155,7 @@

    Modfile Platform Object

    "platform": "windows", "status": 1 } -

    Properties

    +

    Properties

    @@ -26051,7 +26196,7 @@

    Modfile Platform Supported Object

    "string" ] } -

    Properties

    +

    Properties

    @@ -26098,7 +26243,7 @@

    Monetization Team Accounts Object

    "monetization_options": 0, "split": 0 } -

    Properties

    +

    Properties

    @@ -26147,7 +26292,7 @@

    Multipart Upload Object

    "upload_id": "123e4567-e89b-12d3-a456-426614174000", "status": 0 } -

    Properties

    +

    Properties

    @@ -26177,7 +26322,7 @@

    Multipart Upload Part Object

    "part_size": 52428800, "date_added": 1499846132 } -

    Properties

    +

    Properties

    @@ -26209,6 +26354,46 @@

    Multipart Upload Part Object

    +

    Pagination Object

    +

    +
    {
+  "per_page": "15",
+  "current_page": "/v1/s2s/monetization-teams/{monetization-team-id}/transactions?cursor=eyJjcmVhdGVkX2F0IjoiMjAyNC0xMC0wMiAwMDo1NTozMiIsIl9wb2ludHNUb05leHRJdaAJdsa10",
+  "next_page_url": "/v1/s2s/monetization-teams/{monetization-team-id}/transactions?cursor=eyJjcmVhdGVkX2F0IjoiMjAyNC0xMC0wMiAwMDo1NTozMiIsIl9wb2ludHNUb05leHRJdaAJdsa10",
+  "prev_page_url": "/v1/s2s/monetization-teams/{monetization-team-id}/transactions?cursor=eyJjcmVhdGVkX2F0IjoiMjAyNC0xMC0wMiAwMDo1NTozMiIsIl9wb2ludHNUb05leHRJdaAJdsa10"
+} 
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    per_pageintegerThe number of items shown per page.
    current_pagestringThe url for the current page.
    next_page_urlintegerThe url for the next page if it exists.
    prev_page_urlintegerThe url for the previous page if it exists.

    Pay Object

    {
@@ -26352,7 +26537,7 @@ 
    Pay Object
    
         }
   }
 } 
-

    Properties

    +

    Properties

    @@ -26429,6 +26614,46 @@

    Pay Object

    +

    Payment Method Object

    +

    +
    {
+  "name": "Visa ending in 1111",
+  "id": "123e4567-e89b-12d3-a456-426614174000",
+  "amount": 199,
+  "display_amount": "USD 1.99"
+} 
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    namestringThe pretty name of the payment method that was used.
    idstringThe UUID of the payment method id that was used.
    amountintegerThe amount the payment method was charged.
    display_amountstringA pretty string of the amount the payment method was charged.

    Preview Object

    {
@@ -26436,7 +26661,7 @@ 
    Preview Object
    
       "date_added": 1499841487,
   "date_updated": 1499841487
 } 
-

    Properties

    +

    Properties

    @@ -26468,7 +26693,7 @@

    Proxy Transformer Object

    {
   "success": true
 } 
-

    Properties

    +

    Properties

    @@ -26493,7 +26718,7 @@

    Rating Object

    "rating": -1, "date_added": 1492564103 } -

    Properties

    +

    Properties

    @@ -26542,7 +26767,7 @@

    Refund Object

    }, "purchase_date": 1626667557 } -

    Properties

    +

    Properties

    @@ -26619,7 +26844,7 @@

    S2S Pay Object

    }, "purchase_date": 1626667557 } -

    Properties

    +

    Properties

    @@ -26696,7 +26921,7 @@

    Status Audit Log Object

    "date_added": 1492564103, "reason": "" } -

    Properties

    +

    Properties

    @@ -26759,7 +26984,7 @@

    Team Member Object

    "position": "Turret Builder", "invite_pending": 1 } -

    Properties

    +

    Properties

    @@ -26837,7 +27062,7 @@

    Terms Object

    } } } -

    Properties

    +

    Properties

    @@ -26979,7 +27204,7 @@

    Theme Object

    "warning": "#d6af2e", "danger": "#ff000e" } -

    Properties

    +

    Properties

    @@ -27021,6 +27246,149 @@

    Theme Object

    +

    Transaction Object

    +

    +
    {
+  "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": "1728268151",
+  "payment_method": [
+    {
+      "name": "Visa ending in 1111",
+      "id": "123e4567-e89b-12d3-a456-426614174000",
+      "amount": 199,
+      "display_amount": "USD 1.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"
+    }
+  ]
+} 
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    idintegerUnique transaction id.
    gateway_uuidstringThe universally unique ID (UUID) that represents the tranasction id.
    gateway_namestringThe gateway that processed the transaction.
    account_idintegerThe unique monetization account id that actioned the transaction.
    gross_amountintegerThe gross amount of the transaction.
    net_amountintegerThe net amount of the transaction.
    platform_feeintegerThe platform fee of the transaction.
    gateway_feeintegerThe gateway fee of the transaction.
    taxintegerThe tax amount of the transaction.
    tax_typestringThe tax type on the processed transaction.
    currencystringThe currency type on the processed transaction.
    tokensintegerThe amount of virtual currency associated with the transaction. Will be omitted when no tokens are involved.
    transaction_typestringThe transaction status type on the processed transaction. I.e. is it paid, pending, refunded or cleared.
    monetization_typestringThe monetizaton type on the processed transaction. I.e. is it fiat, tokens or external.
    purchase_datestringThe purchase date in a human reabled date time stamp.
    created_atstringUnix timestamp of date the transaction was created at. Same as purchased at date.
    payment_method +Payment Method Object[]Array containing payment method objects.
    line_items +Line Items Object[]Array containing line item objects.

    User Access Object

    {
@@ -27030,7 +27398,7 @@ 
    User Access Object
    
       "resource_name_id": "my-awesome-mod",
   "resource_url": ""
 } 
-

    Properties

    +

    Properties

    @@ -27074,7 +27442,7 @@

    User Delegation Token Object

    "entity": "purchase_server", "token": "eyJ0eXAiOiXKV1QibCJhbLciOiJeiUzI1....." } -

    Properties

    +

    Properties

    @@ -27106,7 +27474,7 @@

    User Event Object

    "date_added": 1499846132, "event_type": "USER_SUBSCRIBE" } -

    Properties

    +

    Properties

    @@ -27167,7 +27535,7 @@

    User Object

    "language": "", "profile_url": "https://mod.io/u/xant" } -

    Properties

    +

    Properties

    @@ -27235,7 +27603,7 @@

    Wallet Balance Object

    {
   "balance": 0
 } 
-

    Properties

    +

    Properties

    @@ -27264,7 +27632,7 @@

    Wallet Object

    "deficit": 0, "monetization_status": 1 } -

    Properties

    +

    Properties

    @@ -27323,7 +27691,7 @@

    Web Message Object

    "success": true, "message": "You have successfully logged out of mod.io." } -

    Properties

    +

    Properties