按货币获取出款细目

Pay Station API (2.0)
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

概览

**版本：**2.0.0
服务器：
- https://api.xsolla.com/api

支付中心通过向用户提供在游戏商店中进行游戏内购买支付时的便捷UI，让合作伙伴实现其游戏变现。要设置支付UI的打开，请参阅这些说明。

Pay Station API提供以下调用组：

令牌 — 包含使用任意用户参数生成令牌以便通过支付UI进行后续支付处理的API调用。
令牌化 — 包含用于在不打开支付UI或无需用户介入的情况下安全处理支付的API调用。
报告— 包含返回用户交易数据、生成报告及获取按货币分类的提现细目。
退款 — 包含请求完全或部分退款的API调用。
测试 — 包含测试拒付过程的API调用。

关于配置支付UI的详细信息，请参阅付款解决方案集成指南。

注：

还可参阅Postman合集下的Xsolla Base API部分来测试用于集成的API调用。

下载 OpenAPI 描述

index.json

index.yaml

服务器

Mock server

https://xsolla.redocly.app/_mock/zh/api/pay-station/

https://api.xsolla.com/merchant/v2/

令牌
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

令牌化
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

报告
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

列示所有报告

请求

获取指定数据范围的财务报告列表。

注意

此API调用不包含project_id路径参数，因此您需要使用在您公司的所有项目中都有效的API密钥来设置授权。

安全

basicAuth

路径

merchant_idinteger必需

商户ID。

查询

datetime_fromstring(datetime)必需

开始日期，使用YYYY-MM-DD格式。如传入了以下任一参数，则此参数非必需：

transfer_id
report_id

示例: datetime_from=2023-02-08

datetime_tostring(datetime)必需

结束日期，使用YYYY-MM-DD格式。如传入了以下任一参数，则此参数非必需：

transfer_id
report_id

datetime_from和datetime_to之间的间隔不得超过92天。

示例: datetime_to=2023-03-08

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/pay-station/merchants/{merchant_id}/reports?datetime_from=2023-02-08&datetime_to=2023-03-08'

响应

OK.

正文application/json

响应

application/json

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

列示所有操作

请求

返回指定时间段内成功和取消的交易的详细信息列表。您可以在响应中获得付款信息，包括费用、税以及订单和用户的数据。您可以获得JSON或CSV格式的列表。您可以使用此 API调用进行财务对账。

注意

此API调用不包含project_id路径参数，因此您需要使用在您公司的所有项目中都有效的API密钥来设置授权。

安全

basicAuth

路径

merchant_idinteger必需

商户ID。

formatstring必需

数据格式。

枚举"json""csv""xls"

查询

datetime_fromstring(datetime)必需

开始日期，使用YYYY-MM-DD格式。如传入了以下任一参数，则此参数非必需：

transfer_id
report_id

示例: datetime_from=2023-02-08

datetime_tostring(datetime)必需

结束日期，使用YYYY-MM-DD格式。如传入了以下任一参数，则此参数非必需：

transfer_id
report_id

datetime_from和datetime_to之间的间隔不得超过92天。

示例: datetime_to=2023-03-08

in_transfer_currencyinteger必需

将所有财务数据转换为支付出账货币（默认使用支付入账货币）。如传入了以下任一参数，则此参数非必需：

transfer_id
report_id

show_totalboolean

是否在报告中包含交易总额。仅适用于CSV格式导出，默认值为true。

merchant_of_recordsstring or null

在册商户。可以是xsolla、merchant或不指定。如果为merchant，则返回通过合作伙伴直接帐户进行的交易。如果为xsolla，则返回非通过合作伙伴直接帐户进行的交易。如未指定，则返回所有交易。

枚举值	描述
merchant	返回通过合作伙伴直接帐户进行的交易。
xsolla	返回非通过合作伙伴直接帐户进行交易。

project_idinteger

项目ID。

show_dry_runboolean

是否包括测试交易。

transfer_idinteger

交易传输 ID。

report_idinteger

财务报告 ID。

offsetinteger

元素编号，从该元素开始生成列表（从0开始数）。

limitinteger

页面上显示的交易数限制。如传入了此参数，则不必传入datetime_from和datetime_to参数。

statusstring

交易状态。

