マイクロトランザクション（ゲーム内購入）をサポートするために使用するインターフェイスです。
詳細については、
マイクロトラントランザクション実装ガイドを参照してください。
Steamworks Web APIの使用に関する詳細は、
Web API 概要を参照してください。
AdjustAgreement
POST https://partner.steam-api.com/ISteamMicroTxn/AdjustAgreement/v1/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー |
| steamid | uint64 | ✔ | 契約を変更するクライアントのSteam ID |
| agreementid | uint64 | ✔ | 固有の64ビットSteam課金契約ID |
| appid | uint32 | ✔ | 契約するゲームのApp ID |
| nextprocessdate | string | ✔ | 次の定期支払を開始する日付です。 形式は、YYYYMMDDです。
サブスクリプションへ時間を追加することを希望する場合にのみ、日付は前方に調整することができます。 日付がサブスクリプションの終了日を超える場合、終了日は延長されます。 |
| oldnextprocessdate | string | | 確認が必要な次回の定期支払日の最後の既知の日付を示すオプションパラメーター。 形式はYYYYMMDDです。
このパラメーターが指定されている場合、APIは現時点での次回の定期支払日が変更されていないことを確認してから、契約の次のプロセスの変更を調整します。 |
支払タイプが「Steam」に設定された契約の支払スケジュールに時間を追加します。 agreementidは、
GetUserAgreementInfoを使用して取得できます。
注： この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
応答： -
response
-
result－呼び出しの結果 （OKまたはFailure）
-
params
-
agreementid－固有の64ビットSteam課金契約ID
-
nextprocessdate - 次の定期支払いを開始する日付です。 形式は、YYYYMMDDです。
-
error －省略可能。 結果がFailureの場合のみ返されます。
-
errorcode－エラーまたはイベントコード。 詳細は次のドキュメントを参照してください：付録B：エラーコード
-
errordesc - エラーまたはイベントへのメッセージ
CancelAgreement
POST https://partner.steam-api.com/ISteamMicroTxn/CancelAgreement/v1/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー |
| steamid | uint64 | ✔ | 契約を解約するクライアントのSteam ID |
| agreementid | uint64 | ✔ | 固有の64ビットSteam課金契約ID |
| appid | uint32 | ✔ | 契約を結ぶゲームのApp ID |
定期課金契約の解約（サブスクリプション） agreementidは、
GetUserAgreementInfoを使用して取得できます。
注： この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
応答： -
response
-
result－呼び出しの結果 （OKまたはFailure）
-
params
-
agreementid－固有の64ビットSteam課金契約ID
-
error －省略可能。 結果がFailureの場合のみ返されます。
-
errorcode－エラーまたはイベントコード。 詳細は次のドキュメントを参照してください：付録B：エラーコード
-
errordesc－エラーまたはイベントへのメッセージ
FinalizeTxn
POST https://partner.steam-api.com/ISteamMicroTxn/FinalizeTxn/v2/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー |
| orderid | uint64 | ✔ | 注文固有の64ビットID |
| appid | uint32 | ✔ | ゲームのApp ID |
InitTxn APIによって開始された購入を完了します。
このコマンドは支払いに必要な資金を回収します。そのため、ユーザーが取引を承認し、承認が成功したという通知を受け取った後にのみ呼び出されるべきです。 承認の通知はSteamクライアント（通知を受け取るためのゲーム登録）経由、またはユーザーをWebサイト（ユーザーのWebセッションをSteamにリダイレクトする際に指定された戻りURL）にリダイレクトして通知します。 InitTxnで指定されたユーザーセッション値によって、通知方法が決まります。
このコマンドへの応答が成功した場合は、支払が完了し、安全にアイテムをユーザーに付与できることを意味します。 タイムアウトまたはその他の通信エラーが発生した場合は、
QueryTxnまたは
GetReport APIを使用して取引のステータスを取得してください。
このメソッドには、現在公式にはサポートされていない古いバージョンが存在します。 今後も引き続き使用可能ですが、最新バージョンの使用を強く推奨します。
変更履歴は以下のとおりです。
- バージョン 2－64ビットの数値形式の文字列に変更
注： この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
応答： -
応答
-
result－呼び出しの結果 （OKまたはFailure）
-
params
-
orderid－注文固有の64ビットID
-
transid－固有の64ビットのSteam取引ID
-
error －省略可能。 結果がFailureの場合のみ返されます。
-
errorcode－エラーまたはイベントコード。 詳細は次のドキュメントを参照してください：付録B：エラーコード
-
errordesc－エラーまたはイベントへのメッセージ
応答の例：<response>
<result>OK</result>
<params>
<orderid>938473</orderid>
<transid>374839</transid>
</params>
</response>
GetReport
GET https://partner.steam-api.com/ISteamMicroTxn/GetReport/v5/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー |
| appid | uint32 | ✔ | レポートを取得するゲームのApp ID |
| type | string | | レポートのタイプ （次のうちのいずれか：「GAMESALES」「STEAMSTORESALES」「SETTLEMENT」「CHARGEBACK」） |
| time | string | ✔ | レポートの開始時間 (RFC 3339 UTCフォーマット例：2010-01-01T00:00:00Z) |
| maxresults | uint32 | | レポート内の最大結果数 （値が設定されていない場合、デフォルトは1000です）。返される結果の数は、多い場合でも 「maxresults」より少なくなる可能性があることに注意してください。 |
Steamは、調整目的でダウンロード可能な取引レポートを提供します。 これらのレポートは、アカウントへの資金決済に影響する、各取引に関する詳細情報を表示します。
注： この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
注： このメソッドには、現在公式にはサポートされていない古いバージョンが存在します。 それらは引き続き使用可能ですが、最新バージョンの使用を強く推奨します。 変更履歴は以下のとおりです。
- バージョン2－配列を返すよう結果を変更
- バージョン3－64ビットの数値形式の文字列に変更
- バージョン4－ゲーム内マイクロトランザクションアイテムを参照するストアでのDLCの販売情報を返すための
storepurchasereferenceセクションを追加
- バージョン5－不正購入等が許可を得ていない購入の疑いのある取引に反映するため、新規にステータス値を追加。
応答： -
応答
-
result－呼び出しの結果 （OKまたはFailure）
-
params
-
timecreated－取引時間（RFC 3339 UTC形式、例：2010-01-01T00:00:00Z）
-
orderid－注文固有の64ビットID。 （これはSteamストアで開始した定期サブスクリプションの場合は0になるため、代わりにtransidを使用してください。）
-
transid－固有の64ビットのSteam取引ID
-
steamid－注文/取引を行うユーザーのSteam ID
-
status－注文のステータスです。 詳細は次のドキュメントを参照してください：付録A：ステータスの値
-
currency－ISO 4217通貨コード
-
time－取引が最後に更新された時間 （RFC 3339 UTCフォーマット例：2010-01-01T00:00:00Z）
-
country－ISO 3166-1-alpha-2の国名コード
-
usstate－米国の州 （米国以外の国の場合は空欄）
-
items
-
itemid－アイテムのゲームID番号
-
qty－アイテムの数量
-
amount－ユーザーの合計からVAT（セント）差し引いた額 （199＝1.99）
-
vat－VATまたは税金の合計（セント単位） （19＝.19）
-
itemstatus－注文内のアイテムのステータス
-
storepurchasereference －任意、ゲーム内マイクロトランザクションアイテムIDと関連したストア経由でDLCが販売された場合にのみ返されます
-
packageid－ストアで購入されたDLCパッケージ
-
bundleid－該当する場合、DLCパッケージと関連付けられたバンドルのID
-
referenceid－パッケージと関連するSteam生成のラインアイテムの参照ID
-
amount－ユーザーが支払う金額
-
vat－該当する場合、購入に適用されるVAT税
-
currency－購入に使用された通貨
-
error －省略可能。 結果がFailureの場合のみ返されます。
-
errorcode－エラーまたはイベントコード。 詳細は次のドキュメントを参照してください：付録B：エラーコード
-
errordesc－エラーまたはイベントへのメッセージ
応答の例：{
"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/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー |
| steamid | uint64 | ✔ | クライアントのSteam ID |
| appid | uint32 | ✔ | 契約の対象となるゲームのApp ID |
すべての支払契約（サブスクリプション）の詳細情報を取得します。
注： この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
バージョン2 －Steamがユーザーに契約料金を請求していない場合、ステータス値が「processing（処理中）」になることがあります。 以前まで、ステータス値は「active（アクティブ）」でした。
応答： -
response
-
result－呼び出しの結果 （OKまたはFailure）
-
params
-
agreements
-
agreement
-
agreementid－固有の64ビットSteam課金契約ID
-
itemid－アイテムのゲームID番号
-
status－Active（アクティブ）、canceled（キャンセル）、processing（処理中）。
-
period－契約期間
-
frequency－契約の間隔
-
startdate－定期支払プロセスを開始する日付です。 形式は、YYYYMMDDです。
-
enddate－定期支払プロセスを終了する日付です。 形式は、YYYYMMDDです。
-
recurringamt－定期的に請求する金額（単位はセント）。
-
currency－価格のISO 4217通貨コード
-
timecreated－YYYYMMDD形式で契約が作成された日付。
-
lastpayment－YYYYMMDD形式で最後の支払が成功した日付。
-
lastpayment－最後の成功した支払金額（単位はセント）。
-
nextpayment－YYYYMMDD形式で次回予定されている支払日。
-
outstanding－現在の未払残高（単位はセント）。
-
failedattempts－未払残高に対して失敗した請求の回数。
-
error －省略可能。 結果がFailureの場合のみ返されます。
-
errorcode－エラーまたはイベントコード。 詳細は次のドキュメントを参照してください： 付録B：エラーコード
-
errordesc－エラーまたはイベントへのメッセージ
GetUserInfo
GET https://partner.steam-api.com/ISteamMicroTxn/GetUserInfo/v2/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー |
| appid | uint32 | ✔ | ユーザーが購入するゲームのAppID |
| steamid | uint64 | | 購入を行うユーザーのSteam ID |
| ipaddress | string | | 文字列形式のユーザーのIPアドレス（xxx.xxx.xxx.xxx） InitTxnでusersessionがwebに設定されている場合にのみ必要です。 |
ユーザーの購入情報の詳細を取得します。
これらの詳細はユーザーのSteamウォレットに基づいています。
新しいアカウントやSteamウォレットをまだ持っていないアカウントの場合、ユーザーのIPアドレスに基づいた情報が返されます。 IPアドレスは、ユーザーがログインしている場合、ユーザーのSteamクライアントセッションから取得され、ログインしていない場合、ipaddress APIパラメーターから取得されます。 ユーザーがウォレットを持っていない場合や、Steamクライアントを通してログインしていない場合、またはIPアドレスが指定されていない場合、この呼び出しはユーザーがログインしていないことを示すエラーを返します。
このメソッドには、現在公式にはサポートされていない古いバージョンが存在します。 今後も引き続き使用可能ですが、最新バージョンの使用を強く推奨します。
変更履歴は以下のとおりです。
注： この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
応答： -
response
-
result－呼び出しの結果 （OKまたはFailure）
-
params
-
state－米国の州 （米国以外の国の場合は空欄）
-
country－ISO 3166-1-alpha-2の国名コード
-
currency－価格のISO 4217通貨コード
-
status－アカウントのステータス。 可能な値：
• Locked from purchasing－購入不可
• Active－デフォルトのアカウントのステータス
• Trusted－チャージバックが無く、90日より前に購入歴があるアクティブなアカウント
-
error －省略可能。 結果がFailureの場合のみ返されます。
-
errorcode－エラーまたはイベントコード。 詳細は次のドキュメントを参照してください：付録B：エラーコード
-
errordesc－エラーまたはイベントへのメッセージ
応答の例：<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/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー |
| orderid | uint64 | ✔ | 注文固有の64ビットID |
| steamid | uint64 | ✔ | 購入を行うユーザーのSteam ID |
| appid | uint32 | ✔ | この取引を行うゲームの App ID |
| itemcount | uint32 | ✔ | カート内のアイテム数 |
| language | string | ✔ | アイテムの説明のISO 639-1言語コード。 公式サポートされた28のSteam言語でのみ機能します。 サポート言語はこちらです。 |
| currency | string | ✔ | ISO 4217通貨コード。 各通貨の適切なフォーマットについては、対応通貨を参照してください。 |
| usersession | string | | ユーザーが取引を承認するセッションです。 有効なオプションは、「client」または「web」です。 このパラメータが指定されていない場合、インターフェイスは現在ログイン中のSteamクライアントセッションを介しているとみなします。 |
| ipaddress | string | | 文字列形式のユーザーのIPアドレス（xxx.xxx.xxx.xxx）。 [param]usersession[/param]がwebに設定されている場合にのみ必要です。 |
| itemid[0] | uint32 | ✔ | アイテムのサードパーティーID |
| qty[0] | int16 | ✔ | このアイテムの数量 |
| amount[0] | int64 | ✔ | この時点で請求されるアイテムの総額（単位はセント）。 各金額の適切なフォーマットについては、対応通貨を参照してください。 amountは指定の"currency"コードと同じフォーマットで渡す必要があります。 |
| description[0] | string | ✔ | アイテムの説明。 最長128文字。 |
| category[0] | string | | アイテムがグループされているカテゴリのテキスト説明（オプション）。 この値は、バックエンドのSteamレポートで販売データをグループ化するのに使用され、ユーザーに表示されることはありません。 最長64文字。 |
| associated_bundle[0] | uint32 | | 任意の関連するバンドルのbundleid |
| billingtype[0] | string | | 定期的な請求タイプ（オプション）。 有効なオプション：「Steam」または「Game」
- Steam：Steamが自動で再請求
- Game：請求するにはゲーム側がProcessAgreement APIを呼び出す必要があります
|
| startdate[0] | string | | 定期的請求の開始日（オプション）（RFC 3339 UTC形式、例：2010-01-01T00:00:00Z） |
| enddate[0] | string | | 定期的請求の終了日（オプション）（RFC 3339 UTC形式、例：2010-01-01T00:00:00Z） |
| period[0] | string | | 定期的請求の期間（オプション）。 任意のオプション：「Day」「Week」「Month」「Year」 |
| frequency[0] | uint32 | | 定期的請求の頻度（単位は日）（オプション）。 サポートされている値： 1～255 |
| recurringamt[0] | int64 | | 将来の定期的な請求トランザクションに対して請求されるオプションの金額 |
| bundlecount | uint32 | | カート内のバンドルの数量 |
| bundleid[0] | uint32 | | バンドルのサードパーティーID。 サードパーティー製アイテムと同じID空間を共有します。 |
| bundle_qty[0] | uint32 | | このバンドルの数量 |
| bundle_desc[0] | string | | バンドルの説明。 最長128文字。 |
| bundle_category[0] | string | | バンドルがグループされているカテゴリのテキスト説明（オプション）。 この値は、バックエンドのSteamレポートで販売データをグループ化するのに使用され、ユーザーに表示されることはありません。 最長64文字。 |
新しい購入を作成します。 Steam上で取引を確認するために、注文情報をSteam IDと共に送信します。
このコマンドを使用すると、ユーザーに1つ以上のアイテムを含むショッピングカートを作成できます。 これらのアイテムの価格と説明は、確認のためにユーザーに表示されます。 購入インタフェースは、ゲーム内での購入なのか、Webページからの購入なのかに応じて、SteamクライアントかWebブラウザーのいずれかに設定できます。
通貨／金額のフォーマット
特定の通貨は、特定の単位での請求が必要があることに注意してください。 たとえば、ウクライナのグリブナ（UAH）は100単位で請求する必要があります。 そのため、価格を1050 UAHに設定するとInitTxnは失敗し、k_EMicroTxnResultInvalidParamというエラーが返されます。 価格設定の要件に関するリストは、
対応通貨を参照してください。
各取引の価格をユーザーの現地通貨で設定したくない場合、Steamは、現行の為替レートに基づいて、すべての購入をユーザーのウォレット現地通貨に自動的に換算できます。 たとえば、
currencyを「USD」、
amountを「999」として渡した場合、現在の為替レート$9.99に基づき、ロシアのユーザーは、この執筆時点の価格で614.90 pуб（ルーブル）で請求されます。 ただし、顧客に表示される取引の確認ダイアログには、事前に指定した価格と通貨が表示され、換算は取引が完了すると行われます。 上記の例では、ロシアの顧客の確認ダイアログには「USD $9.99」という価格が表示されますが、取引が確定するときには、「614.90 pуб（ルーブル）」が請求されます。 定期的に取引を行うことが予想される顧客の通貨に合わせたカスタム価格を設定することを推奨します。
amountは指定の
currencyコードと同じフォーマットで渡す必要があります。
このコマンドへの正常な応答は、取引が作成されたことを意味します。 Steamクライアントが購入インターフェイスの場合、購入の承認要求ダイアログがユーザーに自動的に表示されます。 Webインターフェイスの場合、応答内で返されたSteam URLにリダイレクトされます。 タイムアウトまたはその他の通信エラーの場合は、その取引を放棄して新しい取引を作成します。
「client」でのユーザーセッションが、[param]usersession[/param]経由で表示された場合、ユーザーはクライアントのゲームオーバーレイ内から取引を承認する必要があります。 Webセッションでは、取引と承認オプションを表示するために、ユーザーはブラウザー経由でSteamにログインする必要があります。
このメソッドには、現在公式にはサポートされていない古いバージョンが存在します。 今後も引き続き使用可能ですが、最新バージョンの使用を強く推奨します。
変更履歴は以下のとおりです。
このメソッドには、現在公式にはサポートされていない古いバージョンが存在します。 今後も引き続き使用可能ですが、最新バージョンの使用を強く推奨します。
変更履歴は以下のとおりです。
注： この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
応答： -
response
-
result－呼び出しの結果 （OKまたはFailure）
-
params
-
orderid－注文固有の64ビットID
-
transid－固有の64ビットのSteam取引ID
-
steamurl－usersession入力がwebに設定されている際に返される任意のURL。 このURLはユーザーが取引を承認できるよう、ユーザーのWebセッションをSteamへリダイレクトするために使用できます。
-
agreements－請求タイプが定期支払の場合の、任意の契約のリスト
-
error －省略可能。 結果がFailureの場合のみ返されます。
-
errorcode－エラーまたはイベントコード。 詳細は次のドキュメントを参照してください：付録B：エラーコード
-
errordesc－エラーまたはイベントへのメッセージ
応答の例：<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/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー |
| orderid | uint64 | ✔ | 注文固有の64ビットID。 定期サブスクリプションがSteamストアから開始された場合、このフィールドは0になります。 |
| steamid | uint64 | ✔ | クライアントのSteam ID |
| agreementid | uint64 | ✔ | 固有の64ビットSteam課金契約ID |
| appid | uint32 | ✔ | 契約を結ぶゲームのApp ID |
| amount | int32 | ✔ | 合計（セント単位）。
この値はユーザーに直ちに課金される初回請求額と一致しています。 |
| currency | string | ✔ | 価格のISO 4217通貨コード |
ユーザーの定期支払（サブスクリプション）を開始します。
応答が成功の場合は、Steamがユーザーに対して請求サイクルを開始することを意味します。 これは、実際の請求サイクルが正しく完了したことを示すものではありません。 実際の請求ステータスを確認するには、
GetReport APIまたは
GetUserAgreementInfo APIを使用してください。
注： この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
応答： -
response
-
result－呼び出しの結果 （OKまたはFailure）
-
params
-
orderid－注文固有の64ビットID
-
transid－固有の64ビットのSteam取引ID
-
agreementid－固有の64ビットSteam課金契約ID
-
error －省略可能。結果がFailureの場合のみ返されます。
-
errorcode－エラーまたはイベントコード。 詳細は次のドキュメントを参照してください：付録B：エラーコード
-
errordesc－エラーまたはイベントへのメッセージ
QueryTxn
GET https://partner.steam-api.com/ISteamMicroTxn/QueryTxn/v3/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー |
| appid | uint32 | ✔ | この取引を行うゲームのApp ID |
| orderid | uint64 | | 注文固有の64ビットID |
| transid | uint64 | | 固有の64ビットSteam取引ID |
以前に
InitTxnで作成された注文のステータスを照会します。
このメソッドには、現在公式にはサポートされていない古いバージョンが存在します。 今後も引き続き使用可能ですが、最新バージョンの使用を強く推奨します。
変更履歴は以下のとおりです。
- バージョン2－64ビットの数値形式の文字列に変更
- バージョン3－不正購入等が許可を得ていない購入の疑いのある取引に反映するため、新規にステータス値を追加。
注： この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
応答： -
response
-
result－呼び出しの結果 （OKまたはFailure）
-
params
-
orderid－注文固有の64ビットID
-
transid－固有の64ビットのSteam取引ID
-
steamid－注文／取引を行うユーザーのSteam ID
-
status－注文のステータス。 詳細は次のドキュメントを参照してください：付録A：ステータスの値
-
currency－ISO 4217通貨コード
-
time－取引の時間（RFC 3339 UTC形式の例：2010-01-01T00:00:00Z）
-
country－ISO 3166-1-alpha-2の国名コード
-
usstate－米国の州 （米国以外の国の場合は空欄）
-
items
-
itemid－アイテムのゲームID番号
-
qty－アイテムの数量
-
amount－ユーザーの合計からVAT（セント単位）を差し引いた額 （199＝1.99）
-
vat－VATまたは税金の合計（セント単位） （19＝.19）
-
itemstatus－注文内のアイテムのステータス
-
error －省略可能。結果がFailureの場合のみ返されます。
-
errorcode－エラーまたはイベントコード。 詳細は次のドキュメントを参照してください：付録B：エラーコード
-
errordesc－エラーまたはイベントへのメッセージ
応答の例：<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/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー |
| orderid | uint64 | ✔ | 返金を行う注文の固有の64ビットID |
| appid | uint32 | ✔ | ゲームのApp ID |
ユーザーに購入代金を返金するようSteamに指示します。 返金は、元の注文の全額に対してのみ可能です。
このメソッドには、現在公式にはサポートされていない古いバージョンが存在します。 今後も引き続き使用可能ですが、最新バージョンの使用を強く推奨します。
変更履歴は以下のとおりです。
注： この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
応答： -
response
-
result－呼び出しの結果 （OK または Failure）
-
params
-
orderid－注文固有の64ビットID
-
transid－固有の64ビットのSteam取引ID
-
error －省略可能。 結果がFailureの場合のみ返されます。
-
errorcode－エラーまたはイベントコード。 詳細は次のドキュメントを参照してください： 付録B：エラーコード
-
errordesc－エラーまたはイベントへのメッセージ
応答の例：<response>
<result>OK</result>
<params>
<orderid>938474</orderid>
<transid>374839</transid>
</params>
</response>
