POST api/GiftCardOps/QueryGiftCard
QueryGiftCard returns the available funds on the specified gift card
Request Information
URI Parameters
None.
Body Parameters
QueryGiftCardRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientID | integer |
None. |
|
| CardNumber | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"ClientID": 1,
"CardNumber": "sample string 2"
}
application/xml, text/xml
Sample:
<QueryGiftCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><CardNumber>sample string 2</CardNumber><ClientID>1</ClientID></QueryGiftCardRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
QueryGiftCardResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Balance | decimal number |
None. |
|
| ErrorMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Balance": 2.0,
"ErrorMessage": "sample string 3"
}
application/xml, text/xml
Sample:
<QueryGiftCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><Balance>2</Balance><ErrorMessage>sample string 3</ErrorMessage><Success>true</Success></QueryGiftCardResponse>