TicketUserServices

<back to all web services

RefundRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:Tickets.Add
The following routes are available for this service:
POST/refund/process
RefundRequest Parameters:
NameParameterData TypeRequiredDescription
EventIdbodyint?No
RefundAllForEventbodyboolNo
TicketTokenIdsbodyList<string>No
PaymentReferencesbodyList<string>No
ReasonbodystringNo
UserIdbodyint?No
RefundResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
StatusCodeformintNo
MessageformstringNo
RefundedCountformintNo
SkippedCountformintNo
FailedCountformintNo
TotalRefundedformdecimalNo
OutcomesformList<RefundOrderOutcome>No
RefundOrderOutcome Parameters:
NameParameterData TypeRequiredDescription
StatusformstringNo
PaymentReferenceformstringNo
PaymentIdformstringNo
EventIdformint?No
EventNameformstringNo
HolderNameformstringNo
HolderEmailformstringNo
AmountRefundedformdecimalNo
PartialformboolNo
TicketTokenIdsformList<string>No
FreedSeatIdsformList<int>No
BorgunRefundTransactionIdformstringNo
MessageformstringNo

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

{
	eventId: 0,
	refundAllForEvent: False,
	ticketTokenIds: 
	[
		String
	],
	paymentReferences: 
	[
		String
	],
	reason: String,
	userId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	success: False,
	statusCode: 0,
	message: String,
	refundedCount: 0,
	skippedCount: 0,
	failedCount: 0,
	totalRefunded: 0,
	outcomes: 
	[
		{
			status: String,
			paymentReference: String,
			paymentId: String,
			eventId: 0,
			eventName: String,
			holderName: String,
			holderEmail: String,
			amountRefunded: 0,
			partial: False,
			ticketTokenIds: 
			[
				String
			],
			freedSeatIds: 
			[
				0
			],
			borgunRefundTransactionId: String,
			message: String
		}
	]
}