トランザクションを検索する

トランザクションを検索するServer-sideAdmin

get/merchants/{merchant_id}/reports/transactions/search.{format}

特定の検索パラメータに基づくトランザクションのリストを返します。これに応じて、ゲーム内で行われたすべての支払いに関するデータが取得されます。トランザクション期間だけでなく、他のパラメータも指定できます。特定のユーザーまたは特定の支払いステータスによって行われたトランザクションを検索します。JSONまたはCSV形式でリストを取得することができます。

通知

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

SecuritybasicAuth

Request

path Parameters

merchant_id required	integer マーチャントID。
format required	string データ形式。 Enum: "json" "csv" "xls"

query Parameters

datetime_from

string <datetime>

期間開始日。

datetime_to

string <datetime>

期間終了日。

project_id

integer

プロジェクトID。

transaction_id

integer

トランザクションID。

type

string

検索結果に表示される取引のタイプ：

Enum:	Description
all	全ての取引。
canceled	テスト取引を除く、キャンセルされた取引。
test	取引をテストします。
transferred	テスト取引を除く、成功した取引。

phone

string

ユーザーの電話番号（国際形式）。

user_id

string

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

user_name

string

ユーザー名。

user_custom

string

ユーザー識別のためのカスタムパラメータ。

string <= 100 characters

ユーザーのEメール。

external_id

string

ゲーム内のトランザクションID。各ユーザーの支払いに対して一意でなければならなりません。

offset

integer

リスト生成元のエレメントの番号です（カウントは0から始まります）。

limit

integer

ページにあるエレメント数の制限。

status

string

トランザクションステータス。

Enum:	Description
awaitingRefund	この取引は返金の決定待ちです。ユーザーが返金をリクエストした後、エクソーラカスタマーサポートはリクエストを手動で処理し、返金に関する決定を行います。
canceled	次の2つのシナリオがありれます：取引は決済システム側でキャンセルされました。例えば、ユーザーアカウントの資金が不足しているとします。支払いはユーザーに払い戻されました。
created	ユーザーがトランザクションを開始しましたが、まだ処理されていません。
done	トランザクションは正常に処理されました。
error	トランザクションの処理中にエラーが発生しました。このような支払いは、エクソーラカスタマーサポートにお問い合わせいただくことで返金できます。
partiallyRefunded	ユーザーは一部返金を受けました。
processing	トランザクションは処理中です。
refunded	ユーザーのXsolla残高に返金されました。
review	トランザクション処理は不正防止システムによって停止されており、現在追加の検証中です。

Responses

200

OK。

Request samples

Response samples

application/json

[{"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,
"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
}
}
]