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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class RefundOrderOutcome
            Public Sub New()
                TicketTokenIds = New List(Of String)
                FreedSeatIds = New List(Of Integer)
            End Sub

            Public Overridable Property Status As String
            Public Overridable Property PaymentReference As String
            Public Overridable Property PaymentId As String
            Public Overridable Property EventId As Nullable(Of Integer)
            Public Overridable Property EventName As String
            Public Overridable Property HolderName As String
            Public Overridable Property HolderEmail As String
            Public Overridable Property AmountRefunded As Decimal
            Public Overridable Property Partial As Boolean
            Public Overridable Property TicketTokenIds As List(Of String)
            Public Overridable Property FreedSeatIds As List(Of Integer)
            Public Overridable Property BorgunRefundTransactionId As String
            Public Overridable Property Message As String
        End Class

        Public Partial Class RefundRequest
            Public Sub New()
                TicketTokenIds = New List(Of String)
                PaymentReferences = New List(Of String)
            End Sub

            Public Overridable Property EventId As Nullable(Of Integer)
            Public Overridable Property RefundAllForEvent As Boolean
            Public Overridable Property TicketTokenIds As List(Of String)
            Public Overridable Property PaymentReferences As List(Of String)
            Public Overridable Property Reason As String
            Public Overridable Property UserId As Nullable(Of Integer)
        End Class

        Public Partial Class RefundResult
            Public Sub New()
                Outcomes = New List(Of RefundOrderOutcome)
            End Sub

            Public Overridable Property Success As Boolean
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
            Public Overridable Property RefundedCount As Integer
            Public Overridable Property SkippedCount As Integer
            Public Overridable Property FailedCount As Integer
            Public Overridable Property TotalRefunded As Decimal
            Public Overridable Property Outcomes As List(Of RefundOrderOutcome)
        End Class
    End Namespace
End Namespace

VB.NET 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
		}
	]
}