Documentazione di Steamworks
ISteamMicroTxn Interface
Questa è l'interfaccia utilizzata per supportare le microtransazioni (acquisti in gioco).

Consulta Guida all'implementazione delle microtransazioni per maggiori informazioni.
NOTA: in fase di test, utilizza ISteamMicroTxnSandbox!

Per ulteriori informazioni sull'API web di Steamworks, consulta la seguente documentazione: Panoramica sull'API web.

AdjustAgreement

POST https://partner.steam-api.com/ISteamMicroTxn/AdjustAgreement/v1/
NomeTipoNecessarioDescrizione
keystringChiave di autenticazione dell'editore per l'API web di Steamworks.
steamiduint64ID di Steam del cliente che sta modificando il contratto.
agreementiduint64ID unico a 64 bit del contratto di fatturazione di Steam.
appid uint32AppID del gioco per cui è valido il contratto.
nextprocessdatestringData in cui dovrebbe essere inizializzato il pagamento ricorrente successivo. Il formato è AAAAMMGG.
La data può essere modificata solo per allungare la durata della sottoscrizione. Se la data è successiva alla fine della sottoscrizione, la data finale sarà posticipata.
oldnextprocessdatestringParametro opzionale che rappresenta l'ultima data nota relativa al prossimo pagamento ricorrente con la quale effettuare il confronto. Il formato è AAAAMMGG.
Se viene fornito questo parametro, l'API verificherà che la prossima data ricorrente non sia cambiata prima di cercare di adeguare le modifiche alla prossima elaborazione nel contratto.

Aggiungi del tempo al piano dei pagamenti di un contratto con tipo di fatturazione "steam". È possibile recuperare l'agreementid usando GetUserAgreementInfo.

NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API DEVE arrivare da un server protetto e non può mai essere effettuata dai client!

Risposta:
  • response
    • result - Il risultato dell'operazione. (OK oppure Failure)
    • params
      • agreementid - l'ID a 64 bit unico del contratto di fatturazione di Steam.
      • nextprocessdate - La prossima data in cui sarà inizializzato il pagamento ricorrente successivo. Il formato è AAAAMMGG.
    • error - Opzionale, restituito solo se il risultato è Failure.

CancelAgreement

POST https://partner.steam-api.com/ISteamMicroTxn/CancelAgreement/v1/
NomeTipoNecessarioDescrizione
keystringChiave di autenticazione dell'editore per l'API web di Steamworks.
steamiduint64ID di Steam del cliente che sta annullando il contratto.
agreementiduint64ID unico a 64 bit del contratto di fatturazione di Steam.
appid uint32AppID del gioco per cui è valido il contratto.

Annulla un contratto di fatturazione ricorrente (sottoscrizione). È possibile recuperare l'agreementid usando GetUserAgreementInfo.

NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API DEVE arrivare da un server protetto e non può mai essere effettuata dai client!

Risposta:
  • response
    • result - Il risultato dell'operazione. (OK oppure Failure)
    • params
      • agreementid - l'ID a 64 bit unico del contratto di fatturazione di Steam.
    • error - Opzionale, restituito solo se il risultato è Failure.

FinalizeTxn

POST https://partner.steam-api.com/ISteamMicroTxn/FinalizeTxn/v2/
NomeTipoNecessarioDescrizione
keystringChiave di autenticazione dell'editore per l'API web di Steamworks.
orderiduint64L'ID univoco a 64 bit dell'ordine
appid uint32L'appID del gioco.

Conclude un acquisto inizializzato dall'API InitTxn.

Questo comando si appropria dei fondi per una transazione e dovrebbe essere chiamato solo dopo che l'utente ha autorizzato la transazione e hai ricevuto conferma che l'autorizzazione ha avuto esito positivo. La notifica dell'autorizzazione può arrivare tramite il client di Steam (se il tuo gioco è registrato per ricevere notifiche) o tramite il ridirezionamento dell'utente al tuo sito (se l'URL di ritorno è stato specificato quando l'utente è stato ridiretto da un sito web a Steam). Il valore usersession specificato in InitTxn determina il meccanismo di notifica.

