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
import Foundation
import ServiceStack

public class GiftCardRedeemRequest : Codable
{
    public var holdId:Int?
    public var code:String?
    public var amountMinor:Int?
    public var eventId:Int?
    public var targetOwnerId:Int?
    public var orderPaymentReference:String?
    public var idempotencyKey:String?

    required public init(){}
}

public class GiftCardRedeemResult : Codable
{
    public var ok:Bool?
    public var reason:String?
    public var message:LocalizedMessage?
    public var redeemedAmountMinor:Int?
    public var newBalanceMinor:Int?
    public var transactionId:Int?
    public var settlementTag:String?
    public var statusCode:Int?

    required public init(){}
}

public class LocalizedMessage : Codable
{
    public var `is`:String?
    public var en:String?

    required public init(){}
}


Swift 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
}