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

メモ

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

\n
\n", "title": "Pay Station API", "version": "2.0" }, "servers": [ { "url": "https://api.xsolla.com/merchant/v2" } ], "tags": [ { "name": "token", "x-displayName": "トークン" }, { "name": "tokenization", "x-displayName": "トークン化" }, { "name": "reports", "x-displayName": "レポート" }, { "name": "refund", "x-displayName": "払い戻し" }, { "name": "testing", "x-displayName": "テスト" } ], "paths": { "/merchants/{merchant_id}/projects/{project_id}/payments/{transaction_id}/chargeback": { "post": { "description": "サンドボックスモードでのチャージバックを要求する：\n\n- サンドボックスモードをアクセスするには、[トークン](https://developers.xsolla.com/ja/api/pay-station/operation/create-token/)を取得する時、`\"mode\":\"sandbox\"`を渡します。\n\n- テスト支払いは、テストに使用するのと同じプロジェクトでサンドボックスモードで行う必要があります。\n\n- 取引の状態は、`refunded`、`cancelled`以外でなければなりません。\n\n- パブリッシャーアカウントでのあなたの役割は、少なくとも**ファイナンシャルマネージャー**である必要があります。(これは、**会社設定 > ユーザー** \n セクションで確認できます。)\n\n- このテストシナリオの詳細については、説明を参照してください。\n\n
\n

メモ

このテストシナリオの詳細については、ドキュメンテーションを参照してください。

\n
\n", "operationId": "request-chargeback", "parameters": [ { "$ref": "#/components/parameters/merchant-id-path-param" }, { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/transaction-id-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/empty-body" } } }, "required": true }, "responses": { "204": { "description": "No Content（エラーなし）。" }, "404": { "description": "取引が見つかりません。" }, "422": { "content": { "application/json": { "example": { "message": "Not test payment. Chargeback is possible only for payments made in sandbox mode." }, "schema": { "properties": { "message": { "description": "以下のいずれかのメッセージを返すことができます：\n- Error processing chargeback. Try again or use another payment.\n- Payment not found. Check payment ID.\n- Payment does not belong to this project.\n- Not test payment. Chargeback is possible only for payments made in sandbox mode.\n- Incorrect payment status. Chargeback is possible only for payments with “Completed” status.", "type": "string" } }, "type": "object" } } }, "description": "Unprocessable Entity（無効なリクエストパラメータ）。" } }, "security": [ { "basicAuth": [] } ], "summary": "チャージバックを要求する", "tags": [ "testing" ], "x-server": true } }, "/merchants/{merchant_id}/reports": { "get": { "description": "指定した期間の財務レポートのリストを取得します。\n\n
\n

通知

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

\n
\n", "operationId": "get-reports", "parameters": [ { "$ref": "#/components/parameters/merchant-id-path-param" }, { "$ref": "#/components/parameters/datetime-from-req" }, { "$ref": "#/components/parameters/datetime-to-req" } ], "responses": { "200": { "content": { "application/json": { "example": [ { "agreement_document_id": "Organization Inc_RUB", "currency": "RUB", "is_direct_payout": false, "is_draft_by_agreement": true, "month": "January", "report_id": 57613, "year": 2019 }, { "agreement_document_id": "Organization Inc_EUR", "currency": "USD", "is_direct_payout": false, "is_draft_by_agreement": true, "month": "January", "report_id": 57619, "year": 2019 } ] } }, "description": "OK。" } }, "security": [ { "basicAuth": [] } ], "summary": "レポートの一覧", "tags": [ "reports" ], "x-admin": true, "x-server": true } }, "/merchants/{merchant_id}/reports/transactions/registry.{format}": { "servers": [ { "url": "https://api.xsolla.com/merchant/v3" } ], "get": { "description": "指定した期間のトランザクションの成功とキャンセルに関する詳細情報のリストを返します。 \nこれに応じて、手数料、税金、注文、ユーザーに関するデータなど、支払いに関する情報を取得します。 \nJSONまたはCSV形式でリストを取得できます。このAPIコールを使用して、財務照合を実行できます。\n\n
\n

通知

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

\n
\n", "operationId": "get-transactions", "parameters": [ { "$ref": "#/components/parameters/merchant-id-path-param" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/datetime-from-req" }, { "$ref": "#/components/parameters/datetime-to-req" }, { "$ref": "#/components/parameters/in-transfer-currency" }, { "$ref": "#/components/parameters/show-total" }, { "$ref": "#/components/parameters/merchant-of-records" }, { "$ref": "#/components/parameters/project-id-query-param" }, { "$ref": "#/components/parameters/show-dry-run" }, { "$ref": "#/components/parameters/transfer-id" }, { "$ref": "#/components/parameters/report-id" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit-req" }, { "$ref": "#/components/parameters/transaction-status" } ], "responses": { "200": { "content": { "application/json": { "example": [ { "payment_details": { "chargebackPenalty": { "amount": 0 }, "commission_agent": { "amount": 0, "percent": 0 }, "commission_agent_fixed": 0, "commission_ps": { "amount": 0, "fixed_amount": 0, "percent": 0 }, "commission_ps_from_vat": { "amount": 0 }, "commission_user": { "amount": 0.01, "percent": 33.33 }, "commission_xsolla": { "amount": 0, "fixed_amount": 0, "percent": 5 }, "cpa_network_commission": { "amount": 0, "percent": 0 }, "direct_wht": { "amount": 0, "percent": 0 }, "payment": { "amount": 0.03, "amount_from_ps": 0, "currency": "USD" }, "payout": { "amount": 0.02, "amount_from_ps": 0, "currency": "RUB", "fx_rate": 64.1386407767, "percent": 100 }, "refundPenalty": { "amount": 0 }, "repatriation_costs": { "amount": 0, "percent": 0 }, "sales_tax": { "amount": 0, "percent": 0 }, "vat": { "amount": 0, "percent": 0, "user_amount": 0, "user_percent": 0 } }, "purchase": { "friend": { "email": null, "user_id": null }, "items_amount": 1, "pin_codes": { "amount": null, "content": null, "currency": null }, "purchase_amount": 0.02, "simple_checkout": { "amount": null, "currency": null }, "subscription": { "name": null, "plan_id": null, "product_id": null, "product_name": null, "subscription_id": null }, "virtual_currency": { "amount": 0.02, "currency": "USD" }, "virtual_currency_amount": 1, "virtual_items": { "amount": null, "content": null, "currency": null } }, "transaction": { "custom_parameters": null, "direct_account": 0, "dry_run": 0, "external_id": null, "id": 418756634, "payment_method": { "class": "Digital Payment Methods", "id": 2760, "name": "Your Balance" }, "project": { "id": 21092, "name": "Smith" }, "refund_reason": null, "refund_reason_comment": null, "status": "done", "transfer_date": "2019-02-11T13:32:00+03:00" }, "user": { "country": "US", "custom": null, "email": "email@example.com", "id": "smith123", "ip": "209.11.22.33", "marketplace": "Pay Station", "name": "Tom", "phone": null }, "user_balance": { "payment_currency": { "deduction_amount": 0, "payout_amount_from_balance": 0.02, "purchase_amount_from_balance": 0.02 } } } ], "schema": { "items": { "properties": { "payment_details": { "description": "支払詳細。", "properties": { "chargebackPenalty": { "properties": { "amount": { "format": "float", "type": "number" } }, "type": "object" }, "commission_agent": { "properties": { "amount": { "format": "float", "type": "number" }, "percent": { "format": "float", "type": "number" } }, "type": "object" }, "commission_agent_fixed": { "type": "integer" }, "commission_ps": { "properties": { "amount": { "format": "float", "type": "number" }, "fixed_amount": { "type": "integer" }, "percent": { "format": "float", "type": "number" } }, "type": "object" }, "commission_ps_from_vat": { "properties": { "amount": { "format": "float", "type": "number" } }, "type": "object" }, "commission_user": { "properties": { "amount": { "format": "float", "type": "number" }, "percent": { "format": "float", "type": "number" } }, "type": "object" }, "commission_xsolla": { "properties": { "amount": { "format": "float", "type": "number" }, "fixed_amount": { "type": "integer" }, "percent": { "format": "float", "type": "number" } }, "type": "object" }, "cpa_network_commission": { "properties": { "amount": { "format": "float", "type": "number" }, "percent": { "format": "float", "type": "number" } }, "type": "object" }, "direct_wht": { "properties": { "amount": { "format": "float", "type": "number" }, "percent": { "format": "float", "type": "number" } }, "type": "object" }, "payment": { "properties": { "amount": { "format": "float", "type": "number" }, "amount_from_ps": { "type": "integer" }, "currency": { "type": "string" } }, "type": "object" }, "payout": { "properties": { "amount": { "format": "float", "type": "number" }, "amount_from_ps": { "format": "float", "type": "number" }, "currency": { "type": "string" }, "fx_rate": { "format": "float", "type": "number" }, "percent": { "format": "float", "type": "number" } }, "type": "object" }, "refundPenalty": { "properties": { "amount": { "format": "float", "type": "number" } }, "type": "object" }, "repatriation_costs": { "properties": { "amount": { "format": "float", "type": "number" }, "percent": { "format": "float", "type": "number" } }, "type": "object" }, "sales_tax": { "properties": { "amount": { "format": "float", "type": "number" }, "percent": { "format": "float", "type": "number" } }, "type": "object" }, "vat": { "properties": { "amount": { "format": "float", "type": "number" }, "percent": { "format": "float", "type": "number" }, "user_amount": { "type": "integer" }, "user_percent": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "purchase": { "description": "購入内容。", "properties": { "friend": { "properties": { "email": { "nullable": true, "type": "string" }, "user_id": { "nullable": true, "type": "string" } }, "type": "object" }, "items_amount": { "type": "integer" }, "pin_codes": { "properties": { "amount": { "format": "float", "nullable": true, "type": "number" }, "content": { "nullable": true, "type": "string" }, "currency": { "nullable": true, "type": "string" } }, "type": "object" }, "purchase_amount": { "format": "float", "type": "number" }, "simple_checkout": { "properties": { "amount": { "format": "float", "nullable": true, "type": "number" }, "currency": { "nullable": true, "type": "string" } }, "type": "object" }, "subscription": { "properties": { "name": { "nullable": true, "type": "string" }, "plan_id": { "nullable": true, "type": "integer" }, "product_id": { "nullable": true, "type": "string" }, "product_name": { "nullable": true, "type": "string" }, "subscription_id": { "nullable": true, "type": "integer" } }, "type": "object" }, "virtual_currency": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" }, "virtual_currency_amount": { "type": "integer" }, "virtual_items": { "properties": { "amount": { "format": "float", "nullable": true, "type": "number" }, "content": { "nullable": true, "type": "string" }, "currency": { "nullable": true, "type": "string" } }, "type": "object" } }, "type": "object" }, "transaction": { "description": "取引データ。", "properties": { "custom_parameters": { "nullable": true, "type": "object" }, "direct_account": { "type": "integer" }, "dry_run": { "type": "integer" }, "external_id": { "nullable": true, "type": "string" }, "id": { "type": "integer" }, "payment_method": { "properties": { "class": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "project": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "refund_reason": { "nullable": true, "type": "string" }, "refund_reason_comment": { "nullable": true, "type": "string" }, "status": { "enum": [ "created", "processing", "done", "canceled", "error", "refunded", "partiallyRefunded", "awaitingRefund", "disputeFee" ], "type": "string" }, "transfer_date": { "format": "datetime", "type": "string" } }, "type": "object" }, "user": { "description": "ユーザー詳細。", "properties": { "country": { "description": "ユーザーの国。2文字の国コード（大文字）は、[ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従って使用されます。", "type": "string" }, "custom": { "nullable": true, "type": "string" }, "email": { "description": "ユーザーのEメール。", "type": "string" }, "id": { "description": "ユーザーID。", "type": "string" }, "ip": { "type": "string" }, "marketplace": { "type": "string" }, "name": { "description": "ユーザーのスクリーン名。", "type": "string" }, "phone": { "description": "ユーザーの電話番号。", "nullable": true, "type": "string" } }, "type": "object" }, "user_balance": { "description": "ユーザ残高。", "properties": { "payment_currency": { "description": "優先決済通貨。", "properties": { "deduction_amount": { "format": "float", "type": "number" }, "payout_amount_from_balance": { "format": "float", "type": "number" }, "purchase_amount_from_balance": { "format": "float", "type": "number" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "type": "array" } } }, "description": "取引リストは正常に返送されました。" } }, "security": [ { "basicAuth": [] } ], "summary": "取引履歴を取得する", "tags": [ "reports" ], "x-admin": true, "x-server": true } }, "/merchants/{merchant_id}/reports/transactions/search.{format}": { "get": { "description": "特定の検索パラメータに基づくトランザクションのリストを返します。これに応じて、ゲーム内で行われたすべての支払いに関するデータが取得されます。トランザクション期間\nだけでなく、他のパラメータも指定できます。特定のユーザーまたは特定の支払いステータスによって行われたトランザクションを検索します。JSONまたはCSV形式でリス\nトを取得することができます。\n\n
\n