Una risposta positiva a questo comando significa che il pagamento è stato completato e si possono assegnare oggetti all'utente. In caso di timeout o altri errori nella comunicazione, utilizza le API QueryTxn o GetReport per ottenere lo stato della transazione.

Questo metodo ha delle versioni precedenti che non sono più ufficialmente supportate. Potrai continuare a usarle, ma ti consigliamo vivamente di utilizzare la versione più recente.
Cronologia delle modifiche:
  • Version 2 - Ora utilizza numeri a 64 bit in formato string.

NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API DEVE arrivare da un server protetto e non può mai essere effettuata dai client!

Risposta:
  • response
    • result - Il risultato dell'operazione. (OK oppure Failure)
    • params
      • orderid - L'ID unico a 64 bit dell'ordine.
      • transid - ID a 64 bit unico della transazione di Steam.
    • error - Opzionale, restituito solo se il risultato è Failure.

Esempio di risposta:
<response> <result>OK</result> <params> <orderid>938473</orderid> <transid>374839</transid> </params> </response>

GetReport

GET https://partner.steam-api.com/ISteamMicroTxn/GetReport/v5/
NomeTipoNecessarioDescrizione
keystringChiave di autenticazione dell'editore per l'API web di Steamworks.
appid uint32AppID del gioco per cui ottenere il rapporto.
typestringTipo di rapporto (valori possibili: "GAMESALES", "STEAMSTORESALES", "SETTLEMENT", "CHARGEBACK")
timestringOrario di inizio del rapporto. (formato RFC 3339 UTC: 2010-01-01T00:00:00Z)
maxresultsuint32Il numero massimo di risultati da restituire nel rapporto. Il valore predefinito è 1000, se non è impostato alcun valore. Tieni presente che potrebbero essere restituiti meno risultati rispetto a maxresults, anche nei casi in cui il numero di risultati dovesse essere maggiore.

Steam offre rapporti sulle transazioni che è possibile scaricare se si ha necessità di riconciliare. Questi rapporti mostrano informazioni dettagliate su ogni transazione che ha effetto sui fondi nel tuo account.

NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API DEVE arrivare da un server protetto e non può mai essere effettuata dai client!

NOTA: questo metodo ha delle versioni precedenti che non sono più ufficialmente supportate. Potrai continuare a usarle, ma ti consigliamo vivamente di utilizzare la versione più recente. Cronologia dei cambiamenti:
  • Version 2 - Il risultato è stato cambiato in matrici di ritorno.e
  • Versione 3 - Ora utilizza numeri a 64 bit in formato stringa.
  • Versione 4 - Aggiunta la sezione storepurchasereference per restituire informazioni di vendita sui DLC venduti nel Negozio che fanno riferimento a oggetti in gioco ottenibili tramite microtransazione.
  • Versione 5 - Aggiunta di nuovi valori di stato per le transazioni così da riflettere frodi sospette o frodi di storno dell'addebito.

Risposta:
  • response
    • result - Il risultato dell'operazione. (OK oppure Failure)
    • params
      • timecreated - Orario della transazione (in formato RFC 3339 UTC: 2010-01-01T00:00:00Z)
      • orderid - L'ID univoco a 64 bit dell'ordine. Sarà 0 per le sottoscrizioni ricorrenti inizializzate dal Negozio di Steam. In questo caso, utilizza transid
      • transid - ID univoco a 64 bit della transazione di Steam.
      • steamid - L'ID di Steam a cui appartengono l'ordine o la transazione.
      • status - Stato dell'ordine. Vedi: Appendice A: valori di stato
      • currency - Codice ISO 4217 della valuta.
      • time - Orario dell'aggiornamento più recente della transazione. (formato RFC 3339 UTC: 2010-01-01T00:00:00Z)
      • country - Codice nazionale ISO 3166-1-alpha-2 del Paese.
      • usstate - Stato degli USA. Vuoto per Paesi non USA.
    • items
      • itemid - ID del gioco in cui è presente l'oggetto.
      • qty - Quantità dell'oggetto.
      • amount - Costo totale per l'utente meno l'IVA (in centesimi). (199 = 1,99)
      • vat - IVA totale (in centesimi). (19 = 0,19)
      • itemstatus - Stato degli articoli all'interno dell'ordine.
      • storepurchasereference - Opzionale, restituito solo se l'acquisto è stato effettuato tramite un DLC sul Negozio che è connesso all'ID di un oggetto acquistabile tramite una microtransazione in gioco.
        • packageid - Il pacchetto DLC acquistato sul Negozio.
        • bundleid - L'ID del bundle associato al pacchetto DLC, se applicabile.
        • referenceid - Il referenceid dell'oggetto generato da Steam associato al pacchetto.
        • amount - Il prezzo pagato dall'utente.
        • vat - Aliquota IVA, se applicabile all'acquisto.
        • currency - La valuta utilizzata per l'acquisto.
    • error - Opzionale, restituito solo se il risultato è Failure.

