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


export class LocalizedMessage
{
    public is?: string;
    public en?: string;

    public constructor(init?: Partial<LocalizedMessage>) { (Object as any).assign(this, init); }
}

export class GiftCardRedeemResult
{
    public ok?: boolean;
    public reason?: string;
    public message?: LocalizedMessage;
    public redeemedAmountMinor?: number;
    public newBalanceMinor?: number;
    public transactionId?: number;
    public settlementTag?: string;
    public statusCode?: number;

    public constructor(init?: Partial<GiftCardRedeemResult>) { (Object as any).assign(this, init); }
}

export class GiftCardRedeemRequest
{
    public holdId?: number;
    public code?: string;
    public amountMinor?: number;
    public eventId?: number;
    public targetOwnerId?: number;
    public orderPaymentReference?: string;
    public idempotencyKey?: string;

    public constructor(init?: Partial<GiftCardRedeemRequest>) { (Object as any).assign(this, init); }
}

TypeScript GiftCardRedeemRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GiftCardRedeemRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AmountMinor>0</AmountMinor>
  <Code>String</Code>
  <EventId>0</EventId>
  <HoldId>0</HoldId>
  <IdempotencyKey>String</IdempotencyKey>
  <OrderPaymentReference>String</OrderPaymentReference>
  <TargetOwnerId>0</TargetOwnerId>
</GiftCardRedeemRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardRedeemResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>
    <En>String</En>
    <Is>String</Is>
  </Message>
  <NewBalanceMinor>0</NewBalanceMinor>
  <Ok>false</Ok>
  <Reason>String</Reason>
  <RedeemedAmountMinor>0</RedeemedAmountMinor>
  <SettlementTag>String</SettlementTag>
  <StatusCode>0</StatusCode>
  <TransactionId>0</TransactionId>
</GiftCardRedeemResult>