# Pay Station API # 概要 {% #overview %} * **バージョン:** 2.0.0 * **サーバー**: * `https://api.xsolla.com/api` ペイステションは、ゲームストアでのゲーム内課金に便利なUIをユーザーに提供することで、パートナー様の商品を収益化することができます。決済UIを開くための設定は、 以下の[説明書](/ja/doc/pay-station/how-to/how-to-open-payment-ui/)を参照してください。 Pay Station APIは以下のコールグループを提供します： - トークン — 決済UIを介したさらなる支払い処理のために、任意のユーザーパラメータを使用してトークンを生成するAPIコールが含まれています。 - [トークン化](/ja/doc/pay-station/features/tokenization/) — 決済UIを開いたりユーザーの関与を必要とせずに、支払いを安全に処理するためのAPIコールが含まれています。 - レポート — ユーザーのトランザクションに関するデータを返し、レポートを生成し、通貨別の決済内訳を取得するためのAPIコールが含まれています。 - 返金 — 全額および一部返金をリクエストするためのAPIコールが含まれています。 - テスト — チャージバック処理をテストするためのAPIコールが含まれています。 決済UIの設定に関する詳細情報は、[支払ソリューション連携ガイド](/ja/solutions/payments/integration-guide/integration-flow/)を参照してください。

注意

ポストマンコレクションのXsolla Base APIセクションを参照して、連携に使われるAPIコールをテストすることもできます。

