TicketUserServices

GiftCardRedeemRequest

**Requires Authentication**
Requires any of the roles:	Admin, TeamAdmin	Required permission:	Tickets.Add

The following routes are available for this service:
POST	/GiftCard/Redeem

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LocalizedMessage:
    is_: Optional[str] = field(metadata=config(field_name='is'), default=None)
    en: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardRedeemResult:
    ok: Optional[bool] = None
    reason: Optional[str] = None
    message: Optional[LocalizedMessage] = None
    redeemed_amount_minor: Optional[int] = None
    new_balance_minor: Optional[int] = None
    transaction_id: Optional[int] = None
    settlement_tag: Optional[str] = None
    status_code: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardRedeemRequest:
    hold_id: Optional[int] = None
    code: Optional[str] = None
    amount_minor: Optional[int] = None
    event_id: Optional[int] = None
    target_owner_id: Optional[int] = None
    order_payment_reference: Optional[str] = None
    idempotency_key: Optional[str] = None

Python GiftCardRedeemRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GiftCard/Redeem HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	holdId: 0,
	code: String,
	amountMinor: 0,
	eventId: 0,
	targetOwnerId: 0,
	orderPaymentReference: String,
	idempotencyKey: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ok: False,
	reason: String,
	message: 
	{
		is: String,
		en: String
	},
	redeemedAmountMinor: 0,
	newBalanceMinor: 0,
	transactionId: 0,
	settlementTag: String,
	statusCode: 0
}