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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0,"ownerId":0,"reason":"String","userId":0,"idempotencyKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"success":false,"statusCode":0,"message":"String","result":"String","ownerCardId":0,"ownerId":0,"orderReference":"String","paymentReference":"String","previousPaymentStatus":"String","paymentStatus":"String","cardRefundAmount":0,"giftCreditAmount":0,"giftCreditPendingAmount":0,"totalRefunded":0,"donationAmountNotRefunded":0,"borgunRefunded":false,"borgunPartial":false,"borgunRefundTransactionId":"String","merchantCredentials":"String","replayed":false,"refundId":0,"refundedUTC":"0001-01-01T00:00:00.0000000"}