This is the interface used to support Microtransactions (In-Game Purchases).

See the Microtransactions Implementation Guide for more details.
For more info on how to use the Steamworks Web API please see the Web API Overview.

AdjustAgreement

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
steamid	uint64	✔	Steam ID of the client that is adjusting the agreement.
agreementid	uint64	✔	Unique 64-bit Steam billing agreement ID.
appid	uint32	✔	App ID of the game the agreement is for.
nextprocessdate	string	✔	Date that next recurring payment should be initiated. Format is YYYYMMDD. Date can only be adjusted forward indicating you want to add time to the subscription. If the date exceeds the end date of the subscription, the end date will be extended.
oldnextprocessdate	string		Optional paramter that is the last known next recurring payment date that should be checked against. Format is YYYYMMDD. If this parameter is provided, the API will verify that the current next recurring date has not changed before attempting to adjust the agreement next process changes to the agreement.

Add time to the payment schedule of an agreement with billing type "steam". The agreementid can be retrieved using GetUserAgreementInfo.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

Response:

• response
  
  • result - Result of the operation. (OK or Failure)
    
  • params
    
    • agreementid - Unique 64-bit Steam billing agreement ID.
      
    • nextprocessdate - The date that the next recurring payment will be initiated. Format is YYYYMMDD.
      
  • error - Optional, only returned if result is Failure.
    
    • errorcode - Error or event code. See: Appendix B: Error Codes
      
    • errordesc - Message for error or event.
      

CancelAgreement

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
steamid	uint64	✔	Steam ID of the client that is canceling the agreement.
agreementid	uint64	✔	Unique 64-bit Steam billing agreement ID.
appid	uint32	✔	App ID of the game the agreement is for.

Cancels a recurring billing agreement (subscription). The agreementid can be retrieved using GetUserAgreementInfo.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

Response:

• response
  
  • result - Result of the operation. (OK or Failure)
    
  • params
    
    • agreementid - Unique 64-bit Steam billing agreement ID.
      
  • error - Optional, only returned if result is Failure.
    
    • errorcode - Error or event code. See: Appendix B: Error Codes
      
    • errordesc - Message for error or event.
      

FinalizeTxn

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
orderid	uint64	✔	Unique 64-bit ID for order
appid	uint32	✔	App ID for game.

Completes a purchase that was started by the InitTxn API.

