Xsolla-logo

User balance: Redeem couponWebhook POST

Sent when a user redeems a coupon to receive virtual items or virtual currency.

Request
Request Body schema: application/json
notification_type
string

Type of notification.

object

Custom project settings (object).

project_id
integer

Game’s Xsolla ID. Can be found in Publisher Account.

merchant_id
integer

Merchant ID.

operation_type
string

Type of operation.

id_operation
integer

Operation ID in Xsolla database.

object

User details (object).

id
required
string

User ID.

name
string

Username

email
string

User email.

object

User balance data (object).

old_value
string

Balance before transaction.

new_value
string

Balance after transaction.

diff
string

Quantity of virtual currency in the purchase.

items_operation_type
string

Type of operation made with virtual items.

items
Array of objects

Virtual items within the purchase.

object

Coupon details (object).

coupon_code
string

Coupon code.

campaign_code
string

Campaign code.

Responses
204

Return to indicate successful processing.

400

Return in case of an error in the provided information (e.g., a required parameter missing, failed authorization, etc.).

500

Return to indicate temporary errors with your servers.

Request samples
application/json
{
  • "notification_type": "string",
  • "settings": {
    },
  • "operation_type": "string",
  • "id_operation": 0,
  • "user": {
    },
  • "virtual_currency_balance": {
    },
  • "items_operation_type": "string",
  • "items": [
    ],
  • "coupon": {
    }
}
Response samples
application/json
{
  • "error": {
    }
}