通知

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

\n
\n", "operationId": "find-transactions", "parameters": [ { "$ref": "#/components/parameters/merchant-id-path-param" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/datetime-from" }, { "$ref": "#/components/parameters/datetime-to" }, { "$ref": "#/components/parameters/project-id-query-param" }, { "$ref": "#/components/parameters/transaction-id" }, { "$ref": "#/components/parameters/type" }, { "$ref": "#/components/parameters/phone" }, { "$ref": "#/components/parameters/user-id-query-param" }, { "$ref": "#/components/parameters/user-name" }, { "$ref": "#/components/parameters/user-custom" }, { "$ref": "#/components/parameters/email" }, { "$ref": "#/components/parameters/external-id" }, { "$ref": "#/components/parameters/order-id" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/status" } ], "responses": { "200": { "content": { "application/json": { "example": [ { "payment_details": { "payment": { "amount": 7.96, "amount_from_ps": 7.96, "currency": "RUB" }, "sales_tax": { "amount": 0, "percent": 0 } }, "payment_system": { "decline_reason": null }, "purchase": { "pin_codes": { "amount": null, "content": null, "currency": null }, "simple_checkout": { "amount": 7.96, "currency": "RUB" }, "subscription": { "name": null }, "virtual_currency": { "amount": 0, "name": null }, "virtual_items": null }, "transaction": { "create_date": "2021-10-20", "dry_run": 0, "external_id": "example-external-id", "id": 123456789, "is_refund_allowed": 0, "order_id": 1234, "payment_method": { "id": 1, "name": "PayPal" }, "project": { "id": 123456, "name": "Example" }, "refund_reason": null, "status": "done", "transfer_date": "2021-10-20" }, "user": { "country": "RU", "custom": null, "email": "email@example.com", "id": "example-id", "name": "Example", "phone": null } } ] } }, "description": "OK。" } }, "security": [ { "basicAuth": [] } ], "summary": "トランザクションを検索する", "tags": [ "reports" ], "x-admin": true, "x-server": true } }, "/merchants/{merchant_id}/reports/transactions/simple_search": { "get": { "description": "数秒以内に特定の検索パラメータに基づくトランザクションのリストを取得します。これは、JSON、CSV、またはXLS形式のデータを返す[トランザクションを探す](\n/api/pay-station/operation/find-transactions/) APIコールの代替となるものです。\n\n
\n

通知

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

\n
\n", "operationId": "find-transactions-fast", "parameters": [ { "$ref": "#/components/parameters/merchant-id-path-param" }, { "description": "トランザクションID。これまたは`external_id`のいずれかを指定する必要がありますが、両方を指定することはできません。", "in": "query", "name": "transaction_id", "schema": { "type": "integer" } }, { "description": "ゲームでのトランザクションID。これは支払いごとに異なります。これまたは`transaction_id`のいずれかを指定する必要がありますが、両方を指定することはできません。", "in": "query", "name": "external_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "payment_details": { "payment": { "amount": 7.96, "currency": "BRL" } }, "transaction": { "external_id": "example_external_id_123", "id": 123456, "payment_date": "2023-02-11 15:32:46", "project": { "id": 123456, "name": "Test" }, "status": "done" }, "user": { "country": "BR", "email": "email@example.com", "id": "123456", "name": "John Smith" } } ], "schema": { "items": { "properties": { "payment_details": { "description": "支払詳細。", "properties": { "payment": { "properties": { "amount": { "description": "支払金額。", "format": "float", "type": "number" }, "currency": { "description": "決済通貨。[ISO 4217](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)3文字通貨コード。", "type": "string" } }, "type": "object" } }, "type": "object" }, "transaction": { "description": "トランザクションの詳細。", "properties": { "external_id": { "description": "ゲーム内のトランザクションID。各ユーザーの支払いに対して一意です。", "type": "string" }, "id": { "description": "トランザクションID。", "type": "integer" }, "payment_date": { "description": "YY-MM-DD 形式の支払日。", "type": "string" }, "project": { "properties": { "id": { "description": "ゲームのエクソラID。パブリッシャ―アカウントにあります。", "type": "integer" }, "name": { "description": "プロジェクト名。", "type": "string" } }, "type": "object" }, "refund_reason": { "description": "返金の理由。", "type": "string" }, "status": { "$ref": "#/components/schemas/status.enum" } }, "type": "object" }, "user": { "description": "ユーザーの詳細（オブジェクト）。", "properties": { "country": { "description": "ユーザーの国。2文字の国コード（大文字）は、[ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従って使用されます。", "type": "string" }, "email": { "description": "ユーザーのEメール。", "type": "string" }, "id": { "description": "ユーザーID。", "type": "string" }, "name": { "description": "ユーザー名。", "type": "string" } }, "type": "object" } }, "type": "object" }, "type": "array" } } }, "description": "取引リストは正常に返送されました。" }, "403": { "description": "アクセスが拒否されました。" }, "404": { "description": "取引が見つかりません。" }, "422": { "description": "処理不能なエンティティ（`transaction_id`または`external_id`のいずれかをパスする必要があります）。" } }, "security": [ { "basicAuth": [] } ], "summary": "トランザクションを検索する（高速検索）", "tags": [ "reports" ], "x-admin": true, "x-server": true } }, "/merchants/{merchant_id}/reports/transactions/summary/transfer": { "get": { "description": "ペイアウトの内訳を通貨で取得します。\n\n
\n

通知

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

\n
\n", "operationId": "get-payouts-breakdown", "parameters": [ { "$ref": "#/components/parameters/merchant-id-path-param" }, { "$ref": "#/components/parameters/datetime-from" }, { "$ref": "#/components/parameters/datetime-to" }, { "$ref": "#/components/parameters/legal-entity-id" }, { "$ref": "#/components/parameters/transaction-status" } ], "responses": { "200": { "content": { "application/json": { "example": [ { "DirectTaxesOfPayments": 0.46, "IsoCurrency": "RUB", "PaymentsAmount": 223679.84, "SumCommissionAgent": 11329.58, "SumCommissionUserTaxes": 153.67, "SumItems": 571325.13, "SumNominalSum": 214792.98, "SumOutProject": 551096.13, "SumPayoutSum": 193316.71, "TaxesOfPayments": 171.56 }, { "DirectTaxesOfPayments": 0.14, "IsoCurrency": "USD", "PaymentsAmount": 482.58, "SumCommissionAgent": 77.51, "SumCommissionUserTaxes": 0.07, "SumItems": 243777.62, "SumNominalSum": 493.09, "SumOutProject": 241787.62, "SumPayoutSum": 462.62, "TaxesOfPayments": 0.14 }, { "DirectTaxesOfPayments": 0.07, "IsoCurrency": "EUR", "PaymentsAmount": 608.2, "SumCommissionAgent": 55.71, "SumCommissionUserTaxes": 90.94, "SumItems": 156238.62, "SumNominalSum": 607.26, "SumOutProject": 156158.62, "SumPayoutSum": 460.8, "TaxesOfPayments": 90.94 } ] } }, "description": "OK。" } }, "security": [ { "basicAuth": [] } ], "summary": "支払いの内訳を通貨で取得する", "tags": [ "reports" ], "x-admin": true, "x-server": true } }, "/merchants/{merchant_id}/reports/transactions/{transaction_id}/details": { "get": { "description": "IDでトランザクションの全情報を取得します。\n\n
\n