This command will capture funds for a transaction and should only be called after the user has authorized the transaction and you have received notification that the authorization was successful. Notification of authorization comes either through the Steam client (your game registers to receive notification) or through the user being redirected back to your web site (return URL specified when you redirect a user's web session to Steam). The usersession value specified in InitTxn determines the notification mechanism.

A successful response to this command means payment has been completed and you can safely grant items to the user. In the event of a timeout or some other communication error, use either the QueryTxn or GetReport APIs to get status on the transaction.

This method has previous versions which are no longer officially supported. They will continue to be usable but it's highly recommended that you use the latest version.
Change history:

• Version 2 - Changed to string formatted 64 bit numbers.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

Response:

• response
  
  • result - Result of the operation. (OK or Failure)
    
  • params
    
    • orderid - Unique 64-bit ID for order.
      
    • transid - Unique 64-bit Steam transaction ID.
      
  • error - Optional, only returned if result is Failure.
    
    • errorcode - Error or event code. See: Appendix B: Error Codes
      
    • errordesc - Message for error or event.
      

Example Response:

GetReport

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
appid	uint32	✔	App ID of game to get reports for.
type	string		Report type (One of: "GAMESALES", "STEAMSTORESALES", "SETTLEMENT", "CHARGEBACK", "SUBSCRIPTION")
time	string	✔	Start time of the report. (RFC 3339 UTC formatted like: 2010-01-01T00:00:00Z)
maxresults	uint32		Maximum number of results to return in report. (Default is 1000 if no value is set) Note that the number of results returned might be less than maxresults, even when they are more results. Maximum number of results is 50000. The recommended number to use is between 1000 and 10000, as that should provide the best response time and data to manage.

Steam offers transaction reports that can be downloaded for reconciliation purposes. These reports show detailed information about each transaction that affects the settlement of funds into your accounts.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

NOTE: This method has previous versions which are no longer officially supported. They will continue to be usable but it's highly recommended that you use the latest version. Change history:

• Version 2 - Changed result to returns arrays.
  
• Version 3 - Changed to string formatted 64 bit numbers.
  
• Version 4 - Added storepurchasereference section to return sales information for DLCs sold on the store that reference in-game microtransaction items.
  
• Version 5 - Added new status values to for transactions to reflect suspected fraud or friendly fraud.

Response:

• response
  
  • result - Result of the operation. (OK or Failure)
    
  • params
    
    • timecreated - Time of transaction (RFC 3339 UTC formatted like: 2010-01-01T00:00:00Z)
      
    • orderid - Unique 64-bit ID for order. (This will be 0 for recurring subscriptions initiated from the Steam store, use transid instead.)
      
    • transid - Unique 64-bit Steam transaction ID.
      
    • steamid - The Steam ID of user that the order/transaction belongs to.
      
    • status - Status of the order. See: Appendix A: Status Values
      
    • currency - ISO 4217 currency code.
      
    • time - Time of the most recent update to the transaction. (RFC 3339 UTC formatted like: 2010-01-01T00:00:00Z)
      
    • country - ISO 3166-1-alpha-2 country code.
      
    • usstate - US State. Empty for non-US countries.
      
  • items
    
    • itemid - Game ID number of item.
      
    • qty - Quantity of this item.
      
    • amount - Total cost to user minus VAT (in cents). (199 = 1.99)
      
    • vat - Total VAT or tax (in cents). (19 = .19)
      
    • itemstatus - Status of items within the order.
      
    • storepurchasereference - Optional, only returned if the purchase was via a DLC on the store that is connected to an in-game microtransaction item id.
      
      • packageid - The DLC package that was purchased on the store.
        
      • bundleid - The bundle id associated with the DLC package, if applicable.
        
      • referenceid - The steam generated line item referenceid associated with the package.
        
      • amount - The price paid by the user.
        
      • vat - VAT taxes if applicable for the purchase.
        
      • currency - The currency that was used to make the purchase.
  • error - Optional, only returned if result is Failure.
    
    • errorcode - Error or event code. See: Appendix B: Error Codes
      
    • errordesc - Message for error or event.
      

Example Response:

GetUserAgreementInfo

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
steamid	uint64	✔	Steam ID of the client.
appid	uint32	✔	App ID of the game the agreement is for.

Get detailed information of all recurring billing agreements (subscriptions) for a user.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

Version 2 - The status value can be "processing" in the case where Steam has not yet charged the user for the agreement. Previously the status value would be "active"

Response:

• response
  
  • result - Result of the operation. (OK or Failure)
    
  • params
    
    • agreements
      
      • agreement
        
        • agreementid - Unique 64-bit Steam billing agreement ID.
          
        • itemid - Game ID number of item
          
        • status - Active, canceled, or processing.
          
        • period - Period of agreement.
          
        • frequency - Interval of period.
          
        • startdate - Date that recurring payment processing starts. Format is YYYYMMDD.
          
        • enddate - Date that recurring payment processing ends. Format is YYYYMMDD.
          
        • recurringamt - Amount to bill (in cents) at each recurring interval.
          
        • currency - ISO 4217 currency code of prices.
          
        • timecreated - Date that agreement was created in YYYYMMDD format.
          
        • lastpayment - Date of last successful payment in YYYYMMDD format.
          
        • lastamount - Amount of last successful payment in cents.
          
        • nextpayment - Date of next scheduled payment in YYYYMMDD format.
          
        • outstanding - Current outstanding balance in cents.
          
        • failedattempts - Number of failed billing attempts on outstanding balance.
          
  • error - Optional, only returned if result is Failure.
    
    • errorcode - Error or event code. See: Appendix B: Error Codes
      
    • errordesc - Message for error or event.
      

GetUserInfo

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
appid	uint32	✔	AppID of the game the user will make a purchase in.
steamid	uint64		Steam ID of user making purchase.
ipaddress	string		IP address of user in string format (xxx.xxx.xxx.xxx). Only required if usersession in InitTxn was set to web.

Retrieves details for a user's purchasing info.

These details are based upon the user's Steam wallet.
For new accounts or accounts that do not yet have a Steam wallet, the information returned will be based off of the user's IP address. The IP will be taken from the user's Steam client session if they are logged in, otherwise from the ipaddress API parameter. If the user does not have a wallet, is not logged in through the Steam client, and you have not supplied an IP address, this call will return an error indicating the user is not logged in.

This method has previous versions which are no longer officially supported. They will continue to be usable but it's highly recommended that you use the latest version.
Change history:

• Version 2 - Changed to string formatted 64 bit numbers.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

Response:

• response
  
  • result - Result of the operation. (OK or Failure)
    
  • params
    
    • state - US State. Empty for non-US countries.
      
    • country - ISO 3166-1-alpha-2 country code.
      
    • currency - ISO 4217 currency code of prices.
      
    • status - Status of the account. Can be:
      • Locked from purchasing - cannot make purchases
      • Active - the default account state
      • Trusted - an active account with a purchase older than 90 days without a chargeback
      
      
  • error - Optional, only returned if result is Failure.
    
    • errorcode - Error or event code. See: Appendix B: Error Codes
      
    • errordesc - Message for error or event.
      

Example Response:

InitTxn

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
orderid	uint64	✔	Unique 64-bit ID for order
steamid	uint64	✔	Steam ID of user making purchase.
appid	uint32	✔	App ID of game this transaction is for.
itemcount	uint32	✔	Number of items in cart.
language	string	✔	ISO 639-1 language code of the item descriptions. Only works with the 28 fully supported Steam languages. See supported languages
currency	string	✔	ISO 4217 currency code. See Supported Currencies for proper format of each currency.
usersession	string		Session where user will authorize the transaction. Valid options are "client" or "web". If this parameter is not supplied, the interface will be assumed to be through a currently logged in Steam client session.
ipaddress	string		IP address of user in string format (xxx.xxx.xxx.xxx). Only required if [param]usersession[/param] is set to web.
itemid[0]	uint32	✔	3rd party ID for item.
qty[0]	int16	✔	Quantity of this item.
amount[0]	int64	✔	Total cost (in cents) of item(s) to be charged at this time. See Supported Currencies for proper format of each amount. Note that the amount you pass needs to be in the format that matches the "currency" code you pass.
description[0]	string	✔	Description of item. Maximum length of 128 characters.
category[0]	string		Optional text description of a category that this item should be grouped with. This value is used for grouping sales data in backend Steam reporting and is never displayed to the user. Maximum length of 64 characters
associated_bundle[0]	uint32		Optional bundleid of associated bundle.
billingtype[0]	string		Optional recurring billing type. Valid options are: "Steam" or "Game" Steam: Steam automatically re-bills Game: Partner needs to call ProcessAgreement API to bill
period[0]	string		Optional period for recurring billing. Valid options are: "Day", "Week", "Month", "Year"
frequency[0]	uint32		Optional frequency (in number of days) for recurring billing. Supported values: 1 - 255
recurringamt[0]	int64		Optional amount to be billed for future recurring billing transactions.
bundlecount	uint32		Number of bundles in cart.
bundleid[0]	uint32		3rd party ID of the bundle. This shares the same ID space as 3rd party items.
bundle_qty[0]	uint32		Quantity of this bundle.
bundle_desc[0]	string		Description of bundle. Maximum length of 128 characters.
bundle_category[0]	string		Optional text description of a bundle category that this item should be grouped with. This value is used for grouping sales data in backend Steam reporting and is never displayed to the user. Maximum length of 64 characters.

Creates a new purchase. Send the order information along with the Steam ID to seed the transaction on Steam.

This command allows you to create a shopping cart of one or more items for a user. The cost and descriptions of these items will be displayed to the user for their approval. The purchase interface can be configured for either the Steam client or a web browser depending on if you are running a purchase in-game or from a web page.
A successful response to this command means the transaction has been created. If the purchase interface is the Steam client, the user will automatically be presented with a dialog requesting authorization for the purchase. For a web interface, redirect the user to the steam URL returned in the response. In the event of a timeout or some other communication error, abandon the transaction and create a new one.

When a "client" user session is indicated via [param]usersession[/param] the user will be required to approve the transaction from within the game overlay on the client. Web sessions will require the user to be logged into Steam via a browser where the transaction will be presented and an approval option displayed.

This method has previous versions which are no longer officially supported. They will continue to be usable but it's highly recommended that you use the latest version.
Change history:

• Version 2 - Changed to string formatted 64 bit numbers.

This method has previous versions which are no longer officially supported. They will continue to be usable but it's highly recommended that you use the latest version.
Change history:

• Version 3 - Enforced quantity amounts to be a 16 bit number.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

Response:

• response
  
  • result - Result of the operation. (OK or Failure)
    
  • params
    
    • orderid - Unique 64-bit ID for order.
      
    • transid - Unique 64-bit Steam transaction ID.
      
    • steamurl - Optional URL returned when the usersession input is set to web. This URL can be used to redirect the user's web session to Steam so that the user can approve the transaction.
      
    • agreements - Optional list of agreements when the billing type is recurring.
      
  • error - Optional, only returned if result is Failure.
    
    • errorcode - Error or event code. See: Appendix B: Error Codes
      
    • errordesc - Message for error or event.
      

Example Response:

ProcessAgreement

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
orderid	uint64	✔	Unique 64-bit ID for order. If the recurring subscription was initiated from the Steam store, then this field will be 0.
steamid	uint64	✔	Steam ID of the client.
agreementid	uint64	✔	Unique 64-bit Steam billing agreement ID.
appid	uint32	✔	App ID of the game the agreement is for.
amount	int32	✔	Total cost (in cents). This value corresponds to an initial one-time amount to be immediately charged to a user.
currency	string	✔	ISO 4217 currency code of prices

Initiate a recurring payment (subscription) for the user.

A successful response means that Steam will initiate a billing cycle for the user. It does not mean that the actual billing cycle was completed successfully. Use the GetReport or GetUserAgreementInfo APIs to check actual billing status.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

Response:

• response
  
  • result - Result of the operation. (OK or Failure)
    
  • params
    
    • orderid - Unique 64-bit ID for order.
      
    • transid - Unique 64-bit Steam transaction ID.
      
    • agreementid - Unique 64-bit Steam billing agreement ID.
      
  • error - Optional, only returned if result is Failure.
    
    • errorcode - Error or event code. See: Appendix B: Error Codes
      
    • errordesc - Message for error or event.
      

QueryTxn

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
appid	uint32	✔	App ID of game this transaction is for.
orderid	uint64		Unique 64-bit ID for order.
transid	uint64		Unique 64-bit Steam transaction ID.

Query the status of an order that was previously created with InitTxn.

This method has previous versions which are no longer officially supported. They will continue to be usable but it's highly recommended that you use the latest version.
Change history:

• Version 2 - Changed to string formatted 64 bit numbers.
  
• Version 3 - Added new status values to for transactions to reflect suspected fraud or friendly fraud.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

Response:

• response
  
  • result - Result of the operation. (OK or Failure)
    
  • params
    
    • orderid - Unique 64-bit ID for order.
      
    • transid - Unique 64-bit Steam transaction ID.
      
    • steamid - The Steam ID of user that the order/transaction belongs to.
      
    • status - Status of the order. See: Appendix A: Status Values
      
    • currency - ISO 4217 currency code.
      
    • time - Time of transaction (RFC 3339 UTC formatted like: 2010-01-01T00:00:00Z)
      
    • country - ISO 3166-1-alpha-2 country code.
      
    • usstate - US State. Empty for non-US countries.
      
      
    • items
      
      • itemid - Game ID number of item.
        
      • qty - Quantity of this item.
        
      • amount - Total cost to user minus VAT (in cents). (199 = 1.99)
        
      • vat - Total VAT or tax (in cents). (19 = .19)
        
      • itemstatus - Status of items within the order.
        
  • error - Optional, only returned if result is Failure.
    
    • errorcode - Error or event code. See: Appendix B: Error Codes
      
    • errordesc - Message for error or event.
      

Example Response:

RefundTxn

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
orderid	uint64	✔	Unique 64-bit ID for order to refund.
appid	uint32	✔	App ID of the game.

Tells Steam to refund a user for a purchase. Refunds can only be made for the full value of the original order.

This method has previous versions which are no longer officially supported. They will continue to be usable but it's highly recommended that you use the latest version.
Change history:

• Version 2 - Changed to string formatted 64 bit numbers.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

Response:

• response
  
  • result - Result of the operation. (OK or Failure)
    
  • params
    
    • orderid - Unique 64-bit ID for order.
      
    • transid - Unique 64-bit Steam transaction ID.
      
  • error - Optional, only returned if result is Failure.
    
    • errorcode - Error or event code. See: Appendix B: Error Codes
      
    • errordesc - Message for error or event.
      

Example Response: