POST api/OmsGiftCard/GetGiftCardBalance

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
OrderNumber	string	None.
GiftCardNumber	string	None.
GiftCardPin	string	None.
SiteID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderNumber": "sample string 1",
  "GiftCardNumber": "sample string 2",
  "GiftCardPin": "sample string 3",
  "SiteID": 4
}

application/xml, text/xml

Sample:

<GetGiftCardBalanceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <GiftCardNumber>sample string 2</GiftCardNumber>
  <GiftCardPin>sample string 3</GiftCardPin>
  <OrderNumber>sample string 1</OrderNumber>
  <SiteID>4</SiteID>
</GetGiftCardBalanceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetGiftCardBalanceResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
Amount	decimal number	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "Amount": 2.0,
  "CorrelationId": "sample string 3"
}

application/xml, text/xml

Sample:

<GetGiftCardBalanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <Amount>2</Amount>
  <CorrelationId>sample string 3</CorrelationId>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GetGiftCardBalanceResponse>