コンテンツへスキップ

Pay Station API (2.0)

概要

  • バージョン: 2.0.0
  • サーバー:
    • https://api.xsolla.com/api

ペイステションは、ゲームストアでのゲーム内課金に便利なUIをユーザーに提供することで、パートナー様の商品を収益化することができます。決済UIを開くための設定は、 以下の説明書を参照してください。

Pay Station APIは以下のコールグループを提供します：

  • トークン — 決済UIを介したさらなる支払い処理のために、任意のユーザーパラメータを使用してトークンを生成するAPIコールが含まれています。
  • トークン化 — 決済UIを開いたりユーザーの関与を必要とせずに、支払いを安全に処理するためのAPIコールが含まれています。
  • レポート — ユーザーのトランザクションに関するデータを返し、レポートを生成し、通貨別の決済内訳を取得するためのAPIコールが含まれています。
  • 返金 — 全額および一部返金をリクエストするためのAPIコールが含まれています。
  • テスト — チャージバック処理をテストするためのAPIコールが含まれています。

決済UIの設定に関する詳細情報は、支払ソリューション連携ガイドを参照してください。

メモ

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

OpenAPI記述をダウンロード
index.json
index.yaml
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/pay-station/
https://api.xsolla.com/merchant/v2/

トークン

操作

トークン化

操作

レポート

操作

払い戻し

操作

一部返金

リクエスト

一部返金のリクエストをユーザーに送信します。一部返金をサポートする返金プロセスと決済方法の詳細については、ドキュメンテーションを参照してください。

メモ

このAPIメソッドはサンドボックスモードで呼び出すことができます。そのためには、リクエストの中でテスト用の決済データを渡します。サンドボックスモードのアクセス方法とテストシナリオの詳細については、説明を参照してください。

通知

APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

セキュリティ
basicAuth
パス
merchant_idinteger必須

マーチャントID。

transaction_idinteger必須

トランザクションID。

ボディapplication/json必須
descriptionstring<= 4000 characters必須

返金の理由。

refund_amountnumber(float)必須

購入通貨での返金額。

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/partial_refund' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "test refund request",
    "refund_amount": 1.5
  }'

レスポンス

返金リクエストを受け付けました

レスポンス
コンテンツなし

全額返金

リクエスト

ユーザーに支払いを返却するための返金リクエストを送信します。処理の詳細については、返金機能をお読みください。

メモ

このAPIメソッドはサンドボックスモードで呼び出すことができます。そのためには、リクエストの中でテスト用の決済データを渡します。サンドボックスモードのアクセス方法とテストシナリオの詳細については、説明を参照してください。

通知

APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

セキュリティ
basicAuth
パス
merchant_idinteger必須

マーチャントID。

transaction_idinteger必須

トランザクションID。

ボディapplication/json必須
descriptionstring<= 4000 characters必須

返金の理由。

emailstring<= 100 characters

ユーザーのEメール。

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/refund' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "test refund request"
  }'

レスポンス

OK（エラーなし）。

ボディapplication/json
messagestring

以下のいずれかのメッセージを返すことができます：

  • No content.
  • The request for a refund has been accepted. Xsolla CS will manually complete the refund. It may take up to two business days.
  • The request for a refund has been accepted. Xsolla CS will automatically send the customer an email with alternative refund options as the user's method does not support direct refunds.
レスポンス
application/json
{
  "message": "The request for a refund has been accepted. Xsolla CS will automatically send the customer an email with alternative refund options as the user's method does not support direct refunds."
}

テスト

操作