Esempio di risposta:
{ "response": { "result": "OK", "params": { "count": 4, "orders": [ { "orderid": "1233", "transid": "1234567890123456788", "steamid": "76561197972751825", "status": "PartialRefund", "currency": "USD", "time": "2024-01-23T18:30:00Z", "country": "US", "usstate": "WA", "timecreated": "2024-01-23T18:15:00Z", "items": [ { "itemid": 100, "qty": 1, "amount": 99, "vat": 9, "itemstatus": "Refunded" }, { "itemid": 101, "qty": 1, "amount": 1299, "vat": 116, "itemstatus": "Succeeded" } ] }, { "orderid": "1234", "transid": "1234567890123456789", "steamid": "76561197972751825", "status": "Failed", "currency": "USD", "time": "2024-01-23T18:40:30Z", "country": "US", "usstate": "WA", "timecreated": "2024-01-23T18:39:00Z", "items": [ { "itemid": 100, "qty": 1, "amount": 99, "vat": 9, "itemstatus": "Failed" } ] }, { "orderid": "1235", "transid": "1234567890123456790", "steamid": "76561197972751825", "status": "Succeeded", "currency": "USD", "time": "2024-01-23T18:40:40Z", "country": "US", "usstate": "WA", "timecreated": "2024-01-23T18:39:30Z", "items": [ { "itemid": 101, "qty": 1, "amount": 1299, "vat": 116, "itemstatus": "Succeeded" } ] }, { "orderid": "1236", "transid": "1234567890123456791", "steamid": "76561197972751825", "status": "Chargedback", "currency": "USD", "time": "2024-01-23T19:55:00Z", "country": "US", "usstate": "WA", "timecreated": "2024-01-23T18:40:00Z", "items": [ { "itemid": 102, "qty": 1, "amount": 999, "vat": 89, "itemstatus": "Chargedback" } ] } ] } } }

GetUserAgreementInfo

GET https://partner.steam-api.com/ISteamMicroTxn/GetUserAgreementInfo/v2/
NomeTipoNecessarioDescrizione
keystringChiave di autenticazione dell'editore per l'API web di Steamworks.
steamiduint64ID di Steam del cliente.
appid uint32AppID del gioco per cui è valido il contratto.

Ottiene informazioni dettagliate su tutti i contratti di fatturazione ricorrenti (sottoscrizioni) di un utente.

NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API DEVE arrivare da un server protetto e non può mai essere effettuata dai client!

Versione 2 - Il valore di stato è "in fase di elaborazione" nel caso in cui Steam non abbia ancora effettuato l'addebito all'utente sulla base del contratto. Il valore di stato precedente è "attivo".

Risposta:
  • response
    • result - Il risultato dell'operazione. (OK oppure Failure)
    • params
      • agreements
        • agreement
          • agreementid - l'ID univoco a 64 bit del contratto di fatturazione di Steam.
          • itemid - ID del gioco in cui è presente l'oggetto.
          • status - Attivo, annullato o in fase di elaborazione.
          • period - Periodo del contratto.
          • frequency - Intervallo di tempo.
          • startdate - Data di inizio dell'elaborazione del pagamento ricorrente. Il formato è AAAAMMGG.
          • enddate - Data di fine dell'elaborazione del pagamento ricorrente. Il formato è AAAAMMGG.
          • recurringamt - Importo del pagamento (in centesimi) a ogni scadenza.
          • currency: il codice ISO 4217 della valuta usata per i prezzi.
          • timecreated - Data (nel formato AAAAMMGG) in cui è stato creato il contratto.
          • lastpayment - Data (nel formato AAAAMMGG) dell'ultimo pagamento eseguito con successo.
          • lastamount - Importo in centesimi dell'ultimo pagamento eseguito con successo.
          • nextpayment - Data (nel formato AAAAMMGG) del prossimo pagamento.
          • outstanding - Importo in centesimi ancora da pagare.
          • failedattempts - Numero di fatturazioni non riuscite sui totali ancora da pagare.
    • error - Opzionale, restituito solo se il risultato è Failure.

