Xsolla-logo

支付Webhook POST

每当用户完成支付流程时,我们都会向您的支付通知脚本发送交易的详细信息。

Request
Request Body schema: application/json
notification_type
required
string

通知类型。

required
object

交易ID。

agreement
integer

协议ID。

dry_run
integer

测试交易。如为测试交易,该参数的值为1;如为真实交易,则不会发送该参数。

external_id
string

交易外部ID。

id
integer

交易ID。

payment_date
string

付款日期。

payment_method
integer

付款方式ID。

payment_method_name
string

付款方式名称。

payment_method_order_id
string

支付系统中的付款ID。

required
object

带有支付详细信息的对象。

object

直接预扣税。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

percent
integer <float>

直接预扣税税率。

object

带有用户支付相关数据的对象。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

支付系统佣金的大小。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

带有通过支付方式收费的金额相关数据的对象。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

带有支出详细信息的对象。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

payout_currency_rate
integer <float>

从支付币种到支出币种的汇率。

object

包含汇回本国费用数据的对象,该费用是第三方对艾克索拉收取的费用。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

销售税(对象;仅适用于美国和加拿大)。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

percent
integer <float>

销售税税率。

object

增值税大小(仅适用于欧盟)。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

percent
integer <float>

VAT税率。

object

计入艾克索拉余额的金额。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

艾克索拉费用(对象)。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

custom_parameters
object

您的自定义参数。

object

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

required
object

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

amount
integer <float>

总购买金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

带有结账参数相关数据的对象。

amount
integer <float>

购买金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

带有优惠券相关数据的对象(如果此交易使用了优惠券)。

campaign_code
string

优惠券营销活动的代码。

coupon_code
string

优惠券代码。

object

礼物详情(对象)。

giver_id
string

送礼人ID。

hide_giver_from_receiver
string

是否对收礼人隐藏送礼人的身份信息。

message
string

送礼人留言。

receiver_email
string

收礼人邮箱。

receiver_id
string

收礼人ID。

object
Deprecated

游戏密钥(数组)。

amount
integer <float>
Deprecated

PIN 码的价格。

currency
string
Deprecated

货币。符合ISO 4217的三字母货币代码。

digital_content
string
Deprecated

在发布商帐户中设置的游戏SKU。

drm
string
Deprecated

用于分发游戏的DRM平台。请确保已在您的发布者帐户中配置了所需的DRM平台。

Enum: "steam" "playstation" "xbox" "uplay" "origin" "drmfree" "gog" "epicgames" "nintendo_eshop" "discord_game_store" "oculus"
object
Deprecated

包含升级数据的对象。

amount
integer <float>
Deprecated

以实际货币表示的价格。

currency
string
Deprecated

货币。符合ISO 4217的三字母货币代码。

object
Deprecated

包含套餐数据的对象,用户从该套餐升级。

DRM
string
Deprecated

游戏DRM平台。

digital_content
string
Deprecated

在发布商帐户中设置的游戏SKU。

object
Deprecated

包含套餐数据的对象,用户升级到该套餐。

DRM
string
Deprecated

游戏DRM平台。

digital_content
string
Deprecated

在发布商帐户中设置的游戏SKU。

Array of objects

应用于此交易的促销活动。

Array
id
integer

促销活动 ID。

technical_name
string

促销活动的技术名称。

object

订阅详情(对象)。

amount
integer <float>

以实际货币表示的价格。

currency
string

货币。符合ISO 4217的三字母货币代码。

date_create
string

订阅的创建日期。符合 ISO 8601标准规定的日期与时间。

date_next_charge
string

下次收费的日期。符合ISO 8601标准规定的日期与时间。

plan_id
string

计划ID(如果计划通过API创建,则为外部ID)。

product_id
string

产品ID(如果在访问令牌中发送)。

subscription_id
integer

艾克索拉数据库的订阅ID。

tags
Array of strings

计划标签。

object
Deprecated

带有购买虚拟货币相关数据的对象。

amount
integer <float>
Deprecated

以实际货币表示的价格。

currency
string
Deprecated

货币。符合ISO 4217的三字母货币代码。

name
string
Deprecated

虚拟货币名称。

quantity
integer <float>
Deprecated

数量。

sku
string
Deprecated

虚拟货币包 SKU(如果针对虚拟货币包设置)。

object
Deprecated

带有购买的虚拟物品相关数据的对象。

amount
integer <float>
Deprecated

购买金额。

currency
string
Deprecated

货币。符合ISO 4217的三字母货币代码。

Array of objects
Deprecated
Array
amount
integer <float>
Deprecated

物品数量。

sku
string
Deprecated

物品ID。

object

带有自定义项目设置的对象。

merchant_id
integer

商户ID。

project_id
integer

游戏的艾克索拉ID。可以在发布商帐户中找到该ID。

object

用户详情(对象)。

id
required
string

用户ID。

country
string

用户所在国家/地区。使用ISO 3166-1 alpha-2 标准规定的2字母组合表示国家/地区。

email
string

用户电子邮件。

ip
string

用户 IP 地址。

name
string

用户名

phone
string

用户电话号码(采用国际格式)。

zip
string

邮编。

Responses
204

返回以指示处理成功。

400

提供的信息出错时返回(例如,缺少必需的参数、授权失败等)。

500

返回以指示您的服务器存在的暂时性错误。

Request samples
application/json
{
  • "custom_parameters": { },
  • "notification_type": "string",
  • "payment_details": {
    },
  • "purchase": {
    },
  • "settings": {
    },
  • "transaction": {
    },
  • "user": {
    }
}
Response samples
application/json
{
  • "error": {
    }
}