Classic WineDirect Documentation

Credit Card Service 3.0

31 Mar 2023
2 Minutes to read

Print
Share
Dark
Light
PDF

Credit Card Service 3.0

Updated on 31 Mar 2023
2 Minutes to read

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Please note: To transfer credit cards securely, the credit card webservices require an extra level of security which include:

Talking to Vin65 to have them activated on your account.
A unique SecretKey and Salt for each webservice user

Without the extra level of security, you will only be able to pull masked credit cards.

WSDL:

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

Australian URL:

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

Methods:

SearchCreditCards()
Use this method to search across credit cards.

GetCreditCard()
Use this method to get a single credit card.

GetCreditCardForOrder()
Use this method to get a single credit card from an order.

AddUpdateCreditCard()
Use this method to add or update an existing credit card.

SearchCreditCards()

Part Of: Credit Card Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

Use the SearchCreditCards() function to get a single credit card or a list of credit cards using the search options listed below. 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
CreditCardID	UUID		UUID of the Vin65 Credit Card
ContactID	UUID		UUID of the Vin65 Contact
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>
  <SearchCreditCards>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <ContactID></ContactID>
      <CreditCardID></CreditCardID>
      <DateModifiedFrom>2011-01- 01T12:21:43</DateModifiedFrom>
      <DateModifiedTo>2011-09-12T12:21:43</DateModifiedTo>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchCreditCards>
</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>
  <SearchCreditCardsResponse>
    <SearchCreditCardsReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <CreditCards>
        <CreditCard>
          <CardExpiryMonth>1</CardExpiryMonth>
          <CardExpiryYear>2012</CardExpiryYear>
          <ContactID>0df30274-e03e-d6dd-6142-8136fba0318c</ContactID>
          <CreditCardID>84ee9991-382e-4b5 4-89f5-f9a579850c85</CreditCardID>
          <CreditCardType>Visa</CreditCardType>
          <DateAdded>2011-03-08T21:22:30.890Z</DateAdded>
          <DateModified>2011-04-19T16:50:12.507Z</DateModified>
          <EncryptedCardNumber>8*- ?#^ASX.4HT!\/Z'/@Y02),EK5&quot;&lt;HB</EncryptedCardNumber>
          <!--Encrypted Card Number only available if enhanced security enabled-->
          <IsPrimary>true</IsPrimary>
          <MaskedCardNumber>************5454</MaskedCardNumber>
          <NameOnCard>John Smith</NameOnCard>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </CreditCard>
      </CreditCards>
      <RecordCount>1</RecordCount>
    </SearchCreditCardsReturn>
  </SearchCreditCardsResponse>
</soapenv:Body>
</soapenv:Envelope>

GetCreditCard()

Part Of: Credit Card Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

Use the GetCreditCard() function to get a single credit card. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Default	Description
CreditCardID*	UUID		UUID of the Vin65 Credit Card

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>
  <GetCreditCard>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <CreditCardID>d1c9c15a-df94-4 d55-adb2-013519b728c7</CreditCardID>
    </Request>
  </GetCreditCard>
</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> 
  <GetCreditCardResponse>
    <GetCreditCardReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <CreditCard>
        <CardExpiryMonth>1</CardExpiryMonth>
        <CardExpiryYear>2012</CardExpiryYear>
        <ContactID>0df30274-e03e-d6dd-6142-8136fba0318c</ContactID>
        <CreditCardID>d1c9c15a-df94-4d55-adb2-013519b728c7</CreditCardID>
        <CreditCardType>Visa</CreditCardType>
        <DateAdded>2011-03-08T21:22:30.890Z</DateAdded>
        <DateModified>2011-04-19T16:50:12.507Z</DateModified>
        <EncryptedCardNumber>8*- ?#^ASX.4HT!\/Z'/@Y02),EK5&quot;&lt;HB</EncryptedCardNumber>
        <!--Encrypted Card Number only available if enhanced security enabled-->
        <IsPrimary>true</IsPrimary>
        <MaskedCardNumber>************5454</MaskedCardNumber>
        <NameOnCard>John Smith</NameOnCard>
        <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
      </CreditCard>
      <RecordCount>1</RecordCount>
    </GetCreditCardReturn>
  </GetCreditCardResponse>
