---
title: "Gift Card Webservice 3.0"
slug: "gift-card-webservice-30"
updated: 2024-04-08T16:14:48Z
published: 2024-04-08T16:14:48Z
canonical: "docs.winedirect.com/gift-card-webservice-30"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.winedirect.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Gift Card Webservice 3.0

### WSDL:

[https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl](https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl)

#### Australian URL:

[https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl](https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl)

### Methods:

**SearchGiftCards()** Use this method to search across gift cards.

**GetGiftCard()** Use this method to get a single gift card.

**GetGiftCardBalance()** Use this method to check the balance on a gift card.

**UpdateGiftCard()** Use this method to update an existing gift card.

**AddGiftCardTransaction()** Use this method to add a transaction to an existing gift card.

**CreateGiftCard()** Use this method to create a new gift card.

# SearchGiftCards()

### Part Of: Gift Card Webservice 3.0

### WSDL:

[https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl](https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl)

#### Australian URL:

[https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl](https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl)

### Description:

Use the SearchGiftCards() function to get the gift cards inside Vin65. Required fields are indicated by a '*'

### Parameters:

| Attribute | Data Type | Default | Description |
| --- | --- | --- | --- |
| WebsiteIDs | UUID List |  | Available for Enterprise Webservices Comma seperated list of WebsiteIDs in Enterprise Leave blank for all Websites |
| GiftCardID | UUID |  | UUID of the Vin65 Gift Card |
| Title | String 100 |  |  |
| CardNumber | Integer |  |  |
| Code | String 50 |  |  |
| IsActive | Boolean |  |  |
| OrderNumber | Integer |  | The order number the gift card was sold on. |
| DateModifiedFrom | DateTime |  |  |
| DateModifiedTo | DateTime |  |  |
| MaxRows | Integer | 100 |  |
| Page | Integer | 1 |  |

### 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>
  <SearchGiftCards>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <GiftCardID></GiftCardID>
      <Title></Title> 
      <CardNumber></CardNumber>
      <Code></Code>
      <IsActive>1</IsActive>
      <OrderNumber></OrderNumber>
      <DateModifiedFrom>2011-01-01T12:21:43</DateModifiedFrom>
      <DateModifiedTo>2011-09-12T12:21:43</DateModifiedTo>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchGiftCards>
</soap:Body>
</soap:Envelope>
```

### Sample Response:

```
 <?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schem as.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <SearchGiftCardsResponse>
    <SearchGiftCardsReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <GiftCards>
        <GiftCard>
          <CardNumber>1066</CardNumber>
          <Code>6TABEHSZZQUSANPX</Code>
          <CurrentBalance>70.00</CurrentBalance>
          <DateAdded>2011-03-02T17:49:32.407Z</DateAdded>
          <DateModified>2011-03-02T17:49:32.407Z</DateModified>
          <ExpiryDate/>
          <GiftCardID>acd3e3cf-1cc4-81ae-7514-d559e0de28aa</GiftCardID>
          <InitialAmount>70.00</InitialAmount>
          <IsActive>true</IsActive>
          <Notes/>
          <Title>Sample Gift Card Title</Title>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </GiftCard>
        <GiftCard>
          <CardNumber>1067</CardNumber>
          <Code>6TABEHSZZQUSANPX</Code>
          <CurrentBalance>75.00</CurrentBalance>
          <DateAdded>2011-03-02T17:56:03.487Z</DateAdded>
          <DateModified>2011-03-02T17:56:03.487Z</DateModified>
          <ExpiryDate/>
          <GiftCardID>ad1e2a90-0695-d7d6-a684-ba7fec9ca015</GiftCardID>
          <InitialAmount>75.00</InitialAmount>
          <IsActive>true</IsActive>
          <Notes>Purchased with order number: 2904</Notes>
          <Title>Sample Gift Card Title</Title>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </GiftCard>
      </GiftCards>
      <RecordCount>2</RecordCount>
    </SearchGiftCardsReturn>
  </SearchGiftCardsResponse>
