| Requires any of the roles: | Admin, TeamAdmin | Requires the permission: | ReadData |
| GET | /GiftCard/Ledger/{GiftCardId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GiftCardId | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Card | form | GiftCardSummary | No | |
| Transactions | form | List<GiftCardTransaction> | No | |
| StatusCode | form | int | No | |
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | int | No | |
| GiftCardTypeId | form | int | No | |
| CodeLast4 | form | string | No | |
| Scope | form | string | No | |
| ScopeOwnerId | form | int? | No | |
| Currency | form | string | No | |
| InitialValueMinor | form | int | No | |
| CurrentBalanceMinor | form | int | No | |
| Status | form | string | No | |
| ActivatedAt | form | DateTime? | No | |
| ExpiresAt | form | DateTime? | No | |
| CreatedAt | form | DateTime | No | |
| BuyerName | form | string | No | |
| BuyerEmail | form | string | No | |
| BuyerPhone | form | string | No | |
| PaymentId | form | string | No | |
| PaymentMethodId | form | string | No | |
| PurchasePaymentReference | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | int | No | |
| GiftCardId | form | int | No | |
| Kind | form | string | No | |
| AmountMinor | form | int | No | |
| Status | form | string | No | |
| HoldExpiresAt | form | DateTime? | No | |
| RelatedHoldId | form | int? | No | |
| OrderPaymentReference | form | string | No | |
| EventId | form | int? | No | |
| OwnerId | form | int? | No | |
| IdempotencyKey | form | string | No | |
| CreatedAt | form | DateTime | No | |
| Note | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}