TicketUserServices

<back to all web services

OwnerCardRefundRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:Tickets.Add
The following routes are available for this service:
POST/OwnerCards/{Id}/refund
OwnerCardRefundRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
OwnerIdbodyintNo
ReasonbodystringNo
UserIdbodyint?No
IdempotencyKeybodystringNo
OwnerCardRefundResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
StatusCodeformintNo
MessageformstringNo
ResultformstringNo
OwnerCardIdformintNo
OwnerIdformintNo
OrderReferenceformstringNo
PaymentReferenceformstringNo
PreviousPaymentStatusformstringNo
PaymentStatusformstringNo
CardRefundAmountformintNo
GiftCreditAmountformintNo
GiftCreditPendingAmountformintNo
TotalRefundedformintNo
DonationAmountNotRefundedformintNo
BorgunRefundedformboolNo
BorgunPartialformboolNo
BorgunRefundTransactionIdformstringNo
MerchantCredentialsformstringNo
ReplayedformboolNo
RefundIdformintNo
RefundedUTCformDateTime?No

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 /OwnerCards/{Id}/refund HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OwnerCardRefundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Id>0</Id>
  <IdempotencyKey>String</IdempotencyKey>
  <OwnerId>0</OwnerId>
  <Reason>String</Reason>
  <UserId>0</UserId>
</OwnerCardRefundRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OwnerCardRefundResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <BorgunPartial>false</BorgunPartial>
  <BorgunRefundTransactionId>String</BorgunRefundTransactionId>
  <BorgunRefunded>false</BorgunRefunded>
  <CardRefundAmount>0</CardRefundAmount>
  <DonationAmountNotRefunded>0</DonationAmountNotRefunded>
  <GiftCreditAmount>0</GiftCreditAmount>
  <GiftCreditPendingAmount>0</GiftCreditPendingAmount>
  <MerchantCredentials>String</MerchantCredentials>
  <Message>String</Message>
  <OrderReference>String</OrderReference>
  <OwnerCardId>0</OwnerCardId>
  <OwnerId>0</OwnerId>
  <PaymentReference>String</PaymentReference>
  <PaymentStatus>String</PaymentStatus>
  <PreviousPaymentStatus>String</PreviousPaymentStatus>
  <RefundId>0</RefundId>
  <RefundedUTC>0001-01-01T00:00:00</RefundedUTC>
  <Replayed>false</Replayed>
  <Result>String</Result>
  <StatusCode>0</StatusCode>
  <Success>false</Success>
  <TotalRefunded>0</TotalRefunded>
</OwnerCardRefundResult>