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

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

{
	id: 0,
	ownerId: 0,
	reason: String,
	userId: 0,
	idempotencyKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01
}