| Requires any of the roles: | Admin, TeamAdmin | Requires the permission: | ReadData |
| 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 .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GiftCardLedgerResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<Card>
<ActivatedAt>0001-01-01T00:00:00</ActivatedAt>
<BuyerEmail>String</BuyerEmail>
<BuyerName>String</BuyerName>
<BuyerPhone>String</BuyerPhone>
<CodeLast4>String</CodeLast4>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<Currency>String</Currency>
<CurrentBalanceMinor>0</CurrentBalanceMinor>
<ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
<GiftCardTypeId>0</GiftCardTypeId>
<ID>0</ID>
<InitialValueMinor>0</InitialValueMinor>
<PaymentId>String</PaymentId>
<PaymentMethodId>String</PaymentMethodId>
<PurchasePaymentReference>String</PurchasePaymentReference>
<Scope>String</Scope>
<ScopeOwnerId>0</ScopeOwnerId>
<Status>String</Status>
</Card>
<Message>String</Message>
<StatusCode>0</StatusCode>
<Transactions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
<d2p1:GiftCardTransaction>
<d2p1:AmountMinor>0</d2p1:AmountMinor>
<d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
<d2p1:EventId>0</d2p1:EventId>
<d2p1:GiftCardId>0</d2p1:GiftCardId>
<d2p1:HoldExpiresAt>0001-01-01T00:00:00</d2p1:HoldExpiresAt>
<d2p1:ID>0</d2p1:ID>
<d2p1:IdempotencyKey>String</d2p1:IdempotencyKey>
<d2p1:Kind>String</d2p1:Kind>
<d2p1:Note>String</d2p1:Note>
<d2p1:OrderPaymentReference>String</d2p1:OrderPaymentReference>
<d2p1:OwnerId>0</d2p1:OwnerId>
<d2p1:RelatedHoldId>0</d2p1:RelatedHoldId>
<d2p1:Status>String</d2p1:Status>
</d2p1:GiftCardTransaction>
</Transactions>
</GiftCardLedgerResult>