GET api/me/incard-balance
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
IncardBalanceOutputModel| Name | Description | Type | Additional information |
|---|---|---|---|
| PointAvailable | decimal number |
None. |
|
| PointGoingToExpired | integer |
None. |
|
| vouchers | Vouchers |
None. |
|
| LoyaltyPointExpiryBucket | Collection of PointExpiryBucket |
None. |
Response Formats
application/json, text/json
Sample:
{
"PointAvailable": 1.0,
"PointGoingToExpired": 2,
"vouchers": {
"vouchers_available": [
{
"VoucherNo": "sample string 1",
"TrxDate": "sample string 2",
"RewardTitle": "sample string 3",
"Amount": "sample string 4",
"InvoiceNo": "sample string 5",
"ValidDate": "sample string 6",
"ExpiryDate": "sample string 7",
"Type": "sample string 8",
"Value": "sample string 9",
"Unit": "sample string 10",
"MinSpdAmt": "sample string 11",
"MaxDisAmt": "sample string 12",
"TerminalID": "sample string 13",
"SalesInv": "sample string 14",
"Description": "sample string 15",
"Status": "sample string 16",
"ShowInApp": "sample string 17",
"Image": "sample string 18"
},
{
"VoucherNo": "sample string 1",
"TrxDate": "sample string 2",
"RewardTitle": "sample string 3",
"Amount": "sample string 4",
"InvoiceNo": "sample string 5",
"ValidDate": "sample string 6",
"ExpiryDate": "sample string 7",
"Type": "sample string 8",
"Value": "sample string 9",
"Unit": "sample string 10",
"MinSpdAmt": "sample string 11",
"MaxDisAmt": "sample string 12",
"TerminalID": "sample string 13",
"SalesInv": "sample string 14",
"Description": "sample string 15",
"Status": "sample string 16",
"ShowInApp": "sample string 17",
"Image": "sample string 18"
}
],
"vouchers_complete": [
{
"VoucherNo": "sample string 1",
"TrxDate": "sample string 2",
"RewardTitle": "sample string 3",
"Amount": "sample string 4",
"InvoiceNo": "sample string 5",
"ValidDate": "sample string 6",
"ExpiryDate": "sample string 7",
"Type": "sample string 8",
"Value": "sample string 9",
"Unit": "sample string 10",
"MinSpdAmt": "sample string 11",
"MaxDisAmt": "sample string 12",
"TerminalID": "sample string 13",
"SalesInv": "sample string 14",
"Description": "sample string 15",
"Status": "sample string 16",
"ShowInApp": "sample string 17",
"Image": "sample string 18"
},
{
"VoucherNo": "sample string 1",
"TrxDate": "sample string 2",
"RewardTitle": "sample string 3",
"Amount": "sample string 4",
"InvoiceNo": "sample string 5",
"ValidDate": "sample string 6",
"ExpiryDate": "sample string 7",
"Type": "sample string 8",
"Value": "sample string 9",
"Unit": "sample string 10",
"MinSpdAmt": "sample string 11",
"MaxDisAmt": "sample string 12",
"TerminalID": "sample string 13",
"SalesInv": "sample string 14",
"Description": "sample string 15",
"Status": "sample string 16",
"ShowInApp": "sample string 17",
"Image": "sample string 18"
}
],
"vouchers_expired": [
{
"VoucherNo": "sample string 1",
"TrxDate": "sample string 2",
"RewardTitle": "sample string 3",
"Amount": "sample string 4",
"InvoiceNo": "sample string 5",
"ValidDate": "sample string 6",
"ExpiryDate": "sample string 7",
"Type": "sample string 8",
"Value": "sample string 9",
"Unit": "sample string 10",
"MinSpdAmt": "sample string 11",
"MaxDisAmt": "sample string 12",
"TerminalID": "sample string 13",
"SalesInv": "sample string 14",
"Description": "sample string 15",
"Status": "sample string 16",
"ShowInApp": "sample string 17",
"Image": "sample string 18"
},
{
"VoucherNo": "sample string 1",
"TrxDate": "sample string 2",
"RewardTitle": "sample string 3",
"Amount": "sample string 4",
"InvoiceNo": "sample string 5",
"ValidDate": "sample string 6",
"ExpiryDate": "sample string 7",
"Type": "sample string 8",
"Value": "sample string 9",
"Unit": "sample string 10",
"MinSpdAmt": "sample string 11",
"MaxDisAmt": "sample string 12",
"TerminalID": "sample string 13",
"SalesInv": "sample string 14",
"Description": "sample string 15",
"Status": "sample string 16",
"ShowInApp": "sample string 17",
"Image": "sample string 18"
}
],
"count": 1
},
"LoyaltyPointExpiryBucket": [
{
"AvailablePoint": 1,
"ExpiringIn": "sample string 2"
},
{
"AvailablePoint": 1,
"ExpiringIn": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<IncardBalanceOutputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.Property.API.Models">
<LoyaltyPointExpiryBucket>
<IncardBalanceOutputModel.PointExpiryBucket>
<AvailablePoint>1</AvailablePoint>
<ExpiringIn>sample string 2</ExpiringIn>
</IncardBalanceOutputModel.PointExpiryBucket>
<IncardBalanceOutputModel.PointExpiryBucket>
<AvailablePoint>1</AvailablePoint>
<ExpiringIn>sample string 2</ExpiringIn>
</IncardBalanceOutputModel.PointExpiryBucket>
</LoyaltyPointExpiryBucket>
<PointAvailable>1</PointAvailable>
<PointGoingToExpired>2</PointGoingToExpired>
<vouchers>
<count>1</count>
<vouchers_available>
<IncardBalanceOutputModel.Vouchers.VoucherDetail>
<Amount>sample string 4</Amount>
<Description>sample string 15</Description>
<ExpiryDate>sample string 7</ExpiryDate>
<Image>sample string 18</Image>
<InvoiceNo>sample string 5</InvoiceNo>
<MaxDisAmt>sample string 12</MaxDisAmt>
<MinSpdAmt>sample string 11</MinSpdAmt>
<RewardTitle>sample string 3</RewardTitle>
<SalesInv>sample string 14</SalesInv>
<ShowInApp>sample string 17</ShowInApp>
<Status>sample string 16</Status>
<TerminalID>sample string 13</TerminalID>
<TrxDate>sample string 2</TrxDate>
<Type>sample string 8</Type>
<Unit>sample string 10</Unit>
<ValidDate>sample string 6</ValidDate>
<Value>sample string 9</Value>
<VoucherNo>sample string 1</VoucherNo>
</IncardBalanceOutputModel.Vouchers.VoucherDetail>
<IncardBalanceOutputModel.Vouchers.VoucherDetail>
<Amount>sample string 4</Amount>
<Description>sample string 15</Description>
<ExpiryDate>sample string 7</ExpiryDate>
<Image>sample string 18</Image>
<InvoiceNo>sample string 5</InvoiceNo>
<MaxDisAmt>sample string 12</MaxDisAmt>
<MinSpdAmt>sample string 11</MinSpdAmt>
<RewardTitle>sample string 3</RewardTitle>
<SalesInv>sample string 14</SalesInv>
<ShowInApp>sample string 17</ShowInApp>
<Status>sample string 16</Status>
<TerminalID>sample string 13</TerminalID>
<TrxDate>sample string 2</TrxDate>
<Type>sample string 8</Type>
<Unit>sample string 10</Unit>
<ValidDate>sample string 6</ValidDate>
<Value>sample string 9</Value>
<VoucherNo>sample string 1</VoucherNo>
</IncardBalanceOutputModel.Vouchers.VoucherDetail>
</vouchers_available>
<vouchers_complete>
<IncardBalanceOutputModel.Vouchers.VoucherDetail>
<Amount>sample string 4</Amount>
<Description>sample string 15</Description>
<ExpiryDate>sample string 7</ExpiryDate>
<Image>sample string 18</Image>
<InvoiceNo>sample string 5</InvoiceNo>
<MaxDisAmt>sample string 12</MaxDisAmt>
<MinSpdAmt>sample string 11</MinSpdAmt>
<RewardTitle>sample string 3</RewardTitle>
<SalesInv>sample string 14</SalesInv>
<ShowInApp>sample string 17</ShowInApp>
<Status>sample string 16</Status>
<TerminalID>sample string 13</TerminalID>
<TrxDate>sample string 2</TrxDate>
<Type>sample string 8</Type>
<Unit>sample string 10</Unit>
<ValidDate>sample string 6</ValidDate>
<Value>sample string 9</Value>
<VoucherNo>sample string 1</VoucherNo>
</IncardBalanceOutputModel.Vouchers.VoucherDetail>
<IncardBalanceOutputModel.Vouchers.VoucherDetail>
<Amount>sample string 4</Amount>
<Description>sample string 15</Description>
<ExpiryDate>sample string 7</ExpiryDate>
<Image>sample string 18</Image>
<InvoiceNo>sample string 5</InvoiceNo>
<MaxDisAmt>sample string 12</MaxDisAmt>
<MinSpdAmt>sample string 11</MinSpdAmt>
<RewardTitle>sample string 3</RewardTitle>
<SalesInv>sample string 14</SalesInv>
<ShowInApp>sample string 17</ShowInApp>
<Status>sample string 16</Status>
<TerminalID>sample string 13</TerminalID>
<TrxDate>sample string 2</TrxDate>
<Type>sample string 8</Type>
<Unit>sample string 10</Unit>
<ValidDate>sample string 6</ValidDate>
<Value>sample string 9</Value>
<VoucherNo>sample string 1</VoucherNo>
</IncardBalanceOutputModel.Vouchers.VoucherDetail>
</vouchers_complete>
<vouchers_expired>
<IncardBalanceOutputModel.Vouchers.VoucherDetail>
<Amount>sample string 4</Amount>
<Description>sample string 15</Description>
<ExpiryDate>sample string 7</ExpiryDate>
<Image>sample string 18</Image>
<InvoiceNo>sample string 5</InvoiceNo>
<MaxDisAmt>sample string 12</MaxDisAmt>
<MinSpdAmt>sample string 11</MinSpdAmt>
<RewardTitle>sample string 3</RewardTitle>
<SalesInv>sample string 14</SalesInv>
<ShowInApp>sample string 17</ShowInApp>
<Status>sample string 16</Status>
<TerminalID>sample string 13</TerminalID>
<TrxDate>sample string 2</TrxDate>
<Type>sample string 8</Type>
<Unit>sample string 10</Unit>
<ValidDate>sample string 6</ValidDate>
<Value>sample string 9</Value>
<VoucherNo>sample string 1</VoucherNo>
</IncardBalanceOutputModel.Vouchers.VoucherDetail>
<IncardBalanceOutputModel.Vouchers.VoucherDetail>
<Amount>sample string 4</Amount>
<Description>sample string 15</Description>
<ExpiryDate>sample string 7</ExpiryDate>
<Image>sample string 18</Image>
<InvoiceNo>sample string 5</InvoiceNo>
<MaxDisAmt>sample string 12</MaxDisAmt>
<MinSpdAmt>sample string 11</MinSpdAmt>
<RewardTitle>sample string 3</RewardTitle>
<SalesInv>sample string 14</SalesInv>
<ShowInApp>sample string 17</ShowInApp>
<Status>sample string 16</Status>
<TerminalID>sample string 13</TerminalID>
<TrxDate>sample string 2</TrxDate>
<Type>sample string 8</Type>
<Unit>sample string 10</Unit>
<ValidDate>sample string 6</ValidDate>
<Value>sample string 9</Value>
<VoucherNo>sample string 1</VoucherNo>
</IncardBalanceOutputModel.Vouchers.VoucherDetail>
</vouchers_expired>
</vouchers>
</IncardBalanceOutputModel>