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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<RefundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <EventId>0</EventId>
  <PaymentReferences xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PaymentReferences>
  <Reason>String</Reason>
  <RefundAllForEvent>false</RefundAllForEvent>
  <TicketTokenIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TicketTokenIds>
  <UserId>0</UserId>
</RefundRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RefundResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <FailedCount>0</FailedCount>
  <Message>String</Message>
  <Outcomes>
    <RefundOrderOutcome>
      <AmountRefunded>0</AmountRefunded>
      <BorgunRefundTransactionId>String</BorgunRefundTransactionId>
      <EventId>0</EventId>
      <EventName>String</EventName>
      <FreedSeatIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </FreedSeatIds>
      <HolderEmail>String</HolderEmail>
      <HolderName>String</HolderName>
      <Message>String</Message>
      <Partial>false</Partial>
      <PaymentId>String</PaymentId>
      <PaymentReference>String</PaymentReference>
      <Status>String</Status>
      <TicketTokenIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </TicketTokenIds>
    </RefundOrderOutcome>
  </Outcomes>
  <RefundedCount>0</RefundedCount>
  <SkippedCount>0</SkippedCount>
  <StatusCode>0</StatusCode>
  <Success>false</Success>
  <TotalRefunded>0</TotalRefunded>
</RefundResult>