コンテンツへスキップ
/
保存された決済アカウントの一覧

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コールは、3-Dセキュア機能を持たないテストカードでのみ機能します。

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

プロジェクトID。

user_idstring必須

プレイヤー側に保存されているゲーム内の一意のユーザーID。必ず既存のユーザーIDを渡してください。エラーが発生した場合は、よくある質問への回答を参照してください。

クエリ
modestring

支払い処理をテストするには、sandboxに設定します。実際の決済用を行うためにパラメータを削除します。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/pay-station/projects/{project_id}/users/{user_id}/payment_accounts?mode=string'

レスポンス

OK。

ボディapplication/json
レスポンス
application/json
[
  {
    "id": 4612345,
    "name": "PP_saved_account",
    "payment_system": { … },
    "type": "paypal"
  }
]

保存された決済アカウントの削除

リクエスト

保存済みの決済アカウントを削除します。

メモ

サンドボックスモードでは、このAPIコールは、3-Dセキュア機能を持たないテストカードでのみ機能します。

メモ

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

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

プロジェクトID。

user_idstring必須

プレイヤー側に保存されているゲーム内の一意のユーザーID。必ず既存のユーザーIDを渡してください。エラーが発生した場合は、よくある質問への回答を参照してください。

typestring必須

決済アカウントの種類。

列挙型 値説明
alipayplus_boost

Boost。

alipayplus_cn

Alipay（アリペイ）。

alipayplus_dana

DANA。

alipayplus_gcash

GCash。

alipayplus_hk

Alipay (Hong Kong)（アリペイ香港）。

alipayplus_kplus

K PLUS。

alipayplus_maya

Maya。

alipayplus_rabbitlinepay

Rabbit LINE Pay（ラビットラインペイ）。

alipayplus_tng

Touch 'n Go。

alipayplus_truemoney

TrueMoney ウォレット。

account_idinteger必須

エクソーラデータベースに保存されたアカウントのID。

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/pay-station/projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}'

レスポンス

No Content.

保存されたアカウントで課金する

リクエスト

保存された決済アカウントを介してユーザーに請求する。

メモ

サンドボックスモードでは、このAPIコールは、3-Dセキュア機能を持たないテストカードでのみ機能します。

通知

APIコールが正しく機能するように、タイムアウトを2分に設定します。

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

プロジェクトID。

user_idstring必須

プレイヤー側に保存されているゲーム内の一意のユーザーID。必ず既存のユーザーIDを渡してください。エラーが発生した場合は、よくある質問への回答を参照してください。

typestring必須

決済アカウントの種類。

列挙型 値説明
alipayplus_boost

Boost。

alipayplus_cn

Alipay（アリペイ）。

alipayplus_dana

DANA。

alipayplus_gcash

GCash。

alipayplus_hk

Alipay (Hong Kong)（アリペイ香港）。

alipayplus_kplus

K PLUS。

alipayplus_maya

Maya。

alipayplus_rabbitlinepay

Rabbit LINE Pay（ラビットラインペイ）。

alipayplus_tng

Touch 'n Go。

alipayplus_truemoney

TrueMoney ウォレット。

account_idinteger必須

エクソーラデータベースに保存されたアカウントのID。

ボディapplication/json必須
custom_parametersobject(custom_parameters)

このオブジェクトには、不正対策フィルターを設定するためのパラメータが含まれています。パラメータのリストを以下に示します。カスタムパラメータを追加するには、カスタマーサクセスマネージャーにご連絡いただくか、csm@xsolla.comまで電子メールをお送りください。

purchaseobject

購入の詳細を含むオブジェクト。

settingsobject

購入設定（オブジェクト）。

userobject

ユーザー詳細。

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/pay-station/projects/{project_id}/users/{user_id}/payments/{type}/{account_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "purchase": {
      "description": {
        "value": "currency purchase"
      },
      "virtual_currency": {
        "quantity": 100
      }
    },
    "settings": {
      "currency": "USD",
      "external_id": "ext123",
      "mode": "sandbox"
    },
    "user": {
      "ip": "111.11.11.11",
      "legal": {
        "address": "17 Crown Street London SW2 0JW United Kingdom",
        "country": "GB",
        "name": "My Awesome Company",
        "vat_id": "GB111111111"
      },
      "name": "John Smith"
    }
  }'

レスポンス

作成済み。

ボディapplication/json
transaction_idinteger
レスポンス
application/json
{
  "transaction_id": 123458390
}

レポート

操作

払い戻し

操作

テスト

操作