TicketUserServices

<back to all web services

GiftCardLedgerRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
GET/GiftCard/Ledger/{GiftCardId}

export class GiftCardSummary
{
    public id?: number;
    public giftCardTypeId?: number;
    public codeLast4?: string;
    public scope?: string;
    public scopeOwnerId?: number;
    public currency?: string;
    public initialValueMinor?: number;
    public currentBalanceMinor?: number;
    public status?: string;
    public activatedAt?: string;
    public expiresAt?: string;
    public createdAt?: string;
    public buyerName?: string;
    public buyerEmail?: string;
    public buyerPhone?: string;
    public paymentId?: string;
    public paymentMethodId?: string;
    public purchasePaymentReference?: string;

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

export class GiftCardTransaction
{
    public id?: number;
    public giftCardId?: number;
    public kind?: string;
    public amountMinor?: number;
    public status?: string;
    public holdExpiresAt?: string;
    public relatedHoldId?: number;
    public orderPaymentReference?: string;
    public eventId?: number;
    public ownerId?: number;
    public idempotencyKey?: string;
    public createdAt?: string;
    public note?: string;

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

export class GiftCardLedgerResult
{
    public card?: GiftCardSummary;
    public transactions?: GiftCardTransaction[];
    public statusCode?: number;
    public message?: string;

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

export class GiftCardLedgerRequest
{
    public giftCardId?: number;

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

TypeScript GiftCardLedgerRequest 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.

GET /GiftCard/Ledger/{GiftCardId} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"card":{"id":0,"giftCardTypeId":0,"codeLast4":"String","scope":"String","scopeOwnerId":0,"currency":"String","initialValueMinor":0,"currentBalanceMinor":0,"status":"String","activatedAt":"0001-01-01T00:00:00.0000000","expiresAt":"0001-01-01T00:00:00.0000000","createdAt":"0001-01-01T00:00:00.0000000","buyerName":"String","buyerEmail":"String","buyerPhone":"String","paymentId":"String","paymentMethodId":"String","purchasePaymentReference":"String"},"transactions":[{"id":0,"giftCardId":0,"kind":"String","amountMinor":0,"status":"String","holdExpiresAt":"0001-01-01T00:00:00.0000000","relatedHoldId":0,"orderPaymentReference":"String","eventId":0,"ownerId":0,"idempotencyKey":"String","createdAt":"0001-01-01T00:00:00.0000000","note":"String"}],"statusCode":0,"message":"String"}