通知

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

\n
\n", "operationId": "get-transaction", "parameters": [ { "$ref": "#/components/parameters/merchant-id-path-param" }, { "$ref": "#/components/parameters/transaction-id-path-param" } ], "responses": { "200": { "content": { "application/json": { "example": [ { "customer_details": { "billing_address": "", "bin": "", "browser_language": "", "country": "US", "ip": "209.11.22.33", "paystation_country": "", "phone": null, "timezone": "", "user_id": "user1", "user_name": "John Smith" }, "finance_details": { "direct_wht": { "amount": 0, "currency": "USD" }, "dispute_fee": { "amount": 70, "currency": "USD", "date": "2019-04-20 16:15:37" }, "payment": { "amount": 0.04, "currency": "USD" }, "payment_method_fee": { "amount": 0.01, "currency": "USD" }, "payment_method_sum": { "amount": 0.04, "currency": "USD" }, "payout": { "amount": 1.25, "currency": "RUB" }, "payout_currency_rate": 62, "repatriation_commission": { "amount": 0, "currency": "USD" }, "sales_tax": { "amount": 0, "currency": "USD" }, "vat": { "amount": 0.01, "currency": "USD" }, "xsolla_balance_sum": { "amount": 0, "currency": "USD" }, "xsolla_fee": { "amount": 0, "currency": "USD" } }, "payment_details": { "card_holdername": null, "card_issuer": "TEST BANK", "card_month": 1, "card_number": 1234123412341234, "card_scheme": "MASTERCARD", "card_year": 2020, "customer_firstname": "", "customer_lastname": "", "enrollment": false, "ps_account": "1234test4321", "zip_code": "" }, "subscription_details": { "is_payment_from_subscription": false, "is_subscription_created": true }, "transaction_details": { "amount": 0.04, "cancellation_date": null, "country": "US", "currency": "USD", "custom_parameters": null, "foreign_invoice": null, "gift_recipient_email": null, "gift_recipient_id": null, "payment_date": "2019-03-21 16:15:37", "payment_method": "1380", "payment_method_name": "Credit/Debit Cards", "project": 21092, "project_name": "Test Project", "purchase": { "checkout": { "amount": 0, "currency": "USD" }, "pin_codes": { "amount": 0, "content": null, "currency": null }, "total": { "amount": 0.03, "currency": "USD" }, "virtual_currency": { "amount": 0.03, "currency": "USD", "name": "Gold coins", "quantity": "2" }, "virtual_items": null }, "refund_comment": null, "refund_reason": null, "status": "done", "user_id": "user1" } } ], "schema": { "items": { "properties": { "customer_details": { "properties": { "billing_address": { "type": "string" }, "bin": { "type": "string" }, "browser_language": { "type": "string" }, "country": { "type": "string" }, "ip": { "type": "string" }, "paystation_country": { "type": "string" }, "phone": { "nullable": true, "type": "string" }, "timezone": { "type": "string" }, "user_id": { "type": "string" }, "user_name": { "type": "string" } }, "type": "object" }, "finance_details": { "properties": { "direct_wht": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" }, "dispute_fee": { "properties": { "amount": { "description": "支払通貨での紛争手数料の金額。", "format": "float", "type": "number" }, "currency": { "description": "決済通貨。[ISO 4217](/ja/doc/pay-station/references/supported-currencies/)3文字通貨コード。", "type": "string" }, "date": { "description": "紛争開始日。", "type": "string" } }, "type": "object" }, "payment": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" }, "payment_method_fee": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" }, "payment_method_sum": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" }, "payout": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" }, "payout_currency_rate": { "format": "float", "type": "number" }, "repatriation_commission": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" }, "sales_tax": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" }, "vat": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" }, "xsolla_balance_sum": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" }, "xsolla_fee": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" } }, "type": "object" }, "payment_details": { "properties": { "card_holdername": { "nullable": true, "type": "string" }, "card_issuer": { "type": "string" }, "card_month": { "type": "integer" }, "card_number": { "type": "integer" }, "card_scheme": { "type": "string" }, "card_year": { "type": "integer" }, "customer_firstname": { "type": "string" }, "customer_lastname": { "type": "string" }, "enrollment": { "type": "boolean" }, "ps_account": { "type": "string" }, "zip_code": { "type": "string" } }, "type": "object" }, "subscription_details": { "properties": { "is_payment_from_subscription": { "type": "boolean" }, "is_subscription_created": { "type": "boolean" } }, "type": "object" }, "transaction_details": { "properties": { "amount": { "format": "float", "type": "number" }, "cancellation_date": { "nullable": true, "type": "string" }, "country": { "type": "string" }, "currency": { "type": "string" }, "custom_parameters": { "nullable": true, "type": "string" }, "foreign_invoice": { "nullable": true, "type": "string" }, "gift_recipient_email": { "nullable": true, "type": "string" }, "gift_recipient_id": { "nullable": true, "type": "string" }, "payment_date": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_name": { "type": "string" }, "project": { "type": "integer" }, "project_name": { "type": "string" }, "purchase": { "properties": { "checkout": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" }, "pin_codes": { "properties": { "amount": { "format": "float", "type": "number" }, "content": { "nullable": true, "type": "string" }, "currency": { "nullable": true, "type": "string" } }, "type": "object" }, "total": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" } }, "type": "object" }, "virtual_currency": { "properties": { "amount": { "format": "float", "type": "number" }, "currency": { "type": "string" }, "name": { "type": "string" }, "quantity": { "type": "string" } }, "type": "object" }, "virtual_items": { "nullable": true, "properties": { "amount": { "format": "float", "type": "number" }, "content": { "type": "string" }, "currency": { "type": "string" } }, "type": "object" } }, "type": "object" }, "refund_comment": { "nullable": true, "type": "string" }, "refund_reason": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "user_id": { "type": "string" } }, "type": "object" } }, "type": "object" }, "type": "array" } } }, "description": "トランザクション情報が正常に返されました。" } }, "security": [ { "basicAuth": [] } ], "summary": "トランザクションの取得", "tags": [ "reports" ], "x-admin": true, "x-server": true } }, "/merchants/{merchant_id}/reports/transactions/{transaction_id}/partial_refund": { "put": { "description": "一部返金のリクエストをユーザーに送信します。一部返金をサポートする返金プロセスと決済方法の詳細については、[ドキュメンテーション](https://developers.xsolla.com/doc/pay-station/features/refund/#pay_station_features_refund_how_it_works_partial_refund_flow)を参照してください。\n\n
\n

メモ

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

\n
\n\n

\n\n
\n

通知

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

\n
\n", "operationId": "request-partial-refund", "parameters": [ { "$ref": "#/components/parameters/merchant-id-path-param" }, { "$ref": "#/components/parameters/transaction-id-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "description": "test refund request", "refund_amount": 1.5 }, "schema": { "properties": { "description": { "description": "返金の理由。", "maxLength": 4000, "type": "string" }, "refund_amount": { "description": "購入通貨での返金額。", "format": "float", "type": "number" } }, "required": [ "description", "refund_amount" ], "type": "object" } } }, "required": true }, "responses": { "204": { "description": "返金リクエストを受け付けました" }, "403": { "description": "必要な許可を持っていません" }, "404": { "content": { "application/json": { "example": { "message": "Transaction with specified ID does not exist." }, "schema": { "properties": { "message": { "description": "指定されたIDのトランザクションは存在しません。決済クレデンシャルを確認してください。それ以外の場合は、support@xsolla.comまでエクソラサポートにご連絡ください。", "type": "string" } }, "type": "object" } } }, "description": "取引が見つかりません" }, "422": { "content": { "application/json": { "example": { "message": "Partial refund is unavailable for subscription payments." }, "schema": { "properties": { "message": { "description": "**返金できません**\n\n以下のいずれかのメッセージを返します：\n- Partial refund is unavailable for operations with user balance.\n- Requested transaction is partial refund and cannot be canceled.\n- Partial refund is unavailable for subscription payments.\n- Refund cannot be completed due to a payment system error. Please try again \n later.\n- Requested partial refund amount exceeds payment amount.\n- Requested partial refund amount is less than minimum amount specified by \n payment system.\n- Payment amount after partial refund will be less than allowable amount \n specified by payment system.\n- Dispute for this invoice is already opened. Can’t make a refund yet.\n\n**現在の決済方法は、一部返金に対応していません**\n\n以下のいずれかのメッセージを返します：\n- Current payment method does not support partial refunds.\n- Current transaction status does not allow refunds.\n- Deadline for refund is exceeded.\n- Partial refund is unavailable because discount was applied during payment \n creation.\n\n**間違い適合率のため、一部返金を実行できません**\n\n以下のメッセージを返します：\n- Partial refund is unavailable because requested amount is specified with \n incorrect precision for purchase currency.\n", "type": "string" } }, "type": "object" } } }, "description": "処理できないエンティティー" } }, "security": [ { "basicAuth": [] } ], "summary": "一部返金", "tags": [ "refund" ], "x-server": true } }, "/merchants/{merchant_id}/reports/transactions/{transaction_id}/refund": { "put": { "description": "ユーザーに支払いを返却するための返金リクエストを送信します。処理の詳細については、[返金機能](https://developers.xsolla.com/ja/doc/pay-station/features/refund/)をお読みください。\n\n
\n

