TOP

CreateGiftCard()

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 CreateGiftCard() to generate a new Gift Card inside Vin65.  Upon creation the entire gift card is available in the response.  After the card has been created, you can use the UpdateGiftCard() function to add additional parameters. Required fields are indicated by a '*'

Parameters:

Attribute Data Type Default Description
WebsiteID* UUID   Only required for Enterprise Webservices
UUID of the Vin65 Website
Title* String 100    
ExpiryDate Date    
Notes String    
Amount* Numeric    

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLS chema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <CreateGiftCard>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
      <Title>Sample Gift Card Title</Title>
      <Notes>Sample Gift Card Notes</Notes>
      <Amount>100.00</Amount>
    </Request>
  </CreateGiftCard>
</soap:Body>
</soap:Envelope>

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <CreateGiftCardResponse>
    <CreateGiftCardReturn>
      <Errors></Errors> 
      <IsSuccessful>true</IsSuccessful>
      <GiftCard>
        <CardNumber>1066</CardNumber>
        <Code>6TABEHSZZQUSANPX</Code>
        <CurrentBalance>100.00</CurrentBalance>
        <DateAdded>2012-04-17T21:36:34</DateAdded>
        <DateModified>2012-04-17T21:36:34</DateModified>
        <ExpiryDate/>
        <GiftCardID>acd3e3cf-1cc4-81ae-7514-d559e0de28aa</GiftCardID>
        <InitialAmount>100.00</InitialAmount>
        <IsActive>true</IsActive>
        <Notes>Sample Gift Card Notes</Notes>
        <Title>Sample Gift Card Title</Title>
        <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
      </GiftCard>
      <RecordCount>1</RecordCount>
    </CreateGiftCardReturn>
  </CreateGiftCardResponse>
</soapenv:Body>
</soapenv:Envelope>

Page Top