GetUserInfo

GET https://partner.steam-api.com/ISteamMicroTxn/GetUserInfo/v2/
NomeTipoNecessarioDescrizione
keystringChiave di autenticazione dell'editore per l'API web di Steamworks.
appiduint32AppID del gioco in cui l'utente effettuerà un acquisto.
steamiduint64ID di Steam dell'utente che effettua l'acquisto.
ipaddressstringIndirizzo IP dell'utente in formato stringa (xxx.xxx.xxx.xxx). Richiesto solo se usersession in InitTxn è stato impostato su web.

Recupera i dettagli delle informazioni di acquisto di un utente.

Questi dettagli sono basati sul Portafoglio di Steam dell'utente.
Se l'account è nuovo, o se non ha ancora un Portafoglio di Steam associato, le informazioni restituite saranno basate sull'indirizzo IP dell'utente. Se l'utente ha effettuato l'accesso a Steam, l'indirizzo IP sarà ottenuto tramite il client di Steam. In caso contrario, sarà ottenuto tramite il parametro API "ipaddress". Se l'utente non ha un Portafoglio, non ha effettuato l'accesso al client di Steam e se non hai fornito un indirizzo IP, questa chiamata restituirà un errore a indicare che l'utente non ha effettuato l'accesso.

Questo metodo ha delle versioni precedenti che non sono più ufficialmente supportate. Potrai continuare a usarle, ma ti consigliamo vivamente di utilizzare la versione più recente.
Cronologia delle modifiche:
  • Versione 2 - Ora utilizza numeri a 64 bit in formato string.

NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API DEVE arrivare da un server protetto e non può mai essere effettuata direttamente dai client!

Risposta:
  • response
    • result - Il risultato dell'operazione. (OK oppure Failure)
    • params
      • state - Stato degli USA. Vuoto per Paesi non USA.
      • country - Codice nazionale ISO 3166-1-alpha-2 del Paese.
      • currency: il codice ISO 4217 della valuta usata per i prezzi.
      • status - Stato dell'account. Può essere:
        • Locked from purchasing - non può effettuare acquisti
        • Active - lo stato predefinito dell'account
        • Trusted - un account attivo con un acquisto effettuato oltre 90 giorni fa e senza chargeback

    • error - Opzionale, restituito solo se il risultato è Failure.

Esempio di risposta:
<response> <result>OK</result> <params> <state>WA</state> <country>US</country> <currency>USD</currency> </params> </response>

InitTxn