メモ

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

\n
\n\n

\n\n
\n

通知

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

\n
\n", "operationId": "request-refund", "parameters": [ { "$ref": "#/components/parameters/merchant-id-path-param" }, { "$ref": "#/components/parameters/transaction-id-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "description": "test refund request" }, "schema": { "properties": { "description": { "description": "返金の理由。", "maxLength": 4000, "type": "string" }, "email": { "description": "ユーザーのEメール。", "maxLength": 100, "type": "string" } }, "required": [ "description" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "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." }, "schema": { "properties": { "message": { "description": "以下のいずれかのメッセージを返すことができます：\n- No content.\n- The request for a refund has been accepted. Xsolla CS will manually complete the refund. It may take up to two business days.\n- 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.", "type": "string" } }, "type": "object" } } }, "description": "OK（エラーなし）。" }, "204": { "description": "返金リクエストを受け付けました。" }, "401": { "description": "Unauthorized（アクセスが拒否された）。" }, "404": { "content": { "application/json": { "example": { "message": "Transaction ID not valid. Please check payment credentials. Otherwise, contact Xsolla support at support@xsolla.com." }, "schema": { "properties": { "message": { "description": "トランザクションIDが有効ではありません。決済クレデンシャルを確認してください。それ以外の場合は、support@xsolla.comまでエクソラサポートにご連絡ください。", "type": "string" } }, "type": "object" } } }, "description": "取引が見つかりません。" }, "422": { "content": { "application/json": { "example": { "message": "We are processing the refund request. This may take up to two business days." }, "schema": { "properties": { "message": { "description": "以下のいずれかのメッセージを返すことができます：\n- We are processing the refund request. This may take up to two business days.\n- We are reaching the user for the information required for the refund. For details, contact Xsolla Support.\n- Incorrect payment status. Refund is possible only for payments with \"completed\" or \"error\" status.\n- To process this request, the customer's email address field must be filled. Please specify the customer's email address and try again.\n- Full refund is unavailable because there are successful partial refunds for this transaction.\n- Refund failed. Please contact Xsolla Support to process it manually.\n- Dispute for this invoice is already opened. Can’t make a refund yet.", "type": "string" } }, "type": "object" } } }, "description": "Unprocessable Entity（無効なリクエストパラメータ）。" } }, "security": [ { "basicAuth": [] } ], "summary": "全額返金", "tags": [ "refund" ], "x-server": true } }, "/merchants/{merchant_id}/reports/transfers": { "get": { "description": "一定期間のすべてのペイアウトを一覧表示します。\n\n
\n

通知

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

\n
\n", "operationId": "get-payouts", "parameters": [ { "$ref": "#/components/parameters/merchant-id-path-param" }, { "$ref": "#/components/parameters/datetime-from" }, { "$ref": "#/components/parameters/datetime-to" }, { "$ref": "#/components/parameters/legal-entity-id" }, { "$ref": "#/components/parameters/payout-status" } ], "responses": { "200": { "content": { "application/json": { "example": [ { "canceled": 0, "payout": { "currency": "USD", "date": "2014-01-03T00:00:00+04:00", "id": 1, "note": "12/05/2013 - 01/04/2014" }, "rate": 1, "transfer": { "currency": "USD", "date": "2014-01-05T00:00:00+04:00", "note": "004357" } } ] } }, "description": "OK。" } }, "security": [ { "basicAuth": [] } ], "summary": "配当の一覧", "tags": [ "reports" ], "x-admin": true, "x-server": true } }, "/merchants/{merchant_id}/token": { "post": { "description": "任意のユーザーパラメータを持つトークンを作成することができます。トークンを取得する際にこれらのパラメータを送信し、決済が成功した後にパラメータを受信します。トー\nクンには、このドキュメントで説明されているか、ユーザーが事前定義したパラメータのみを含めることができます。\n\nパラメータが間違った形式で送信された場合、またはタイプが間違っている場合、トークンは発行されません。JSON本文にエラーの説明が含まれる 422 HTTP \nコードを受け取ります。`extended_message`では、どのようなパラメータが不正に送信されたかという情報が表示されます。\n\nデフォルトでは、トークンの有効期間は24時間です。この値を変更したい場合は、カスタマー・サクセス・マネージャーに連絡するか、csm@xsolla.comにメールを送信してください。アドミンページで作成された会社のすべてのプロジェクトに対して、新しい値が有効に\nなります。\n\n
\n

通知

このAPIメソッドを呼び出した後に取得したトークンは、他のリクエストの認証にのみ使用することができます。サブスクリプション製品を統合した場合にのみ、このトークンを使用して決済UIを開くことができます。

決済UIを新しいウィンドウで開くには、以下のリンクをご利用ください：https://secure.xsolla.com/paystation4/?token={token}で{token} 受信したトークン。

テスト目的には、以下のリンクを使用してください：https://sandbox-secure.xsolla.com/paystation4/?token={token}。

\n
\n\n

\n\n
\n

通知

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

\n
\n", "operationId": "create-token", "parameters": [ { "$ref": "#/components/parameters/merchant-id-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT" }, "schema": { "properties": { "token": { "type": "string" } }, "type": "object" } } }, "description": "作成済み。" }, "422": { "content": { "application/json": { "example": { "extended_message": { "global_errors": [], "property_errors": { "purchase.checkout.amount": [ "String value found, but a number is required" ] } }, "http_status_code": 422, "message": "JSON is not valid against json schema, please check documentation https://developers.xsolla.com/ja/api/v2/getting-started/#api_token_ui", "request_id": "cd72633" }, "schema": { "properties": { "extended_message": { "properties": { "global_errors": { "items": { "type": "string" }, "type": "array" }, "property_errors": { "description": "オブジェクトには、パラメータ名とエラー説明が含まれています。", "type": "object" } }, "type": "object" }, "http_status_code": { "type": "integer" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "type": "object" } } }, "description": "処理不可能なエンティティー。" } }, "security": [ { "basicAuth": [] } ], "summary": "トークンを作成する", "tags": [ "token" ], "x-server": true } }, "/projects/{project_id}/users/{user_id}/payment_accounts": { "get": { "description": "特定のユーザーの保存された決済アカウントを一覧表示します。\n\n
\n

メモ

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

