TOP

GetGiftCardBalance()

Part Of: Gift Card Webservice 3.0

WSDL:

https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl

Australian URL:

https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl

Description:

Use the GetGiftCardBalance() function to return a single gift card's balance. Required fields are indicated by a '*'

Parameters:

Attribute Data Type Default Description
WebsiteID UUID   Available For Enterprise Webservices
UUID of the Vin65 Website
Not necessary if GiftCardID is present
Useful if searching by CardNumber or Code
and CardNumber or Code is not unique across Enterprise
GiftCardID* UUID   UUID of the Vin65 Gift Card
One of either the GiftCardID, CardNumber, or Code is required.
CardNumber* Integer   One of either the GiftCardID, CardNumber, or Code is required.
Code* String 50   One of either the GiftCardID, CardNumber, or Code is required.

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <GetGiftCard> 
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteID>02FC83E3-5EB4-4AA7-A64A-9710BFD9A12A</WebsiteID>
      <Code>6TABEHSZZQUSANPX</Code>
    </Request>
  </GetGiftCard>
</soap:Body>
</soap:Envelope>  

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.x mlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <GetGiftCardBalanceResponse>
    <GetGiftCardBalanceReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <Balance>100.00</Balance>
      <RecordCount>1</RecordCount>
    </GetGiftCardBalanceReturn>
  </GetGiftCardBalanceResponse>
</soapenv:Body>
</soapenv:Envelope> 

Page Top