TicketUserServices

<back to all web services

GiftCardRedeemRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/GiftCard/Redeem
GiftCardRedeemRequest Parameters:
NameParameterData TypeRequiredDescription
HoldIdbodyint?No
CodebodystringNo
AmountMinorbodyint?No
EventIdbodyint?No
TargetOwnerIdbodyint?No
OrderPaymentReferencebodystringNo
IdempotencyKeybodystringNo
GiftCardRedeemResult Parameters:
NameParameterData TypeRequiredDescription
OkformboolNo
ReasonformstringNo
MessageformLocalizedMessageNo
RedeemedAmountMinorformintNo
NewBalanceMinorformintNo
TransactionIdformint?No
SettlementTagformstringNo
StatusCodeformintNo
LocalizedMessage Parameters:
NameParameterData TypeRequiredDescription
IsformstringNo
EnformstringNo

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

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