枚举"done""canceled""error""refunded"

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/pay-station/merchants/{merchant_id}/reports/transactions/registry.{format}?datetime_from=2023-02-08&datetime_to=2023-03-08&in_transfer_currency=0&show_total=true&merchant_of_records=xsolla&project_id=0&show_dry_run=true&transfer_id=0&report_id=0&offset=0&limit=0&status=done'

响应

交易列表已成功返回。

正文application/jsonArray [

payment_detailsobject

支付详细信息。

purchaseobject

购买详细信息。

transactionobject

交易数据。

userobject

带用户相关数据的对象。

user_balanceobject

用户余额。

]

响应

application/json

[
  {
    "payment_details": { … },
    "purchase": { … },
    "transaction": { … },
    "user": { … },
    "user_balance": { … }
  }
]

查找交易

请求

根据具体搜索参数返回交易列表。您将在响应中获得游戏中所有付款的数据，包括未成功完成的付款。您不仅可以指定交易时间段，还可以指定其他参数，例如搜索某个用户进行的交易或处于某个付款状态下的交易。您可以获取JSON或CSV格式的列表。

注意

此API调用不包含project_id路径参数，因此您需要使用在您公司的所有项目中都有效的API密钥来设置授权。

安全

basicAuth

路径

merchant_idinteger必需

商户ID。

formatstring必需

数据格式。

枚举"json""csv""xls"

查询

datetime_fromstring(datetime)

日期范围的开始时间。

datetime_tostring(datetime)

日期范围的结束时间。

project_idinteger

项目ID。

transaction_idinteger

交易ID。

typestring

在搜索结果中显示的交易类型：

枚举值	描述
all	所有交易。
canceled	取消的交易（测试交易除外）。
test	测试交易。
transferred	成功的交易（测试交易除外）。

phonestring

用户电话号码（采用国际格式）。

user_idstring

存储在己侧的游戏内唯一用户ID。请确保传入现有用户ID。如遇到错误，请参阅常见问题回答。

user_namestring

用户名。

user_customstring

用户标识的自定义参数。

emailstring<= 100 characters

用户电子邮件。

external_idstring

游戏中的交易ID。值对于每个用户付款必须唯一。

order_idinteger

订单ID。您可以使用它调用获取订单 API方法。

示例: order_id=1234

offsetinteger

元素编号，从该元素开始生成列表（从0开始数）。

limitinteger

页面上元素数量的限制。

statusstring(status.enum)

一种交易状态。

枚举值	描述
awaitingRefund	交易正在等待退款决定。用户申请退款后，艾克索拉客户支持将手动处理该申请并作出决定。
canceled	有两种可能场景：交易被支付系统侧取消。例如用户帐户中资金不足。已对用户退款。
created	用户发起了交易但交易尚未被处理。
done	交易已成功处理。
error	处理交易时发生了错误。此类支付可通过联系艾克索拉客户支持进行退款。
partiallyRefunded	用户收到了部分退款。
processing	交易正在处理中。
refunded	退款已退回用户的艾克索拉余额。
review	交易处理被反欺诈系统暂停，当前正对交易进行额外验核。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/pay-station/merchants/{merchant_id}/reports/transactions/search.{format}?datetime_from=string&datetime_to=string&project_id=0&transaction_id=0&type=all&phone=string&user_id=string&user_name=string&user_custom=string&email=string&external_id=string&order_id=1234&offset=0&limit=0&status=created'

响应

OK.

正文application/json

响应

application/json

[
  {
    "payment_details": { … },
    "payment_system": { … },
    "purchase": { … },
    "transaction": { … },
    "user": { … }
  }
]

查找交易（快速搜索）

请求

在几秒钟内基于特定搜索参数获取交易列表。此为以JSON、CSV或XLS格式返回该数据的查找交易API调用的另一选择。

注意

此API调用不包含project_id路径参数，因此您需要使用在您公司的所有项目中都有效的API密钥来设置授权。

安全

basicAuth

路径

merchant_idinteger必需

商户ID。

查询

transaction_idinteger

交易ID。必须提供此参数或external_id，但不要同时提供两者。

external_idstring

游戏中的交易ID。对每个付款唯一。必须提供此参数或transaction_id，但不要同时提供两者。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/pay-station/merchants/{merchant_id}/reports/transactions/simple_search?transaction_id=0&external_id=string'

响应

交易列表已成功返回。

