TicketUserServices

<back to all web services

GiftCardRefundCreditRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/GiftCard/RefundCredit

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 GiftCardRefundCreditRequest
{
    public giftCardId?: number;
    public code?: string;
    public amountMinor?: number;
    public orderPaymentReference?: string;
    public idempotencyKey?: string;
    public note?: string;

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

TypeScript GiftCardRefundCreditRequest 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/RefundCredit HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	giftCardId: 0,
	code: String,
	amountMinor: 0,
	orderPaymentReference: String,
	idempotencyKey: String,
	note: 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
}