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
import java.math.*
import java.util.*
import net.servicestack.client.*


open class RefundRequest
{
    var eventId:Int? = null
    var refundAllForEvent:Boolean? = null
    var ticketTokenIds:ArrayList<String> = ArrayList<String>()
    var paymentReferences:ArrayList<String> = ArrayList<String>()
    var reason:String? = null
    var userId:Int? = null
}

open class RefundResult
{
    var success:Boolean? = null
    var statusCode:Int? = null
    var message:String? = null
    var refundedCount:Int? = null
    var skippedCount:Int? = null
    var failedCount:Int? = null
    var totalRefunded:BigDecimal? = null
    var outcomes:ArrayList<RefundOrderOutcome> = ArrayList<RefundOrderOutcome>()
}

open class RefundOrderOutcome
{
    var status:String? = null
    var paymentReference:String? = null
    var paymentId:String? = null
    var eventId:Int? = null
    var eventName:String? = null
    var holderName:String? = null
    var holderEmail:String? = null
    var amountRefunded:BigDecimal? = null
    var partial:Boolean? = null
    var ticketTokenIds:ArrayList<String> = ArrayList<String>()
    var freedSeatIds:ArrayList<Int> = ArrayList<Int>()
    var borgunRefundTransactionId:String? = null
    var message:String? = null
}

Kotlin RefundRequest 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 /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
		}
	]
}