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}
GiftCardLedgerRequest Parameters:
NameParameterData TypeRequiredDescription
GiftCardIdpathintNo
GiftCardLedgerResult Parameters:
NameParameterData TypeRequiredDescription
CardformGiftCardSummaryNo
TransactionsformList<GiftCardTransaction>No
StatusCodeformintNo
MessageformstringNo
GiftCardSummary Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
GiftCardTypeIdformintNo
CodeLast4formstringNo
ScopeformstringNo
ScopeOwnerIdformint?No
CurrencyformstringNo
InitialValueMinorformintNo
CurrentBalanceMinorformintNo
StatusformstringNo
ActivatedAtformDateTime?No
ExpiresAtformDateTime?No
CreatedAtformDateTimeNo
BuyerNameformstringNo
BuyerEmailformstringNo
BuyerPhoneformstringNo
PaymentIdformstringNo
PaymentMethodIdformstringNo
PurchasePaymentReferenceformstringNo
GiftCardTransaction Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
GiftCardIdformintNo
KindformstringNo
AmountMinorformintNo
StatusformstringNo
HoldExpiresAtformDateTime?No
RelatedHoldIdformint?No
OrderPaymentReferenceformstringNo
EventIdformint?No
OwnerIdformint?No
IdempotencyKeyformstringNo
CreatedAtformDateTimeNo
NoteformstringNo

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.

GET /GiftCard/Ledger/{GiftCardId} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
		expiresAt: 0001-01-01,
		createdAt: 0001-01-01,
		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-01,
			relatedHoldId: 0,
			orderPaymentReference: String,
			eventId: 0,
			ownerId: 0,
			idempotencyKey: String,
			createdAt: 0001-01-01,
			note: String
		}
	],
	statusCode: 0,
	message: String
}