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
GiftCardRefundCreditRequest Parameters:
NameParameterData TypeRequiredDescription
GiftCardIdbodyint?No
CodebodystringNo
AmountMinorbodyintNo
OrderPaymentReferencebodystringNo
IdempotencyKeybodystringNo
NotebodystringNo
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 .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
}