Успешный платеж

Успешный платежWebhook POST

Когда пользователь успешно совершает оплату, мы отправляем детали о платеже на webhook URL.

Request

Request Body schema: application/json

notification_type

required

string

Тип оповещения.

required

object

Объект с информацией о транзакции, связанной с этой операцией.

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

string <float>

Курс валюты платежа к валюте выплаты.

object

Объект с информацией о затратах на репатриацию, возлагаемых на Иксоллу третьими сторонами.

amount	integer <float> Сумма.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

object

Размер налога (только для США и Канады).

amount	integer <float> Сумма.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.
percent	integer <float> Процент налога.

object

Размер VAT (только для Евросоюза).

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 Email получателя подарка.
receiver_id	string ID получателя подарка.

object

Объект с информацией о заказе. По умолчанию в вебхуке не передается эта информация. Чтобы включить эту функциональность, обратитесь к аккаунт-менеджеру проекта или напишите на am@xsolla.com.

integer

Идентификатор заказа.

object

Объект с информацией о товаре.

object

Объект с информацией о цене товара.

amount	float Общая стоимость товара в валюте.
currency	string Валюта, в которой указана цена товара.

quantity

integer

Количество этого предмета в заказе.

sku

string

Артикул предмета.

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 плана (внешний id, если план был создан через API).
product_id	string ID продукта (если был отправлен в токене).
subscription_id	integer ID подписки в базе данных Иксоллы.
tags	Array of strings Теги плана.

object

Объект, содержащий настройки проекта.

merchant_id	integer ID продавца.
project_id	integer ID игры в Иксолле. Вы можете найти этот параметр в Личном кабинете.

object

Объект с информацией о пользователе.

id required	string ID пользователя.
country	string Страна пользователя. Используется двухбуквенное обозначение страны согласно стандарту ISO 3166-1 alpha-2.
email	string Email пользователя.
ip	string IP адрес пользователя.
name	string Имя пользователя.
phone	string Номер телефона пользователя (в международном формате).
zip	string Почтовый индекс.

Responses

204

Верните, чтобы сообщить об успешной обработке вехбука.

400

Верните в случае ошибки в предоставленной информации (например, обязательный параметр не передан, или авторизация не прошла). В этом случае денежные средства пользователя списываются, но покупка не осуществляется. Чтобы оформить возврат платежа, необходимо обратиться в службу поддержки Иксоллы на support@xsolla.com.

500

Верните, чтобы сообщить о временных ошибках на ваших серверах.

Request samples

Payload
CURL
PHP
HTTP

application/json

{"custom_parameters": { },
"notification_type": "string",
"payment_details": {"direct_wht": {"amount": 0,
"currency": "string",
"percent": 0
},
"payment": {"amount": 0,
"currency": "string"
},
"payment_method_fee": {"amount": 0,
"currency": "string"
},
"payment_method_sum": {"amount": 0,
"currency": "string"
},
"payout": {"amount": 0,
"currency": "string"
},
"payout_currency_rate": "string",
"repatriation_commission": {"amount": 0,
"currency": "string"
},
"sales_tax": {"amount": 0,
"currency": "string",
"percent": 0
},
"vat": {"amount": 0,
"currency": "string",
"percent": 0
},
"xsolla_balance_sum": {"amount": 0,
"currency": "string"
},
"xsolla_fee": {"amount": 0,
"currency": "string"
}
},
"purchase": {"checkout": {"amount": 0,
"currency": "string"
},
"coupon": {"campaign_code": "string",
"coupon_code": "string"
},
"gift": {"giver_id": "string",
"hide_giver_from_receiver": "string",
"message": "string",
"receiver_email": "string",
"receiver_id": "string"
},
"order": {"id": 0,
"lineitems": {"price": {"amount": null,
"currency": "string"
},
"quantity": 0,
"sku": "string"
}
},
"promotions": [{"id": 0,
"technical_name": "string"
}
],
"subscription": {"amount": 0,
"currency": "string",
"date_create": "string",
"date_next_charge": "string",
"plan_id": "string",
"product_id": "string",
"subscription_id": 0,
"tags": ["string"
]
},
"total": {"amount": 0,
"currency": "string"
}
},
"settings": {"merchant_id": 0,
"project_id": 0
},
"transaction": {"agreement": 0,
"dry_run": 0,
"external_id": "string",
"id": 0,
"payment_date": "string",
"payment_method": 0,
"payment_method_name": "string",
"payment_method_order_id": "string"
},
"user": {"country": "string",
"email": "string",
"id": "string",
"ip": "string",
"name": "string",
"phone": "string",
"zip": "string"
}
}

Response samples

application/json

{"error": {"code": "INCORRECT_AMOUNT",
"message": "Incorrect amount"
}
}