Version: 2.0 ## Servers ``` https://api.xsolla.com/merchant/v2 ``` ## Security ### basicAuth エクソラAPIはベーシックアクセス認証を使用します。APIへのすべてのリクエストは`Authorization: Basic `ヘッダーを含む必要があり、``はBas e64標準に従ってエンコードされた`merchant_id:api_key`ペアです。 [パブリッシャーアカウント](https://publisher.xsolla.com/)に移動して、次のパラメータを見つけます： - `merchant_id`が表示されます： - **会社設定 > 会社**セクションで。 - 任意のパブリッシャーアカウントページのブラウザアドレスバーにあるURL。URLは以下の形式です：`https://publisher.xsolla.com/`。 - `api_key`は、作成時に一度だけパブリッシャーアカウントページに表示され、お客様側で保存する必要があります。新しいキーは、次のセクションで作成することがで きます： - **会社設定 > APIキー** - **プロジェクト設定 > APIキー** API キーの操作に関する詳細は、[APIリファレンス](https://developers.xsolla.com/ja/api/getting-started/#api_keys_overview)を参照してください。 Type: http Scheme: basic ## Download OpenAPI description [Pay Station API](https://xsolla.redocly.app/_bundle/@l10n/ja/api/pay-station/index.yaml) ## トークン ### トークンを作成する - [POST /merchants/{merchant_id}/token](https://xsolla.redocly.app/ja/api/pay-station/token/create-token.md): 任意のユーザーパラメータを持つトークンを作成することができます。トークンを取得する際にこれらのパラメータを送信し、決済が成功した後にパラメータを受信します。トー クンには、このドキュメントで説明されているか、ユーザーが事前定義したパラメータのみを含めることができます。 パラメータが間違った形式で送信された場合、またはタイプが間違っている場合、トークンは発行されません。JSON本文にエラーの説明が含まれる 422 HTTP コードを受け取ります。extended_messageでは、どのようなパラメータが不正に送信されたかという情報が表示されます。 デフォルトでは、トークンの有効期間は24時間です。この値を変更したい場合は、カスタマー・サクセス・マネージャーに連絡するか、csm@xsolla.comにメールを送信してください。アドミンページで作成された会社のすべてのプロジェクトに対して、新しい値が有効に なります。 通知このAPIメソッドを呼び出した後に取得したトークンは、他のリクエストの認証にのみ使用することができます。サブスクリプション製品を統合した場合にのみ、このトークンを使用して決済UIを開くことができます。決済UIを新しいウィンドウで開くには、以下のリンクをご利用ください：https://secure.xsolla.com/paystation4/?token={token}で{token} 受信したトークン。テスト目的には、以下のリンクを使用してください：https://sandbox-secure.xsolla.com/paystation4/?token={token}。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 無効なトークン - [POST /projects/{project_id}/token/{token}/expire](https://xsolla.redocly.app/ja/api/pay-station/token/invalidate-token.md): 既存の決済トークンを無効化し、当該トークンによる決済UIの起動を防ぎます。並行セッション間における単一インスタンスアイテムの重複決済を回避する目的で使用されます 。呼び出しに成功すると、この決済トークンによって開かれた他のすべてのユーザーセッションは有効期限切れとなります。 注意このAPIコールは冪等であり、複数回実行することができます。 ## トークン化 ### 保存された決済アカウントの一覧 - [GET /projects/{project_id}/users/{user_id}/payment_accounts](https://xsolla.redocly.app/ja/api/pay-station/tokenization/get-saved-accounts.md): 特定のユーザーの保存された決済アカウントを一覧表示します。 メモサンドボックスモードでは、このAPIコールは、3-Dセキュア機能を持たないテストカードでのみ機能します。 ### 保存された決済アカウントの削除 - [DELETE /projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}](https://xsolla.redocly.app/ja/api/pay-station/tokenization/delete-saved-account.md): 保存済みの決済アカウントを削除します。 メモサンドボックスモードでは、このAPIコールは、3-Dセキュア機能を持たないテストカードでのみ機能します。 メモこのAPIメソッドはサンドボックスモードで呼び出すことができます。そのためには、リクエストの中でテスト用の決済アカウントデータを渡します。サンドボックスモードのアクセス方法とテストシナリオの詳細については、説明を参照してください。 ### 保存されたアカウントで課金する - [POST /projects/{project_id}/users/{user_id}/payments/{type}/{account_id}](https://xsolla.redocly.app/ja/api/pay-station/tokenization/charge-with-saved-account.md): 保存された決済アカウントを介してユーザーに請求する。 メモサンドボックスモードでは、このAPIコールは、3-Dセキュア機能を持たないテストカードでのみ機能します。 通知APIコールが正しく機能するように、タイムアウトを2分に設定します。 ## レポート ### レポートの一覧 - [GET /merchants/{merchant_id}/reports](https://xsolla.redocly.app/ja/api/pay-station/reports/get-reports.md): 指定した期間の財務レポートのリストを取得します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 取引履歴を取得する - [GET /merchants/{merchant_id}/reports/transactions/registry.{format}](https://xsolla.redocly.app/ja/api/pay-station/reports/get-transactions.md): 指定した期間のトランザクションの成功とキャンセルに関する詳細情報のリストを返します。 これに応じて、手数料、税金、注文、ユーザーに関するデータなど、支払いに関する情報を取得します。 JSONまたはCSV形式でリストを取得できます。このAPIコールを使用して、財務照合を実行できます。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### トランザクションを検索する - [GET /merchants/{merchant_id}/reports/transactions/search.{format}](https://xsolla.redocly.app/ja/api/pay-station/reports/find-transactions.md): 特定の検索パラメータに基づくトランザクションのリストを返します。これに応じて、ゲーム内で行われたすべての支払いに関するデータが取得されます。トランザクション期間 だけでなく、他のパラメータも指定できます。特定のユーザーまたは特定の支払いステータスによって行われたトランザクションを検索します。JSONまたはCSV形式でリス トを取得することができます。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### トランザクションを検索する（高速検索） - [GET /merchants/{merchant_id}/reports/transactions/simple_search](https://xsolla.redocly.app/ja/api/pay-station/reports/find-transactions-fast.md): 数秒以内に特定の検索パラメータに基づくトランザクションのリストを取得します。これは、JSON、CSV、またはXLS形式のデータを返す[トランザクションを探す]( /api/pay-station/operation/find-transactions/) APIコールの代替となるものです。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 支払いの内訳を通貨で取得する - [GET /merchants/{merchant_id}/reports/transactions/summary/transfer](https://xsolla.redocly.app/ja/api/pay-station/reports/get-payouts-breakdown.md): ペイアウトの内訳を通貨で取得します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### トランザクションの取得 - [GET /merchants/{merchant_id}/reports/transactions/{transaction_id}/details](https://xsolla.redocly.app/ja/api/pay-station/reports/get-transaction.md): IDでトランザクションの全情報を取得します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 配当の一覧 - [GET /merchants/{merchant_id}/reports/transfers](https://xsolla.redocly.app/ja/api/pay-station/reports/get-payouts.md): 一定期間のすべてのペイアウトを一覧表示します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ## 払い戻し ### 一部返金 - [PUT /merchants/{merchant_id}/reports/transactions/{transaction_id}/partial_refund](https://xsolla.redocly.app/ja/api/pay-station/refund/request-partial-refund.md): 一部返金のリクエストをユーザーに送信します。一部返金をサポートする返金プロセスと決済方法の詳細については、ドキュメンテーションを参照してください。 メモこのAPIメソッドはサンドボックスモードで呼び出すことができます。そのためには、リクエストの中でテスト用の決済データを渡します。サンドボックスモードのアクセス方法とテストシナリオの詳細については、説明を参照してください。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 全額返金 - [PUT /merchants/{merchant_id}/reports/transactions/{transaction_id}/refund](https://xsolla.redocly.app/ja/api/pay-station/refund/request-refund.md): ユーザーに支払いを返却するための返金リクエストを送信します。処理の詳細については、返金機能をお読みください。 メモこのAPIメソッドはサンドボックスモードで呼び出すことができます。そのためには、リクエストの中でテスト用の決済データを渡します。サンドボックスモードのアクセス方法とテストシナリオの詳細については、説明を参照してください。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ## テスト ### チャージバックを要求する - [POST /merchants/{merchant_id}/projects/{project_id}/payments/{transaction_id}/chargeback](https://xsolla.redocly.app/ja/api/pay-station/testing/request-chargeback.md): サンドボックスモードでのチャージバックを要求する： - サンドボックスモードをアクセスするには、トークンを取得する時、"mode":"sandbox"を渡します。 - テスト支払いは、テストに使用するのと同じプロジェクトでサンドボックスモードで行う必要があります。 - 取引の状態は、refunded、cancelled以外でなければなりません。 - パブリッシャーアカウントでのあなたの役割は、少なくともファイナンシャルマネージャーである必要があります。(これは、会社設定 > ユーザー セクションで確認できます。) - このテストシナリオの詳細については、説明を参照してください。 メモこのテストシナリオの詳細については、ドキュメンテーションを参照してください。