POST https://partner.steam-api.com/ISteamMicroTxn/InitTxn/v3/
NomeTipoNecessarioDescrizione
keystringChiave di autenticazione dell'editore per l'API web di Steamworks.
orderiduint64L'ID univoco a 64 bit dell'ordine
steamiduint64ID di Steam dell'utente che effettua l'acquisto.
appid uint32AppID del gioco oggetto della transazione.
itemcountuint32Numero di articoli nel carrello.
languagestringCodice ISO 639-1 della lingua delle descrizioni dell'articolo. Funziona solo con le 28 lingue pienamente supportate da Steam. Vedi le lingue supportate
currencystringCodice ISO 4217 della valuta. Vedi Valute supportate per il formato corretto di ogni valuta.
usersessionstringLa sessione in cui l'utente autorizzerà la transazione. Le opzioni possibili sono: "client" o "web". Se questo parametro non viene fornito, si riterrà che l'utente abbia effettuato l'accesso al client di Steam.
ipaddressstringIndirizzo IP dell'utente in formato stringa (xxx.xxx. xxx.xxx). Necessario solo se [param]usersession[/param] è impostato su web.
itemid[0]uint32ID di terze parti dell'articolo.
qty[0]int16Quantità dell'articolo.
amount[0]int64Costo totale in centesimi dell'articolo o degli articoli da addebitare in questo momento. Vedi Valute supportate per il formato corretto di ogni totale. Nota che il totale passato deve essere nello stesso formato del codice "currency".
description[0]stringDescrizione dell'articolo. Lunghezza massima di 128 caratteri.
category[0]stringDescrizione testuale facoltativa della categoria in cui includere questo articolo. Questo valore è utilizzato per raggruppare i dati di vendita nei rapporti di Steam e non viene mai mostrato all'utente. Lunghezza massima di 64 caratteri.
associated_bundle[0]uint32Bundleid del pacchetto associato. Opzionale.
billingtype[0]stringTipo di fatturazione ricorrente. Opzionale. Le opzioni possibili sono: "Steam" o "Game"
  • Steam: addebito automatico da parte di Steam
  • Gioco: il partner deve chiamare l'API ProcessAgreement per l'addebito
startdate[0]stringData di inizio facoltativa per la fatturazione ricorrente (RFC 3339 UTC, formato: 2010-01-01T00:00:00Z).
enddate[0]stringData di fine facoltativa per la fatturazione ricorrente (RFC 3339 UTC, formato: 2010-01-01T00:00:00Z).
period[0]stringPeriodo per la fatturazione ricorrente. Opzionale. Le opzioni possibili sono: "Day", "Week", "Month", "Year"
frequency[0]uint32Frequenza della fatturazione ricorrente (in numero di giorni). Opzionale. Valori supportati: 1-255
recurringamt[0]int64Importo facoltativo da fatturare per future transazioni ricorrenti.
bundlecountuint32Numbero di pacchetti nel carrello.
bundleid[0]uint32ID di terze parti del pacchetto. Condivide lo stesso spazio per l'ID degli articoli di terze parti.
bundle_qty[0]uint32Quantità di questo pacchetto.
bundle_desc[0]stringDescrizione del pacchetto. Lunghezza massima di 128 caratteri.
bundle_category[0]stringDescrizione testuale facoltativa della categoria del pacchetto in cui includere questo articolo. Questo valore è utilizzato per raggruppare i dati di vendita nei rapporti di Steam e non viene mai mostrato all'utente. Lunghezza massima di 64 caratteri.

Crea un nuovo acquisto. Invia le informazioni sull'ordine insieme all'ID di Steam per generare la transazione all'interno di Steam.

Questo comando consente la creazione di un carrello contenente uno o più articoli per un utente. Il costo e la descrizione degli articoli saranno visualizzati dall'utente per la sua approvazione. L'interfaccia di acquisto può essere configurata sia per il client di Steam che per un broswer web, a seconda che l'acquisto venga effettuato all'interno del gioco o su una pagina web.

Formato della valuta e del totale

Nota che alcune valute devono essere utilizzate con incrementi specifici. Ad esempio, la Grivnia ucraina (UAH) deve essere utilizzata con incrementi di 100. Se stabilisci il prezzo di un articolo a 1050 UAH, InitTxn restituirà l'errore k_EMicroTxnResultInvalidParam. Per una lista completa dei requisiti riguardanti i prezzi, vedi: Valute supportate.

Se non desideri utilizzare la valuta locale degli utenti per ogni transazione, Steam è in grado di convertire tutti gli acquisti nella valuta locale del Portafoglio dell'utente in base ai tassi di cambio attuali. Ad esempio, se currency è impostato su "USD" e amount su "999", gli utenti in Russia pagheranno l'equivalente in rubli di $9.99 (614.90 pуб al momento in cui è stato scritto questo articolo). Tieni presente, tuttavia, che la finestra di dialogo di conferma della transazione che appare ai clienti mostrerà il prezzo e la valuta che hai specificato. La conversione avviene non appena la transazione viene completata. Nell'esempio precedente, i clienti in Russia visualizzano un prezzo di 9,99 USD nella finestra di dialogo di conferma, ma al termine della transazione vengono addebitati 614,90 pуб. Ti consigliamo di fornire prezzi personalizzati per ogni valuta in cui prevedi che i tuoi clienti effettuino transazioni regolarmente.

