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

export class RefundOrderOutcome
{
    public status?: string;
    public paymentReference?: string;
    public paymentId?: string;
    public eventId?: number;
    public eventName?: string;
    public holderName?: string;
    public holderEmail?: string;
    public amountRefunded?: number;
    public partial?: boolean;
    public ticketTokenIds?: string[];
    public freedSeatIds?: number[];
    public borgunRefundTransactionId?: string;
    public message?: string;

    public constructor(init?: Partial<RefundOrderOutcome>) { (Object as any).assign(this, init); }
}

export class RefundResult
{
    public success?: boolean;
    public statusCode?: number;
    public message?: string;
    public refundedCount?: number;
    public skippedCount?: number;
    public failedCount?: number;
    public totalRefunded?: number;
    public outcomes?: RefundOrderOutcome[];

    public constructor(init?: Partial<RefundResult>) { (Object as any).assign(this, init); }
}

export class RefundRequest
{
    public eventId?: number;
    public refundAllForEvent?: boolean;
    public ticketTokenIds?: string[];
    public paymentReferences?: string[];
    public reason?: string;
    public userId?: number;

    public constructor(init?: Partial<RefundRequest>) { (Object as any).assign(this, init); }
}

TypeScript RefundRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"eventId":0,"refundAllForEvent":false,"ticketTokenIds":["String"],"paymentReferences":["String"],"reason":"String","userId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"success":false,"statusCode":0,"message":"String","refundedCount":0,"skippedCount":0,"failedCount":0,"totalRefunded":0,"outcomes":[{"status":"String","paymentReference":"String","paymentId":"String","eventId":0,"eventName":"String","holderName":"String","holderEmail":"String","amountRefunded":0,"partial":false,"ticketTokenIds":["String"],"freedSeatIds":[0],"borgunRefundTransactionId":"String","message":"String"}]}