\n
\n", "operationId": "get-saved-accounts", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/user-id-path-param" }, { "$ref": "#/components/parameters/mode" } ], "responses": { "200": { "content": { "application/json": { "example": [ { "id": 4612345, "name": "PP_saved_account", "payment_system": { "id": 24, "name": "PayPal" }, "type": "paypal" } ] } }, "description": "OK。" } }, "security": [ { "basicAuth": [] } ], "summary": "保存された決済アカウントの一覧", "tags": [ "tokenization" ], "x-server": true } }, "/projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}": { "delete": { "description": "保存済みの決済アカウントを削除します。\n\n
\n

メモ

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

\n
\n\n

\n\n
\n

メモ

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

\n
\n", "operationId": "delete-saved-account", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/user-id-path-param" }, { "$ref": "#/components/parameters/type-path-param" }, { "$ref": "#/components/parameters/account-id-path-param" } ], "responses": { "204": { "description": "No Content." } }, "security": [ { "basicAuth": [] } ], "summary": "保存された決済アカウントの削除", "tags": [ "tokenization" ], "x-server": true } }, "/projects/{project_id}/users/{user_id}/payments/{type}/{account_id}": { "post": { "description": "保存された決済アカウントを介してユーザーに請求する。\n\n
\n

メモ

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

\n
\n\n

\n\n
\n

通知

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

\n
\n", "operationId": "charge-with-saved-account", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/user-id-path-param" }, { "$ref": "#/components/parameters/type-path-param" }, { "$ref": "#/components/parameters/account-id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/charge-with-saved-account" }, "responses": { "201": { "content": { "application/json": { "example": { "transaction_id": 123458390 }, "schema": { "properties": { "transaction_id": { "type": "integer" } }, "type": "object" } } }, "description": "作成済み。" }, "422": { "description": "処理不可能なエンティティー。" } }, "security": [ { "basicAuth": [] } ], "summary": "保存されたアカウントで課金する", "tags": [ "tokenization" ], "x-server": true } } }, "components": { "securitySchemes": { "basicAuth": { "description": "Xsolla APIは基本アクセス認証を使用します。APIへの全てのリクエストは必ず `Authorization: Basic `ヘッダーを含めます。その同時に``はBase64標準に基づく`merchant_id:api_key`ペアです。\n\n[パブリッシャーアカウント](https://publisher.xsolla.com/) に移動して以下のパラメータを見つけます：
\nAPIキーの操作については、[APIリファレンス](https://developers.xsolla.com/ja/api/getting-started/#api_keys_overview)を参照してください。", "scheme": "basic", "type": "http" } }, "parameters": { "merchant-id-path-param": { "description": "マーチャントID。", "in": "path", "name": "merchant_id", "required": true, "schema": { "type": "integer" } }, "project-id-path-param": { "description": "プロジェクトID。", "in": "path", "name": "project_id", "required": true, "schema": { "type": "integer" } }, "transaction-id-path-param": { "description": "トランザクションID。", "in": "path", "name": "transaction_id", "required": true, "schema": { "type": "integer" } }, "datetime-from-req": { "description": "期間の開始は YYYY-MM-DD （年月日）形式で表示されます。次のパラメータの少なくとも1つが渡された場合は必須ではありません：", "example": "2023-02-08", "in": "query", "name": "datetime_from", "required": true, "schema": { "format": "datetime", "type": "string" } }, "datetime-to-req": { "description": "期間の終了は YYYY-MM-DD （年月日）形式で表示されます。次のパラメータの少なくとも1つが渡された場合は必須ではありません： `datetime_from`と`datetime_to`の差は92日を超えることはできません。", "example": "2023-03-08", "in": "query", "name": "datetime_to", "required": true, "schema": { "format": "datetime", "type": "string" } }, "format": { "description": "データ形式。", "in": "path", "name": "format", "required": true, "schema": { "enum": [ "json", "csv", "xls" ], "type": "string" } }, "in-transfer-currency": { "description": "すべての財務データをペイアウト通貨に変換します（デフォルトではペイイン通貨が使用されます）。次のパラメータの少なくとも1つが渡された場合は必須ではありません：", "in": "query", "name": "in_transfer_currency", "required": true, "schema": { "type": "integer" } }, "show-total": { "description": "トランザクションの合計金額をレポートに含めるかどうか。CSV形式でのみエクスポートできます。デフォルトでは`true`。", "in": "query", "name": "show_total", "schema": { "type": "boolean" } }, "merchant-of-records": { "description": "マーチャントレコード。`xsolla`、`merchant`または指定しないことも可能です。`merchant`である場合は、パートナーのゲートウェイを介して行われたトランザクションを返します。`xsolla`である場合は、パートナーのゲートウェイを経由していないトランザクションを返します。指定されていない場合は、すべてのトランザクションを返します。", "in": "query", "name": "merchant_of_records", "required": false, "schema": { "enum": [ "xsolla", "merchant" ], "nullable": true, "type": "string", "x-enumDescriptions": { "merchant": "パートナーのゲートウェイを経由して行われたトランザクションを返します。", "xsolla": "パートナーのゲートウェイを経由せずに行われたトランザクションを返します。" } } }, "project-id-query-param": { "description": "プロジェクトID。", "in": "query", "name": "project_id", "required": false, "schema": { "type": "integer" } }, "show-dry-run": { "description": "テストトランザクションを含めるかどうかを示します。", "in": "query", "name": "show_dry_run", "required": false, "schema": { "type": "boolean" } }, "transfer-id": { "description": "配当ID。", "in": "query", "name": "transfer_id", "required": false, "schema": { "type": "integer" } }, "report-id": { "description": "財務レポートID。", "in": "query", "name": "report_id", "required": false, "schema": { "type": "integer" } }, "offset": { "description": "リスト生成元のエレメントの番号です（カウントは0から始まります）。", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, "limit-req": { "description": "ページに表示されるトランザクションの数の制限。このパラメータが渡された場合、`datetime_from`および`datetime_to`パラメータを渡す必要はありません。", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, "transaction-status": { "description": "トランザクションステータス。", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "done", "canceled", "error", "refunded" ], "type": "string" } }, "datetime-from": { "description": "期間開始日。", "in": "query", "name": "datetime_from", "required": false, "schema": { "format": "datetime", "type": "string" } }, "datetime-to": { "description": "期間終了日。", "in": "query", "name": "datetime_to", "required": false, "schema": { "format": "datetime", "type": "string" } }, "transaction-id": { "description": "トランザクションID。", "in": "query", "name": "transaction_id", "required": false, "schema": { "type": "integer" } }, "type": { "description": "検索結果に表示される取引のタイプ：", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "all", "transferred", "canceled", "test" ], "type": "string", "x-enumDescriptions": { "all": "全ての取引。", "canceled": "テスト取引を除く、キャンセルされた取引。", "test": "取引をテストします。", "transferred": "テスト取引を除く、成功した取引。" } } }, "phone": { "description": "ユーザーの電話番号（国際形式）。", "in": "query", "name": "phone", "required": false, "schema": { "type": "string" } }, "user-id-query-param": { "description": "プレイヤー側に保存されているゲーム内の一意のユーザーID。必ず既存のユーザーIDを渡してください。エラーが発生した場合は、[よくある質問への回答](/ja/doc/pay-station/references/faq/#faq_validation)を参照してください。", "in": "query", "name": "user_id", "required": false, "schema": { "type": "string" } }, "user-name": { "description": "ユーザー名。", "in": "query", "name": "user_name", "required": false, "schema": { "type": "string" } }, "user-custom": { "description": "ユーザー識別のためのカスタムパラメータ。", "in": "query", "name": "user_custom", "required": false, "schema": { "type": "string" } }, "email": { "description": "ユーザーのEメール。", "in": "query", "name": "email", "required": false, "schema": { "maxLength": 100, "type": "string" } }, "external-id": { "description": "ゲーム内のトランザクションID。各ユーザーの支払いに対して一意でなければならなりません。", "in": "query", "name": "external_id", "required": false, "schema": { "type": "string" } }, "order-id": { "description": "注文ID。それを使用して、[注文する](/ja/api/shop-builder/operation/get-order/) APIメソッドを呼び出すことができます。", "example": 1234, "in": "query", "name": "order_id", "required": false, "schema": { "type": "integer" } }, "limit": { "description": "ページにあるエレメント数の制限。", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, "status": { "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/status.enum" } }, "legal-entity-id": { "description": "開発者の法人のID。", "in": "query", "name": "legal_entity_id", "required": false, "schema": { "type": "integer" } }, "payout-status": { "description": "支払い状況。", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "hold", "ready", "paid" ], "type": "string", "x-enumDescriptions": { "hold": "リクエストの続行を待っています。", "paid": "支払い完了。", "ready": "支払い中。" } } }, "user-id-path-param": { "description": "プレイヤー側に保存されているゲーム内の一意のユーザーID。必ず既存のユーザーIDを渡してください。エラーが発生した場合は、[よくある質問への回答](/ja/doc/pay-station/references/faq/#faq_validation)を参照してください。", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } }, "mode": { "description": "支払い処理をテストするには、`sandbox`に設定します。実際の決済用を行うためにパラメータを削除します。", "in": "query", "name": "mode", "required": false, "schema": { "type": "string" } }, "type-path-param": { "description": "決済アカウントの種類。", "in": "path", "name": "type", "required": true, "schema": { "enum": [ "card", "amazon", "skrill", "paypal", "toss", "alipayplus_cn", "alipayplus_hk", "alipayplus_gcash", "alipayplus_dana", "alipayplus_rabbitlinepay", "alipayplus_tng", "alipayplus_boost", "alipayplus_truemoney", "alipayplus_maya", "alipayplus_kplus", "softbank_paypay", "softbank_docomo", "softbank_softbank2", "softbank_au", "softbank_ymobile", "paysafecard_eu", "paysafecard_us", "paidy", "klarna", "mercadopago", "nupay" ], "type": "string", "x-enumDescriptions": { "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 ウォレット。", "amazon": "アマゾンペイ。", "card": "銀行カード。", "klarna": "Klarna。決済アカウントの保存は米国、英国、スウェーデン、ドイツ、オーストリア、ノルウェー、フィンランド、デンマーク、オランダでのみ利用可能です。", "mercadopago": "Mercado Pago（Mercado Pago Connectを含む）。", "nupay": "NuPay。", "paidy": "Paidy。", "paypal": "PayPal（ペイパル）。", "paysafecard_eu": "Paysafecard（欧州連合）。", "paysafecard_us": "Paysafecard（アメリカ）。", "skrill": "Skrill Digital Wallet。", "softbank_au": "auかんたん決済。", "softbank_docomo": "ドコモ。", "softbank_paypay": "PayPay。", "softbank_softbank2": "フトバンク。", "softbank_ymobile": "Y!mobile。", "toss": "Toss Wallet。" } } }, "account-id-path-param": { "description": "エクソーラデータベースに保存されたアカウントのID。", "in": "path", "name": "account_id", "required": true, "schema": { "type": "integer" } } }, "schemas": { "empty-body": { "description": "APIコールが正しく動作するためには、リクエスト本文は空白である必要があります。", "nullable": true, "type": "object" }, "status.enum": { "description": "トランザクションステータス。", "enum": [ "created", "processing", "review", "error", "done", "awaitingRefund", "refunded", "canceled", "partiallyRefunded" ], "type": "string", "x-enumDescriptions": { "awaitingRefund": "この取引は返金の決定待ちです。ユーザーが返金をリクエストした後、エクソーラカスタマーサポートはリクエストを手動で処理し、返金に関する決定を行います。", "canceled": "次の2つのシナリオがありれます：\n - 取引は決済システム側でキャンセルされました。例えば、ユーザーアカウントの資金が不足しているとします。\n - 支払いはユーザーに払い戻されました。", "created": "ユーザーがトランザクションを開始しましたが、まだ処理されていません。", "done": "トランザクションは正常に処理されました。", "error": "トランザクションの処理中にエラーが発生しました。このような支払いは、エクソーラカスタマーサポートにお問い合わせいただくことで返金できます。", "partiallyRefunded": "ユーザーは一部返金を受けました。", "processing": "トランザクションは処理中です。", "refunded": "ユーザーのXsolla残高に返金されました。", "review": "トランザクション処理は不正防止システムによって停止されており、現在追加の検証中です。" } }, "custom_parameters": { "description": "このオブジェクトには、不正対策フィルターを設定するためのパラメータが含まれています。パラメータのリストを以下に示します。カスタムパラメータを追加するには、カスタマーサクセスマネージャーにご連絡いただくか、[csm@xsolla.com](mailto:csm@xsolla.com)まで電子メールをお送りください。", "properties": { "active_date": { "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)形式の最終閲覧日。", "type": "string" }, "additional_verification": { "description": "プレイヤーがアカウント承認手続きを使用するかどうかを示します。", "type": "boolean" }, "character_customized": { "description": "プレイヤーがキャラクターをカスタマイズしたかどうかを示します。", "type": "boolean" }, "chat_activity": { "description": "プレイヤーがチャット機能を使用するかどうかを示します。", "type": "boolean" }, "completed_tasks": { "description": "完了したタスクや目標の数。", "type": "integer" }, "forum_activity": { "description": "プレイヤーがフォーラム機能を使用するかどうかを示す。", "type": "boolean" }, "items_used": { "description": "プレイヤーが購入したゲームアイテムを使用するかどうかを示します。", "type": "boolean" }, "karma_points": { "description": "プレイヤーのカルマ値。", "type": "integer" }, "last_change_password_date": { "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)に沿ったパスワード最終更新日。", "type": "string" }, "non_premium_currency": { "description": "非プレミアム通貨の金額。", "format": "float", "type": "number" }, "notifications_enabled": { "description": "プレイヤーが通知を有効化したかどうかを示します。", "type": "boolean" }, "profile_completed": { "description": "プレイヤーがプロフィールに追加情報を入力したかどうかを示します。", "type": "boolean" }, "profile_image_added": { "description": "プレイヤーがプロフィール画像をアップロードしたかどうかを示します。", "type": "boolean" }, "pvp_activity": { "description": "PvP（プレイヤー対プレイヤー）のバトルに参加するかどうか。", "type": "boolean" }, "registration_date": { "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)形式のアカウント作成日。", "type": "string" }, "session_time": { "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)に沿った平均セッション時間。", "type": "string" }, "social_networks_added": { "description": "プレイヤーがソーシャルメディアプロファイルを接続しているかを示します。", "type": "boolean" }, "total_bans": { "description": "チャットやフォーラムでプレイヤーが禁止された回数。", "type": "integer" }, "total_characters": { "description": "ゲーム内のキャラクターの数。", "type": "integer" }, "total_clans": { "description": "プレイヤーがメンバーになっているクランの数。", "type": "integer" }, "total_friends": { "description": "友達の数。", "type": "integer" }, "total_game_events": { "description": "プレイヤーが参加したゲーム内イベントの数。", "type": "integer" }, "total_gifts": { "description": "プレイヤーが送受信したゲーム内の贈り物の数。", "type": "integer" }, "total_hours": { "description": "合計ゲーム時間数。", "type": "integer" }, "total_inventory_value": { "description": "インベントリ総額（ゲーム内通貨）。", "format": "float", "type": "number" }, "total_sum": { "description": "総支払額。", "format": "float", "type": "number" }, "tutorial_completed": { "description": "プレイヤーがゲームのチュートリアルを完了したかどうかを示します。", "type": "boolean" }, "unlocked_achievements": { "description": "達成した実績の数。", "type": "integer" }, "user_level": { "description": "プレイヤーのレベル、評判、またはランク。", "type": "integer" }, "win_rate": { "description": "勝率。", "type": "integer" } }, "type": "object" }, "is_lootbox": { "default": false, "description": "アイテムがルートボックスであるかどうか。", "type": "boolean" }, "subscription": { "description": "サブスクリプションデータ（オブジェクト）。", "properties": { "available_plans": { "description": "決済インターフェイスに表示するサブスクリプションプラン（配列）。", "items": { "type": "string" }, "type": "array" }, "currency": { "description": "すべての計算で使用するサブスクリプションプランの通貨。", "type": "string" }, "operation": { "description": "ユーザーのサブスクリプションプランに適用される操作の種類。サブスクリプションプランを変更する場合は、値`change_plan`を渡します。`purchase.subscription.plan_id`パラメーターに新しいプランIDを指定してください。", "type": "string" }, "plan_id": { "description": "サブスクリプションプランの外部ID。これは、パブリッシャーアカウントの**サブスクリプション > サブスクリプションプラン**セクションで確認できます。", "type": "string" }, "product_id": { "description": "製品ID。", "type": "string" }, "trial_days": { "description": "試用期間（日）。", "type": "integer" } }, "type": "object" }, "purchase": { "description": "購入の詳細を含むオブジェクト。", "properties": { "is_lootbox": { "$ref": "#/components/schemas/is_lootbox" }, "subscription": { "$ref": "#/components/schemas/subscription" } }, "type": "object" }, "cancel_url": { "description": "決済を完了する前にユーザーが決済UIを閉じた際にリダイレクトされるページのURLです。このパラメータは、`settings.​ui.​desktop.​header`または`settings.​ui.​mobile`オブジェクトを使用して決済UIを閉じるボタンを設定している場合にのみ機能します。ボタンは設定されているものの、このパラメータでURLが渡されない場合は、`settings.return_url`パラメータで渡されたURLが使用されます。", "type": "string" }, "currency": { "description": "標準の決済通貨。[ISO 4217](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)3文字通貨コード。", "type": "string" }, "external_id": { "description": "ゲーム内のトランザクションID。ユーザーの支払いごとに一意である必要があります。 詳細については、説明文書を参照してください。", "type": "string" }, "language": { "description": "インターフェース言語。2文字の小文字[言語コード](https://developers.xsolla.com/ja/doc/pay-station/features/localization/)。", "type": "string" }, "mode.settings": { "description": "決済処理をテストするには、`sandbox`に設定します。この場合、*https://sandbox-secure.xsolla.com*を使用してテスト決済インターフェースにアクセスしてください。", "type": "string" }, "payment_method": { "description": "決済方法のID。", "type": "integer" }, "payment_widget": { "description": "支払いウィジェットです。`paybycash`または`giftcard`が選択できます。このパラメータが設定されている場合、ユーザーはPay by CashまたはGift Cardsウィジェットにそれぞれリダイレクトされます。", "enum": [ "paybycash", "giftcard" ], "type": "string" }, "project_id": { "description": "ゲームのエクソラID。パブリッシャ―アカウントにあります。", "type": "integer" }, "redirect_policy": { "description": "リダイレクトポリシーの設定（オブジェクト）。", "properties": { "delay": { "description": "ユーザーがリターンURLに自動的にリダイレクトされるまでの遅延時間（秒）。", "type": "integer" }, "manual_redirection_action": { "description": "決済ステーション動作はユーザーが「閉じる」ボタンや「**ゲームに戻る**」ボタンをクリックすること​によって引き起こされます。`redirect`（デフォルト）と`postmessage`にすることができます。`redirect`に設定すると、ユーザーはトークンで渡された、またはパブリッシャーアカウントで指定されたURLにリダイレクトされます。`postmessage`に設定すると、ユーザーは他のページにリダイレクトされません。「閉じる」アイコンをクリックすると、`close`イベントが開始され、「**ゲームに戻る**」をクリックすると、`return`イベントが開始されます。", "enum": [ "redirect", "postmessage" ], "type": "string" }, "redirect_button_caption": { "description": "手動リダイレクト用のボタンのテキスト。", "type": "string" }, "redirect_conditions": { "description": "ユーザーがリターンURLにリダイレクトされる決済状態。`none`、`successful`、`successful_or_canсeled`、または`any`のいずれかとなります。", "enum": [ "none", "successful", "successful_or_canceled", "any" ], "type": "string" }, "show_redirect_countdown": { "default": false, "description": "決済ステータスページにリダイレクトのカウントダウンタイマーを表示するかどうか。カウントダウンの長さは、`settings.redirect_policy.delay`パラメータで渡された値によって決定されます。", "type": "boolean" }, "status_for_manual_redirection": { "description": "リターンURLへのリダイレクトボタンが表示される決済状態。`none`、`successful`、`successful_or_canсeled`、または`any`のいずれかとなります。", "enum": [ "none", "successful", "successful_or_canceled", "any" ], "type": "string" } }, "type": "object" }, "return_url": { "description": "決済後にユーザーがリダイレクトされるページのURL。リダイレクトの構成の詳細については、説明文書を参照してください。", "type": "string" }, "alternative_first_screen": { "description": "決済UI起動時の代替ビュー設定。例えば、優先順位の高い決済方法を前面に表示させることができます。\n\n`apple-pay`に設定すると、ユーザーには主要な決済オプションとしてApple \nPayボタンが表示され、あわせて他の決済方法リストへのリンクが表示されます。このロジックはAndroidデバイスには適用されません。\n", "enum": [ "apple-pay" ], "type": "string" }, "ap_quick_payment_button": { "description": "サポートされているデバイスで、決済UIの上部にApple \nPayでのクイック支払いボタンを表示するかどうか。デフォルトは`true`です。`false`に設定した場合、Apple Payは [PayRank](/ja/doc/pay-station/how-to/how-to-manage-top-payment-methods/)のアルゴリズムに従って、決済方法のリストに表示されます。\n\n
\n

注意

Androidデバイスや、Apple Payでの支払いをサポートしていないその他のデバイスでは、このパラメータの値に関わらず、決済方法のリストから非表示になります。

\n
\n", "type": "boolean" }, "components": { "description": "メニュー設定（オブジェクト）。", "properties": { "subscriptions": { "description": "サブスクリプションプランのサブメニュー（オブジェクト）。", "properties": { "hidden": { "description": "サブメニューを表示するかどうかを示します。", "type": "boolean" }, "order": { "description": "メニュー内のサブメニューの位置。", "type": "integer" } }, "type": "object" }, "virtual_currency": { "description": "仮想通貨サブメニュー。", "properties": { "custom_amount": { "description": "ユーザーが任意の数の仮想通貨を決済インターフェースに入力できるかどうかを示します。", "type": "boolean" }, "hidden": { "description": "サブメニューを表示するかどうかを示します。", "type": "boolean" }, "order": { "description": "メニュー内のサブメニューの位置。", "type": "integer" } }, "type": "object" }, "virtual_items": { "description": "仮想アイテムサブメニュー。", "properties": { "hidden": { "description": "サブメニューを表示するかどうかを示します。", "type": "boolean" }, "order": { "description": "メニュー内のサブメニューの位置。", "type": "integer" }, "selected_group": { "description": "仮想アイテムタブを開いた後に表示するグループ。", "type": "string" }, "selected_item": { "description": "仮想アイテムタブを開いた後に表示されるアイテム（アイテムSKU）。", "type": "string" } }, "type": "object" } }, "type": "object" }, "currency_format": { "description": "`code`に設定すると、決済UIに3 文字の[ISO 4217](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)通貨コードが表示されます。 デフォルトでは、3文字の通貨コードの代わりに通貨記号が表示されます。", "type": "string" }, "close_button_icon": { "description": "決済UIの「**閉じる**」ボタンのアイコン。", "enum": [ "arrow", "cross" ], "type": "string", "x-enumDescriptions": { "arrow": "決済UIヘッダーの左側にある「**←**」アイコン。", "cross": "決済UIヘッダーの右側にある「**×**」アイコン。" } }, "header.desktop": { "description": "ヘッダー設定。", "properties": { "close_button": { "default": false, "description": "決済UIを閉じるボタンを表示するかどうかを指定します。ユーザーがこのボタンをクリックすると、決済UIが閉じられ、`settings.cancel_url`パラメータで渡されたURLにリダイレクトされます。このパラメータでURLが渡されない場合は、代わりに`settings.return_url`パラメータで渡されたURLが使用されます。", "type": "boolean" }, "close_button_icon": { "$ref": "#/components/schemas/close_button_icon" }, "is_visible": { "description": "決済インターフェースにヘッダーを表示するかどうかを示します。", "type": "boolean" }, "type": { "description": "ヘッダーを表示する方法。`compact`（プロジェクト名とユーザーIDを隠す）または`normal`（既定）に指定できます。", "enum": [ "compact", "normal" ], "type": "string" }, "visible_logo": { "description": "`true`の場合、ロゴはヘッダーに表示されます。画像をアップロードするには、[アドミンページ](https://publisher.xsolla.com/)でプロジェクトを開き、**ペイステション > 設定**セクションに移動してください。", "type": "boolean" }, "visible_name": { "description": "ヘッダーにプロジェクト名を表示するかどうかを示します。", "type": "boolean" }, "visible_purchase": { "description": "ヘッダーに購入説明（`purchase.description.value`）を表示するか示します。デフォルトは`true`です。", "type": "boolean" } }, "type": "object" }, "subscription_list.desktop": { "description": "サブスクリプションプラン（オブジェクト）の一覧の設定。", "properties": { "description": { "description": "決済インターフェースの利用可能なサブスクリプションプランの一覧上に表示されるテキスト。", "type": "string" }, "display_local_price": { "description": "`true`の場合、ユーザーの現地通貨が購読プランに設定されている通貨と異なる場合、ユーザーは両方の価格を見ることができます。1つは現地通貨で、もう1つは基本通貨で表示されます。", "type": "boolean" } }, "type": "object" }, "desktop.ui": { "description": "デスクトップバージョン（オブジェクト）のインターフェース設定。", "properties": { "header": { "$ref": "#/components/schemas/header.desktop" }, "subscription_list": { "$ref": "#/components/schemas/subscription_list.desktop" } }, "type": "object" }, "gp_quick_payment_button": { "description": "Google Payの決済方法の表示方法。`true`の場合、Google Payによるクイック決済ボタンは、ユーザーのデバイスやブラウザに関係なく、決済UIの最上部に表示されます。`false`の場合、Google Payは[PayRank](/ja/doc/pay-station/how-to/how-to-manage-top-payment-methods/)アルゴリズムに従って決済方法リスト内に表示されます。このパラメータが渡されない場合、Google PayはSafariを除くすべてのユーザーのデバイスやブラウザの決済UIの最上部に表示されます。Safariでは、決済方法リスト内に表示されます。", "type": "boolean" }, "header.ui": { "properties": { "visible_virtual_currency_balance": { "description": "この要素を決済インターフェースで非示にできるかどうかを示します。既定では`true`です。", "type": "boolean" } }, "type": "object" }, "is_cart_open_by_default": { "description": "決済UIにおける、カート内のアイテムリストと金額詳細の表示についてです。`true`の場合、情報が展開されたビューで表示されます。`false`（デフォルト）またはパラメータが渡されない場合、情報は折りたたまれたビューで表示されます。", "type": "boolean" }, "is_independent_windows": { "description": "埋め込みランチャーのブラウザ（WebView）から、ユーザーのデフォルトのブラウザにリダイレクトして購入させるかどうか。デフォルトでは`false`です。", "type": "boolean" }, "is_language_selector_hidden": { "description": "決済ページで言語セレクターが非表示になっているかどうか。デフォルトでは`false`に設定されており、セレクターは表示されます。", "type": "boolean" }, "is_payment_methods_list_mode": { "description": "決済UIを開く際に、ユーザーの国で利用可能な決済方法のリストを表示するかどうか。`false`の場合（デフォルト）、`settings.payment_method`パラメータで渡された決済方法、または[PayRankアルゴリズム](https://developers.xsolla.com/ja/solutions/payments/payment-ui-management/top-payment-methods-management/)で選択された方法が表示されます。", "type": "boolean" }, "is_prevent_external_link_open": { "description": "リンクを外部リソースにリダイレクトするかどうかを無効にします。デフォルトは`false`です。外部リンクをクリックすると、`external-link-open`イベントが`postMessage`メカニズムを介して送信されます。`url`パラメータには、リダイレクト先のリンクのアドレスが渡されます。", "type": "boolean" }, "is_search_field_hidden": { "description": "決済UIに決済方法検索バーを表示するかどうか。`true`の場合、検索バーは隠されます。デフォルトでは`false`です。", "type": "boolean" }, "is_show_close_widget_warning": { "description": "支払いページを閉じる前に、**×**アイコンの上にカーソルを置いたときに取引処理に関する警告を表示するかどうか。`false`が渡された場合、またはパラメータが渡されなかった場合、警告は表示されません。デフォルトでは`true`です。", "type": "boolean" }, "is_three_ds_independent_windows": { "default": false, "description": "3-Dセキュア検証が新しいブラウザウィンドウで開くかどうか。セットアップでコンテンツセキュリティポリシー（CSP）が適用される場合は、`true`に設定します。", "type": "boolean" }, "layout": { "description": "決済UIの主要要素の位置。ゲーム内で決済UIを開いたり、注文や決済方法に関する情報の列を入れ替えたりすることができます。詳細については、[カスタマイズに関する説明](https://developers.xsolla.com/ja/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_layout)を参照してください。", "enum": [ "embed", "column_reverse", "embed_column_reverse" ], "type": "string" }, "mobile.ui": { "properties": { "header": { "properties": { "close_button": { "default": false, "description": "モバイル版の決済UIを閉じるボタンを表示するかどうかを指定します。ユーザーがこのボタンをクリックすると、決済UIが閉じられ、`settings.cancel_url`パラメータで渡されたURLにリダイレクトされます。このパラメータでURLが渡されない場合は、代わりに`settings.return_url`パラメータで渡されたURLが使用されます。", "type": "boolean" }, "close_button_icon": { "$ref": "#/components/schemas/close_button_icon" } }, "type": "object" } }, "type": "object" }, "mode.ui": { "description": "保存された決済方法を管理するための決済UIの表示モード。`user_account`に設定するか、省略できます。このモードでは、ユーザーは言語の変更、新しい決済\n方法の追加、および既存の決済方法の削除のみを行うことができます。\n\n
\n

注意

このパラメータが渡された場合、リダイレクトボタンは表示されません。決済方法を保存した後にユーザーをリダイレクトするには、自動リダイレクトを設定してください。

\n
\n", "type": "string" }, "theme.ui": { "description": "決済UIのテーマ。ライトテーマ（デフォルト）の場合は`63295a9a2e47fab76f7708e1`、ダークテーマの場合は`63295aab2e47fab76f7708e3`を指定できます。[カスタムテーマを作成](https://developers.xsolla.com/ja/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_in_token)して、そのIDをこのパラメータに渡すこともできます。", "enum": [ "63295a9a2e47fab76f7708e1", "63295aab2e47fab76f7708e3" ], "type": "string" }, "payment_accounts_enable": { "properties": { "enable": { "description": "決済方法の編集ページに移動する決済UIに鉛筆アイコンを表示するかどうかを指定します。デフォルトは`true`です。", "type": "boolean" }, "order": { "description": "決済UIのドロップダウンリストにおけるセクションの位置。`settings.ui.user_account.payment_accounts.enable`が渡された場合に必須です。", "minimum": 1, "type": "integer" } }, "type": "object" }, "user_account": { "description": "ユーザーアカウントの詳細（オブジェクト）。", "properties": { "payment_accounts": { "allOf": [ { "description": "**保存したメソッド**セクション。" }, { "$ref": "#/components/schemas/payment_accounts_enable" } ] } }, "type": "object" }, "ui": { "description": "インタフェース設定（オブジェクト）。", "properties": { "alternative_first_screen": { "$ref": "#/components/schemas/alternative_first_screen" }, "apple_pay_quick_payment_button": { "$ref": "#/components/schemas/ap_quick_payment_button" }, "components": { "$ref": "#/components/schemas/components" }, "currency_format": { "$ref": "#/components/schemas/currency_format" }, "desktop": { "$ref": "#/components/schemas/desktop.ui" }, "gp_quick_payment_button": { "$ref": "#/components/schemas/gp_quick_payment_button" }, "header": { "$ref": "#/components/schemas/header.ui" }, "is_cart_open_by_default": { "$ref": "#/components/schemas/is_cart_open_by_default" }, "is_independent_windows": { "$ref": "#/components/schemas/is_independent_windows" }, "is_language_selector_hidden": { "$ref": "#/components/schemas/is_language_selector_hidden" }, "is_payment_methods_list_mode": { "$ref": "#/components/schemas/is_payment_methods_list_mode" }, "is_prevent_external_link_open": { "$ref": "#/components/schemas/is_prevent_external_link_open" }, "is_search_field_hidden": { "$ref": "#/components/schemas/is_search_field_hidden" }, "is_show_close_widget_warning": { "$ref": "#/components/schemas/is_show_close_widget_warning" }, "is_three_ds_independent_windows": { "$ref": "#/components/schemas/is_three_ds_independent_windows" }, "layout": { "$ref": "#/components/schemas/layout" }, "mobile": { "$ref": "#/components/schemas/mobile.ui" }, "mode": { "$ref": "#/components/schemas/mode.ui" }, "theme": { "$ref": "#/components/schemas/theme.ui" }, "user_account": { "$ref": "#/components/schemas/user_account" } }, "type": "object" }, "settings": { "description": "ユーザーの決済プロセスと決済UIを構成するための設定。", "properties": { "cancel_url": { "$ref": "#/components/schemas/cancel_url" }, "currency": { "$ref": "#/components/schemas/currency" }, "external_id": { "$ref": "#/components/schemas/external_id" }, "language": { "$ref": "#/components/schemas/language" }, "mode": { "$ref": "#/components/schemas/mode.settings" }, "payment_method": { "$ref": "#/components/schemas/payment_method" }, "payment_widget": { "$ref": "#/components/schemas/payment_widget" }, "project_id": { "$ref": "#/components/schemas/project_id" }, "redirect_policy": { "$ref": "#/components/schemas/redirect_policy" }, "return_url": { "$ref": "#/components/schemas/return_url" }, "ui": { "$ref": "#/components/schemas/ui" } }, "required": [ "project_id" ], "type": "object" }, "age.user": { "description": "ユーザーの年齢。", "type": "integer" }, "attributes.user": { "description": "キー値ペアの有効なJSONセットとして表される、アイテムリストをフィルタリングするためのユーザー属性。", "type": "object" }, "country.user": { "properties": { "allow_modify": { "description": "ユーザーが決済UIで国を変更できるかどうか。トークンに`country.value`が渡された場合、デフォルトでは`false`となります。", "type": "boolean" }, "value": { "description": "ユーザーの国。2文字の国コード（大文字）は、[ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従って使用されます。", "type": "string" } }, "type": "object" }, "email.user": { "description": "`user.email`オブジェクトは、不正対策モデルの構築に不可欠な要素であり、受け入れ率の向上に貢献します。それは、エクソラと決済システムの両方の要件です。パラメータが渡されない場合は、決済ページにメール入力の必須項目が表示されます。ユーザーは、パラメータに渡された、または決済ページで入力された電子メールに購入領収書を受け取ります。", "properties": { "allow_modify": { "description": "決済UIでユーザーが自分のメールアドレスを入力できるかどうか。`user.email.value`パラメータがトークンで渡される場合、値はデフォルトで`false`です。", "type": "boolean" }, "value": { "description": "ユーザーのメールアドレス。[RFC 822](https://www.w3.org/Protocols/rfc822/#z8)で規定された書式を厳密に守らなければなりません。", "maxLength": 100, "type": "string" } }, "required": [ "value" ], "type": "object" }, "id.user": { "properties": { "value": { "description": "プレイヤー側に保存されているゲーム内の一意のユーザーID。必ず既存のユーザーIDを渡してください。エラーが発生した場合は、[よくある質問への回答](/ja/doc/pay-station/references/faq/#faq_validation)を参照してください。", "type": "string" } }, "required": [ "value" ], "type": "object" }, "is_legal.user": { "description": "ユーザーが法人かを示します。", "type": "boolean" }, "legal": { "description": "法人情報を含むオブジェクトです。", "properties": { "address": { "description": "最後まで記載した法的住所です。", "type": "string" }, "country": { "description": "設立国。[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従って大文字2文字の国コードを使用します。", "type": "string" }, "name": { "description": "法人のフルネームです。", "type": "string" }, "vat_id": { "description": "納税者個別のID。", "type": "string" } }, "type": "object" }, "legal.user": { "allOf": [ { "description": "法人情報を含むオブジェクトです。`user.is_legal`が`true`の場合は、オブジェクトとその全パラメーターが必要です。" }, { "$ref": "#/components/schemas/legal" } ] }, "name.user": { "properties": { "allow_modify": { "description": "決済UIでユーザーが自分の名前を入力できるかどうか。`user.name.value`パラメータがトークンで渡される場合、値はデフォルトで`false`です。", "type": "boolean" }, "value": { "description": "ユーザーのスクリーン名。", "type": "string" } }, "type": "object" }, "phone.user": { "nullable": true, "properties": { "value": { "description": "ユーザーの電話番号。", "type": "string" } }, "type": "object" }, "public_id.user": { "properties": { "value": { "description": "ユーザーを一意に識別し、ユーザーに知られているパラメーター（電子メール、スクリーン名など）。ユーザーがゲームストア外で購入することを可能にします（例えば、電子キオスクを介して）。", "type": "string" } }, "type": "object" }, "steam_id.user": { "properties": { "value": { "description": "Steam ID。", "type": "string" } }, "type": "object" }, "tracking_id.user": { "properties": { "value": { "description": "一意のユーザーID — マーケティングキャンペーンで使用されます。数字とラテン文字を含めることができます。", "maxLength": 32, "minLength": 32, "type": "string" } }, "type": "object" }, "utm.user": { "description": "トラフィック属性（オブジェクト）。", "properties": { "utm_campaign": { "description": "カタカナ表記、または英語に翻訳されたキャンペーンのタイトル。", "type": "string" }, "utm_content": { "description": "キャンペーンのコンテンツ。", "type": "string" }, "utm_medium": { "description": "トラフィックチャネル（コンテンツ広告、メディア広告、Eメールリストなど）。", "type": "string" }, "utm_source": { "description": "トラフィックソース。", "type": "string" }, "utm_term": { "description": "キャンペーンキーワード。設定すると、統計は特定の検索クエリではなく広告ターゲティングに使用されるキーワードに基づきます。Googleアナリティクスでは、指定された`utm_term`は一般検索語句レポートの一部です。", "type": "string" } }, "type": "object" }, "user": { "description": "ユーザー詳細。", "properties": { "age": { "$ref": "#/components/schemas/age.user" }, "attributes": { "$ref": "#/components/schemas/attributes.user" }, "country": { "$ref": "#/components/schemas/country.user" }, "email": { "$ref": "#/components/schemas/email.user" }, "id": { "$ref": "#/components/schemas/id.user" }, "is_legal": { "$ref": "#/components/schemas/is_legal.user" }, "legal": { "$ref": "#/components/schemas/legal.user" }, "name": { "$ref": "#/components/schemas/name.user" }, "phone": { "$ref": "#/components/schemas/phone.user" }, "public_id": { "$ref": "#/components/schemas/public_id.user" }, "steam_id": { "$ref": "#/components/schemas/steam_id.user" }, "tracking_id": { "$ref": "#/components/schemas/tracking_id.user" }, "utm": { "$ref": "#/components/schemas/utm.user" } }, "required": [ "id" ], "type": "object" }, "token": { "example": { "settings": { "currency": "USD", "language": "en", "project_id": 16184, "ui": { "size": "medium" } }, "user": { "email": { "value": "email@example.com" }, "id": { "value": "user_2" }, "name": { "value": "John Smith" } } }, "properties": { "custom_parameters": { "$ref": "#/components/schemas/custom_parameters" }, "purchase": { "$ref": "#/components/schemas/purchase" }, "settings": { "$ref": "#/components/schemas/settings" }, "user": { "$ref": "#/components/schemas/user" } }, "type": "object" }, "mock_code": { "description": "サンドボックスモードでPayPalによる支払い処理をテストする際に再現したいエラーコードです。パラメータに `\"mode\":\"sandbox\"` を渡した場合のみ、正しく動作します。", "enum": [ 1002, 1015, 1039, 1046, 1057, 1089, 1201, 1203, 1801, 1803, 2031, 3006, 3031, 5004 ], "type": "integer" } }, "requestBodies": { "charge-with-saved-account": { "content": { "application/json": { "example": { "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" } }, "schema": { "properties": { "custom_parameters": { "$ref": "#/components/schemas/custom_parameters" }, "purchase": { "description": "購入の詳細を含むオブジェクト。", "properties": { "checkout": { "description": "チェックアウトの詳細（オブジェクト）。", "properties": { "amount": { "description": "購入金額。", "format": "float", "type": "number" }, "currency": { "description": "購入通貨。[ISO 4217](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)に準拠した3文字の通貨コード。", "type": "string" } }, "type": "object" }, "description": { "properties": { "value": { "maxLength": 4000, "type": "string" } }, "type": "object" }, "virtual_currency": { "description": "仮想通貨の詳細を含むオブジェクト。", "properties": { "quantity": { "description": "仮想通貨での購入金額。", "format": "float", "type": "number" } }, "type": "object" } }, "type": "object" }, "settings": { "description": "購入設定（オブジェクト）。", "properties": { "currency": { "$ref": "#/components/schemas/currency" }, "external_id": { "$ref": "#/components/schemas/external_id" }, "mock_code": { "$ref": "#/components/schemas/mock_code" }, "mode": { "description": "決済処理をテストするには、`sandbox`に設定します。実際の決済用にパラメータを削除します。", "type": "string" } }, "type": "object" }, "user": { "description": "ユーザー詳細。", "properties": { "ip": { "description": "ユーザーのIPアドレス。", "type": "string" }, "legal": { "$ref": "#/components/schemas/legal" }, "name": { "description": "ユーザー名。", "type": "string" } }, "required": [ "ip" ], "type": "object" } }, "type": "object" } } }, "required": true } } } }