Promotion Payout | Staging Site

Pays out a promotion, campaign, or system prize to a player. This method does not require a player token, as it may occur outside the context of a game session. A promotion payout cannot be rolled back.

POST /v1/promotion

Headers: X-HMAC-Signature, X-Request-ID

Request

Request Parameters

Field	Required/Optional	Data Type	Description
playerId	Required	string	Unique identifier for the player.
transactionId	Required	string	Unique identifier for this transaction. This is treated as the idempotency key.
amount	Required	decimal	Amount to credit, in the player's currency.
promotionInfo	Optional	object	Details about the promotion or prize.

Request Example

JSON

{
  "playerId": "44-12345-67890",
  "transactionId": "guid/uuid/string",
  "amount": 150.00,
  "promotionInfo": {
    "promotionName": "July Mega Drop",
    "promotionType": "prizeDrop"
  }
}

promotionInfo object

Field	Required/Optional	Data Type	Description
promotionType	Optional	enum	Type of transaction. Possible values: `prizeDrop`
promotionName	Optional	string	Short, display name for the promotion.

Response

Response Parameters

Field	Required/Optional	Data Type	Description
balance	Required	decimal	Current balance of the player, in player’s currency.

Response Example

JSON

{
  "balance": 1480.50
}