Nota che devi inviare amount nello stesso formato in cui invii il codice currency.

Una risposta positiva a questo comando significa che la transazione è stata creata. Se l'interfaccia di acquisto è il client di Steam, all'utente verrà presentata automaticamente una finestra di dialogo per richiedere l'autorizzazione all'acquisto. Utilizzando un'interfaccia web, invece, l'utente verrà reindirizzato all'URL di Steam restituito nella risposta. In caso di timeout o altri errori di comunicazione, abbandona la transazione e creane una nuova.

Quando per un utente viene indicata una sessione "client" tramite [param]usersession[/param], l'utente dovrà approvare la transazione all'interno del client, attraverso l'overlay di gioco. Le sessioni web richiedono che l'utente effettui l'accesso a Steam sul browser in cui la transazione verrà presentata per l'approvazione.

Questo metodo ha delle versioni precedenti che non sono più ufficialmente supportate. Potrai continuare a usarle, ma ti consigliamo vivamente di utilizzare la versione più recente.
Cronologia delle modifiche:
  • Version 2 - Ora utilizza numeri a 64 bit in formato string.

Questo metodo ha delle versioni precedenti che non sono più ufficialmente supportate. Potrai continuare a usarle, ma ti consigliamo vivamente di utilizzare la versione più recente.
Cronologia delle modifiche:
  • Versione 3 - L'ammontare delle quantità è ora obbligatoriamente un numero a 16 bit.

NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API DEVE arrivare da un server protetto e non può mai essere effettuata direttamente dai client!

Risposta:
  • response
    • result - Il risultato dell'operazione. (OK oppure Failure)
    • params
      • orderid - L'ID univoco a 64 bit dell'ordine.
      • transid - L'ID univoco a 64 bit della transazione di Steam.
      • steamurl - L'URL opzionale restituito quando l'input della usersession è impostato su web. Questo URL può essere utilizzato per reindirizzare la sessione web dell'utente a Steam in modo che possa approvare la transazione.
      • contratti - Lista facoltativa di contratti quando il tipo di fatturazione è ricorrente.
    • error - Opzionale, restituito solo se il risultato è Failure.

Esempio di risposta:
<response> <result>OK</result> <params> <orderid>938473</orderid> <transid>374839</transid> </params> </response> <response> <result>Failure</result> <params> <orderid>938474</orderid> </params> <error> <errorcode>1001</errorcode> <errordesc>Action not allowed</errordesc> </error> </response>

ProcessAgreement

POST https://partner.steam-api.com/ISteamMicroTxn/ProcessAgreement/v1/
NomeTipoNecessarioDescrizione
keystringChiave di autenticazione dell'editore per l'API web di Steamworks.
orderiduint64L'ID unico a 64 bit dell'ordine. Sarà 0 se la sottoscrizione è stata inizializzata dal Negozio di Steam.
steamiduint64ID di Steam del cliente.
agreementiduint64ID unico a 64 bit del contratto di fatturazione di Steam.
appid uint32AppID del gioco per cui è valido il contratto.
amountint32Costo totale in centesimi.

Questo valore corrisponde all'ammontare iniziale da far pagare immediatamente e una volta sola al cliente.
currencystringIl codice ISO 4217 della valuta usata per i prezzi

Inizializza un pagamento ricorrente (sottoscrizione) per l'utente.

Una risposta positiva significa che Steam inizierà un ciclo di fatturazione per l'utente, ma non che il ciclo di fatturazione è stato completato con successo. Utilizza le API GetReport o GetUserAgreementInfo per verificare lo stato effettivo della fatturazione.

NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API DEVE arrivare da un server protetto e non può mai essere effettuata direttamente dai client!

Risposta:
  • response
    • result - Il risultato dell'operazione. (OK oppure Failure)
    • params
      • orderid - L'ID univoco a 64 bit dell'ordine.
      • transid - L'ID univoco a 64 bit della transazione di Steam.
      • agreementid - L'ID univoco a 64 bit del contratto di fatturazione di Steam.
    • error - Opzionale, restituito solo se il risultato è Failure.

