跳转到内容
/
列示已保存的支付帐户

Pay Station API (2.0)

概览

  • **版本：**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/

令牌

操作

令牌化

操作

列示已保存的支付帐户

请求

列示已保存的用户支付帐户。

注：

在沙盒模式下，此API调用只适用于没有3-D Secure功能的测试银行卡。

安全
basicAuth
路径
project_idinteger必需

项目ID。

user_idstring必需

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

查询
modestring

设置为sandbox以测试支付流程。进行真实支付时请移除此参数。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/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 Secure功能的测试银行卡。

注：

您可以在沙盒模式下调用此API方法，方法是在请求中传入测试支付帐户的数据。关于沙盒模式访问和测试场景的详细信息，请参阅说明。

安全
basicAuth
路径
project_idinteger必需

项目ID。

user_idstring必需

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

typestring必需

支付帐户类型。

枚举 值描述
alipayplus_boost

Boost。

alipayplus_cn

支付宝。

alipayplus_dana

DANA。

alipayplus_gcash

GCash。

alipayplus_hk

Alipay HK。

alipayplus_kplus

K PLUS.

alipayplus_maya

Maya。

alipayplus_rabbitlinepay

Rabbit LINE pay。

alipayplus_tng

Touch 'n Go。

alipayplus_truemoney

TrueMoney Wallet。

account_idinteger必需

艾克索拉数据库中已保存的帐户的ID。

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

响应

No Content.

通过已保存的帐户收费

请求

使用已保存的支付帐户收费。

注：

在沙盒模式下，此API调用只适用于没有3-D Secure功能的测试银行卡。

注意

为使API调用正常工作，请配置一个2分钟的超时时间。

安全
basicAuth
路径
project_idinteger必需

项目ID。

user_idstring必需

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

typestring必需

支付帐户类型。

枚举 值描述
alipayplus_boost

Boost。

alipayplus_cn

支付宝。

alipayplus_dana

DANA。

alipayplus_gcash

GCash。

alipayplus_hk

Alipay HK。

alipayplus_kplus

K PLUS.

alipayplus_maya

Maya。

alipayplus_rabbitlinepay

Rabbit LINE pay。

alipayplus_tng

Touch 'n Go。

alipayplus_truemoney

TrueMoney Wallet。

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/zh/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"
    }
  }'

响应

Created.

正文application/json
transaction_idinteger
响应
application/json
{
  "transaction_id": 123458390
}

报告

操作

退款

操作

测试

操作