正文application/jsonArray [

payment_detailsobject

支付详细信息。

transactionobject

交易详细信息。

userobject

带用户相关数据的对象。

]

响应

application/json

[
  {
    "payment_details": { … },
    "transaction": { … },
    "user": { … }
  }
]

按货币获取出款细目

请求

按货币获取出款细目。

注意

此API调用不包含project_id路径参数，因此您需要使用在您公司的所有项目中都有效的API密钥来设置授权。

安全

basicAuth

路径

merchant_idinteger必需

商户ID。

查询

datetime_fromstring(datetime)

日期范围的开始时间。

datetime_tostring(datetime)

日期范围的结束时间。

legal_entity_idinteger

开发者法律实体ID。

statusstring

交易状态。

枚举"done""canceled""error""refunded"

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/pay-station/merchants/{merchant_id}/reports/transactions/summary/transfer?datetime_from=string&datetime_to=string&legal_entity_id=0&status=done'

响应

OK.

正文application/json

响应

application/json

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

获取交易

请求

按ID获取完整交易信息。

注意

此API调用不包含project_id路径参数，因此您需要使用在您公司的所有项目中都有效的API密钥来设置授权。

安全

basicAuth

路径

merchant_idinteger必需

商户ID。

transaction_idinteger必需

交易ID。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/details'

响应

成功返回交易信息。

正文application/jsonArray [

customer_detailsobject

finance_detailsobject

payment_detailsobject

subscription_detailsobject

transaction_detailsobject

]

响应

application/json

[
  {
    "customer_details": { … },
    "finance_details": { … },
    "payment_details": { … },
    "subscription_details": { … },
    "transaction_details": { … }
  }
]

列示所有汇款

请求

列示某个时间段内的所有出款。

注意

此API调用不包含project_id路径参数，因此您需要使用在您公司的所有项目中都有效的API密钥来设置授权。

安全

basicAuth

路径

merchant_idinteger必需

商户ID。

查询

datetime_fromstring(datetime)

日期范围的开始时间。

datetime_tostring(datetime)

日期范围的结束时间。

legal_entity_idinteger

开发者法律实体ID。

statusstring

出款状态。

枚举值	描述
hold	正在等待请求处理。
paid	出款完成。
ready	出款进行中。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/pay-station/merchants/{merchant_id}/reports/transfers?datetime_from=string&datetime_to=string&legal_entity_id=0&status=hold'

响应

OK.

正文application/json

响应

application/json

[
  {
    "canceled": 0,
    "payout": { … },
    "rate": 1,
    "transfer": { … }
  }
]

退款
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

测试
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

操作

Pay Station API (2.0)
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

概览

令牌
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

令牌化
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

报告
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

列示所有报告

请求

响应

这篇文章有帮助吗？

列示所有操作

请求

响应

这篇文章有帮助吗？

查找交易

请求

响应

这篇文章有帮助吗？

查找交易（快速搜索）

请求

响应

这篇文章有帮助吗？

按货币获取出款细目

请求

响应

这篇文章有帮助吗？

获取交易

请求

响应

这篇文章有帮助吗？

列示所有汇款

请求

响应

这篇文章有帮助吗？

退款
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

测试
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

Pay Station API (2.0)复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

概览

令牌复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

令牌化复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

报告复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

列示所有报告

请求

响应

这篇文章有帮助吗？

列示所有操作

请求

响应

这篇文章有帮助吗？

查找交易

请求

响应

这篇文章有帮助吗？

查找交易（快速搜索）

请求

响应

这篇文章有帮助吗？

按货币获取出款细目

请求

响应

这篇文章有帮助吗？

获取交易

请求

响应

这篇文章有帮助吗？

列示所有汇款

请求

响应

这篇文章有帮助吗？

退款复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

测试复制为 LLM 复制将页面复制为 LLM 的 Markdown 格式查看 Markdown以 Markdown 格式打开此页面在 ChatGPT 中打开从 ChatGPT 获取见解在 Claude 中打开从 Claude 获取见解

Pay Station API (2.0)
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

令牌
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

令牌化
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

报告
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

退款
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解

测试
为 LLM 复制
将页面复制为 LLM 的 Markdown 格式
查看 Markdown
以 Markdown 格式打开此页面
在 ChatGPT 中打开
从 ChatGPT 获取见解
在 Claude 中打开
从 Claude 获取见解