QueryTxn

GET https://partner.steam-api.com/ISteamMicroTxn/QueryTxn/v3/
NomeTipoNecessarioDescrizione
keystringChiave di autenticazione dell'editore per l'API web di Steamworks.
appid uint32AppID del gioco oggetto della transazione.
orderiduint64L'ID unico a 64 bit dell'ordine.
transiduint64ID a 64 bit unico della transazione di Steam.

Consulta lo stato di un ordine creato in precedenza con InitTxn.

Questo metodo ha delle versioni precedenti che non sono più ufficialmente supportate. Potrai continuare a usarle, ma ti consigliamo vivamente di utilizzare la versione più recente.
Cronologia delle modifiche:
  • Version 2 - Ora utilizza numeri a 64 bit in formato string.
  • Versione 3 - Aggiunta di nuovi valori di stato per le transazioni così da riflettere frodi sospette o frodi di storno dell'addebito.

NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API DEVE arrivare da un server protetto e non può mai essere effettuata direttamente dai client!

Risposta:
  • response
    • result - Il risultato dell'operazione. (OK oppure Failure)
    • params
      • orderid - L'ID unico a 64 bit dell'ordine.
      • transid - ID a 64 bit unico della transazione di Steam.
      • steamid - L'ID di Steam a cui appartengono l'ordine o la transazione.
      • status - Stato dell'ordine. Vedi: Appendice A: valori di stato
      • currency - Codice valuta ISO 4217.
      • time - Orario della transazione (in formato RFC 3339 UTC: 2010-01-01T00:00:00Z)
      • country - Codice nazionale ISO 3166-1-alpha-2 del Paese.
      • usstate - Stato degli USA. Vuoto per Paesi non USA.

      • items
        • itemid - ID del gioco in cui è presente l'oggetto.
        • qty - Quantità dell'oggetto.
        • amount - Costo totale per l'utente meno l'IVA (in centesimi). (199 = 1,99)
        • vat - IVA totale (in centesimi). (19 = 0,19)
        • itemstatus - Stato degli articoli all'interno dell'ordine.
    • error - Opzionale, restituito solo se il risultato è Failure.

Esempio di risposta:
<response> <result>OK</result> <params> <orderid>938474</orderid> <transid>374839</transid> <steamid>48392063</steamid> <status>Succeeded</status> <currency>GBP</currency> <time>2010-01-01T00:23:45Z</time> <items> <item> <itemid>12345</itemid> <qty>1</qty> <amount>199</amount> <vat>38</vat> <itemstatus>Succeeded</itemstatus> </item> <item> <itemid>12345</itemid> <qty>1</qty> <amount>199</amount> <vat>38</vat> <itemstatus>Succeeded</itemstatus> </item> </items> </params> </response>

RefundTxn

POST https://partner.steam-api.com/ISteamMicroTxn/RefundTxn/v2/
NomeTipoNecessarioDescrizione
keystringChiave di autenticazione dell'editore per l'API web di Steamworks.
orderiduint64L'ID unico a 64 bit dell'ordine da rimborsare.
appid uint32App ID del gioco.

Comunica a Steam di rimborsare un utente dopo l'acquisto. I rimborsi devono essere dello stesso valore dell'acquisto originale.

Questo metodo ha delle versioni precedenti che non sono più ufficialmente supportate. Potrai continuare a usarle, ma ti consigliamo vivamente di utilizzare la versione più recente.
Cronologia delle modifiche:
  • Version 2 - Ora utilizza numeri a 64 bit in formato string.

NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API DEVE arrivare da un server protetto e non può mai essere effettuata direttamente dai client!

Risposta:
  • response
    • result - Il risultato dell'operazione. (OK oppure Failure)
    • params
      • orderid - L'ID unico a 64 bit dell'ordine.
      • transid - ID a 64 bit unico della transazione di Steam.
    • error - Opzionale, restituito solo se il risultato è Failure.

Esempio di risposta:
<response> <result>OK</result> <params> <orderid>938474</orderid> <transid>374839</transid> </params> </response>