Pular para o conteúdo principal
POST
Redeem Coupon

Autorizações

X-SecretKey
string
header
obrigatório

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Corpo

application/json

Coupon codes can be created for any item, or set of items, in the catalog for the title. This operation causes the coupon to be consumed, and the specific items to be awarded to the user. Attempting to re-use an already consumed code, or a code which has not yet been created in the service, will result in an error.

Coupon codes can be created for any item, or set of items, in the catalog for the title. This operation causes the coupon to be consumed, and the specific items to be awarded to the user. Attempting to re-use an already consumed code, or a code which has not yet been created in the service, will result in an error.

CouponCode
string
obrigatório

Generated coupon code to redeem.

PlayFabId
string
obrigatório

Unique PlayFab assigned ID of the user on whom the operation will be performed.

CatalogVersion
string

Catalog version of the coupon.

CharacterId
string

Optional identifier for the Character that should receive the item. If null, item is added to the player

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Resposta

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Exemplo:
Última modificação em 6 de outubro de 2026