</soapenv:Body>
</soapenv:Envelope>

GetCreditCardForOrder()

Part Of: Credit Card Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

Use the GetCreditCardForOrder() function to get a single credit card from an existing order. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Default	Description
WebsiteID	UUID		Available For Enterprise Webservices UUID of the Vin65 Website
OrderID*	UUID		UUID of the Vin65 Order

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>
  <GetCreditCardForOrder>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <OrderID>d1c9c15a-df94-4 d55-adb2-013519b728c7</OrderID>
    </Request>
  </GetCreditCardForOrder>
</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> 
  <GetCreditCardForOrderResponse>
    <GetCreditCardForOrderReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <OrderCreditCard>
        <CardExpiryMonth>1</CardExpiryMonth>
        <CardExpiryYear>2012</CardExpiryYear>
        <CreditCardType>Visa</CreditCardType>
        <EncryptedCardNumber>8*- ?#^ASX.4HT!\/Z'/@Y02),EK5&quot;&lt;HB</EncryptedCardNumber>
        <!--Encrypted Card Number only available if enhanced security enabled-->
        <MaskedCardNumber>************5454</MaskedCardNumber>
        <NameOnCard>John Smith</NameOnCard>
        <OrderID>d1c9c15a-df94-4d55-adb2-013519b728c7</OrderID>
        <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
      </OrderCreditCard>
      <RecordCount>1</RecordCount>
    </GetCreditCardForOrderReturn>
  </GetCreditCardForOrderResponse>
</soapenv:Body>
</soapenv:Envelope>

AddUpdateCreditCard()

Part Of: Credit Card Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

Use the AddUpdateCreditCard() function to either add a new credit card or update a current credit card. This service is only available if you have enhanced security enabled on your account. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Default	Description
WebsiteID*	UUID		Only required for Enterprise Webservices UUID of the Vin65 Website
CreditCardID	UUID		UUID of the Vin65 Credit Card
ContactID*	UUID		UUID of the Vin65 Contact
CreditCradType*	Enumerated ("Visa", "MasterCard", "AmericanExpress", "Discover", "Diners", "JCB")
EncryptedCardNumber*	String 50		Encrypted Card Number using your webservice Secret Key and Salt
MaskedCardNumber	String 50		Controlled by Vin65 System
CardExpiryMonth*	Integer
CardExpiryYear*	Integer		4 Digit Expiry Year
NameOnCard*	String 50
IsPrimary	Boolean	False
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>
  <AddUpdateCreditCard>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password// </Password>
      </Security>
      <CreditCard>
        <WebsiteID>71e67a5c-2264-112b-b1f4-a6d602ad8bb4</WebsiteID>
        <CreditCardID>43e15e63-2264-112b-b157-70b1cc864227</CreditCardID>
        <ContactID>98dadf28-1cc4-fbb6-2300-d070d82ace9b</ContactID>
        <CreditCardType>Visa</CreditCardType>
        <CardExpiryMonth>8</CardExpiryMonth>
        <CardExpiryYear>2012</CardExpiryYear>
        <EncryptedCardNumber>8*- ?#^ASX.4HT!\/Z'/@Y02),EK5&quot;&lt;HB</EncryptedCardNumber>
        <IsPrimary>false</IsPrimary>
      </CreditCard>
      <Mode>Strict</Mode>
    </Request>
</AddUpdateCreditCard>
</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" xm lns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <AddUpdateCreditCardResponse>
    <AddUpdateCreditCardReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <CreditCardID>43e15e63-2264-112b-b157-70b1cc864227</CreditCardID>
      <RecordCount>1</RecordCount>
    </AddUpdateCreditCardReturn>
  </AddUpdateCreditCardResponse>
</soapenv:Body>
</soapenv:Envelope>

Was this article helpful?

What's Next

Note Webservice