</soapenv:Body>
</soapenv:Envelope>
```

# GetGiftCard()

### Part Of: Gift Card Webservice 3.0

### WSDL:

[https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl](https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl)

#### Australian URL:

[https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl](https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl)

### Description:

Use the GetGiftCard() function to return a single gift card. 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/XMLSche ma-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.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <GetGiftCardResponse>
    <GetGiftCardReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <GiftCard>
        <CardNumber>1066</CardNumber> 
        <Code>6TABEHSZZQUSANPX</Code>
        <CurrentBalance>70.00</CurrentBalance>
        <DateAdded>2011-03-02T17:49:32.407Z</DateAdded>
        <DateModified>2011-03-02T17:49:32.407Z</DateModified>
        <ExpiryDate/>
        <GiftCardID>acd3e3cf-1cc4-81ae-7514-d559e0de28aa</GiftCardID>
        <InitialAmount>70.00</InitialAmount>
        <IsActive>true</IsActive>
        <Notes/>
        <Title>Sample Gift Card Title</Title>
        <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
      </GiftCard>
      <RecordCount>1</RecordCount>
    </GetGiftCardReturn>
  </GetGiftCardResponse>
</soapenv:Body>
</soapenv:Envelope>
```

# GetGiftCardBalance()

### Part Of: Gift Card Webservice 3.0

### WSDL:

[https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl](https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl)

#### Australian URL:

[https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl](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>
```

# UpdateGiftCard()

### Part Of: Gift Card Webservice 3.0

### WSDL:

[https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl](https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl)

#### Australian URL:

[https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl](https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl)

### Description:

Use the UpdateGiftCard() function to update parameters of the gift card. (Please note you can not adjust the CurrentBalance or Initial Amount through this function - adjust the CurrentBalance by Adding a GiftCard Transaction. Required fields are indicated by a '*'

### Parameters:

| Attribute | Data Type | Default | Description |
| --- | --- | --- | --- |
| WebsiteID | UUID |  |  |
| GiftCardID* | UUID |  | UUID of the Vin65 Gift Card |
| CardNumber | Integer |  |  |
| Code* | String 50 |  |  |
| Title* | String 100 |  |  |
| InitialAmount | Numeric |  | Controlled by Vin65 System |
| CurrentBalance | Numeric |  | Controlled by Vin65 System |
| Notes | String |  |  |
| ExpiryDate | Date |  |  |
| IsActive* | Boolean |  |  |
| DateAdded | DateTime |  | Controlled by Vin65 System |
| DateModified | DateTime |  | Controlled by Vin65 System |

### 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>
  <UpdateGiftCard>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <GiftCard>
        <WebsiteID>02FC83E3-5EB4-4AA7-A64A-9710BFD9A12A</WebsiteID>
        <GiftCardID>acd3e3cf-1cc4-81ae-7 514-d559e0de28aa</GiftCardID>
        <CardNumber>1066</CardNumber>
        <Code>6TABEHSZZQUSANPX</Code>
        <Title>Sample Gift Card Title</Title>
        <Notes>Sample Gift Card Notes</Notes>
        <IsActive>true</IsActive>
      </GiftCard>
    </Request>
  </UpdateGiftCard>
</soap:Body>
</soap:Envelope>
```

### Sample Response:

```
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelo pe/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <UpdateGiftCardResponse>
    <UpdateGiftCardReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <RecordCount>1</RecordCount>
    </UpdateGiftCardReturn>
  </UpdateGiftCardResponse>
</soapenv:Body>
</soapenv:Envelope>
```

# AddGiftCardTransaction()

### Part Of: Gift Card Webservice 3.0

### WSDL:

[https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl](https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl)

#### Australian URL:

[https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl](https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl)

### Description:

Use the AddGiftCardTransaction() function to add a new transaction to the gift card. Required fields are indicated by a '*'

### Parameters:

| Attribute | Data Type | Default | Description |
| --- | --- | --- | --- |
| 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. |
| Amount* | Numeric |  | Requried - Positive amounts will add value to the the gift card. Negative amounts will decrement the value of the gift card. |
| Notes | String 50 |  |  |

### 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>
  <AddGiftCardTransaction>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <Code>6TABEHSZZQUSANPX</Code >
      <Amount>-100.00</Amount>
      <Notes>Sample Gift Card Notes</Notes>
    </Request>
  </AddGiftCardTransaction>
</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>
  <AddGiftCardTransactionResponse>
    <AddGiftCardTransactionReturn> 
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <RecordCount>1</RecordCount>
    </AddGiftCardTransactionReturn>
  </AddGiftCardTransactionResponse>
</soapenv:Body>
</soapenv:Envelope>
```

# CreateGiftCard()

### Part Of: Gift Card Webservice 3.0

### WSDL:

[https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl](https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl)

#### Australian URL:

[https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl](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>
```