跳转到内容

概览

  • **版本:**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 描述
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/pay-station/
https://api.xsolla.com/merchant/v2/
操作

请求

您可以通过任意用户参数创建令牌。您在获取令牌时发送这些参数并在成功支付后会收到发回的参数。令牌只能包含本文档中描述的参数或您预定义的参数。

如果任何参数以不正确的格式或类型发送,将不会获得令牌。作为响应,您将收到422 HTTP代码,JSON正文中有相应的错误描述。在extended_message中,您将收到具体错误参数的相关信息。

默认情况下,令牌有效期是24小时。如要更改该值,请联系您的客户成功经理或发送邮件至csm@xsolla.com。新值将对您公司在发布商帐户中创建的所有项目启用。

注意

调用此API方法后获得的令牌只能用于授权其他请求。只有在集成了订阅产品的情况下才能使用此令牌打开支付UI。

要在新窗口中打开支付UI,请使用以下链接:https://secure.xsolla.com/paystation4/?token={token} ,其中{token}是收到的令牌。

如要进行测试,请使用以下URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}

注意

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

安全
basicAuth
路径
merchant_idinteger必需

商户ID。

正文application/json必需
custom_parametersobject(custom_parameters)

此对象包含配置防欺诈筛选条件的参数。参数列表如下所示。要添加自定义参数,请联系您的客户成功经理或发送邮件至csm@xsolla.com

purchaseobject(purchase)

带有购买相关数据的对象。

settingsobject(settings)

为用户配置支付流程和支付UI的设置。

userobject(user)

带用户相关数据的对象。

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/pay-station/merchants/{merchant_id}/token' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
      }
    }
  }'

响应

Created.

正文application/json
tokenstring
响应
application/json
{ "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT" }
操作
操作
操作
操作