| Requires any of the roles: | Admin, TeamAdmin | Requires the permission: | Tickets.Add |
| POST | /OwnerCards/{Id}/refund |
|---|
export class OwnerCardRefundResult
{
public success?: boolean;
public statusCode?: number;
public message?: string;
public result?: string;
public ownerCardId?: number;
public ownerId?: number;
public orderReference?: string;
public paymentReference?: string;
public previousPaymentStatus?: string;
public paymentStatus?: string;
public cardRefundAmount?: number;
public giftCreditAmount?: number;
public giftCreditPendingAmount?: number;
public totalRefunded?: number;
public donationAmountNotRefunded?: number;
public borgunRefunded?: boolean;
public borgunPartial?: boolean;
public borgunRefundTransactionId?: string;
public merchantCredentials?: string;
public replayed?: boolean;
public refundId?: number;
public refundedUTC?: string;
public constructor(init?: Partial<OwnerCardRefundResult>) { (Object as any).assign(this, init); }
}
export class OwnerCardRefundRequest
{
public id?: number;
public ownerId?: number;
public reason?: string;
public userId?: number;
public idempotencyKey?: string;
public constructor(init?: Partial<OwnerCardRefundRequest>) { (Object as any).assign(this, init); }
}
TypeScript OwnerCardRefundRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>