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

**GiftCardRedeemRequest** Parameters:
Name	Parameter	Data Type	Required
HoldId	body	int?	No
Code	body	string	No
AmountMinor	body	int?	No
EventId	body	int?	No
TargetOwnerId	body	int?	No
OrderPaymentReference	body	string	No
IdempotencyKey	body	string	No

**GiftCardRedeemResult** Parameters:
Name	Parameter	Data Type	Required
Ok	form	bool	No
Reason	form	string	No
Message	form	LocalizedMessage	No
RedeemedAmountMinor	form	int	No
NewBalanceMinor	form	int	No
TransactionId	form	int?	No
SettlementTag	form	string	No
StatusCode	form	int	No

**LocalizedMessage** Parameters:
Name	Parameter	Data Type	Required	Description
Is	form	string	No
En	form	string	No

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>