Gift Card

Gift Card Transactions

The Gift Card web services provide payment and loyalty operations for gift cards.

 

Service Information

Service Endpoint - https://ps1.merchantware.net/Merchantware/ws/ExtensionServices/v4/Giftcard.asmx

Methods

ActivateCard

The ActivateCard method activates and add value to a new stored value card.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
amount string (double) 1-100 The dollar amount to be added to the card.
trackData string 1-1000 The complete track data (all tracks) for the payment card returned from a card reader.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/ActivateCard
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ActivateCard xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>5.15</amount>
      <trackData> [magnetic stripe data] </trackData>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </ActivateCard>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ActivateCardResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <ActivateCardResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <Amount>5.15</Amount>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********9640</CardNumber>
        <Type>6</Type>
        <EntryMode>1</EntryMode>
        <ExtraData />
      </ActivateCardResult>
    </ActivateCardResponse>
  </soap:Body>
</soap:Envelope>

ActivateCardKeyed

The ActivateCardKeyed method activates and adds value to a new stored value card.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
amount string (double) 1-100 The dollar amount to be added to the card.
cardNumber string 7-26 The PAN or card number of the payment card.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/ActivateCardKeyed
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ActivateCardKeyed xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>5.15</amount>
      <cardNumber>123456789012345</cardNumber>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </ActivateCardKeyed>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ActivateCardKeyedResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <ActivateCardKeyedResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <Amount>5.15</Amount>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********2345</CardNumber>
        <Type>6</Type>
        <EntryMode>1</EntryMode>
        <ExtraData />
      </ActivateCardKeyedResult>
    </ActivateCardKeyedResponse>
  </soap:Body>
</soap:Envelope>

AddPoints

The AddPoints method add points to a card's point balance.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
amount string (integer) 1-100 The point amount to be added to the card's point balance.
trackData string 1-1000 The complete track data (all tracks) for the payment card returned from a card reader.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftLoyaltyResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/AddPoints
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddPoints xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>50</amount>
      <trackData> [magnetic stripe data] </trackData>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </AddPoints>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddPointsResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <AddPointsResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance />
        <PointsBalance>100</CardBalance>
        <LifePointsBalance>100</CardBalance>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********9640</CardNumber>
        <Type>4</Type>
        <EntryMode>2</EntryMode>
        <ExtraData />
      </AddPointsResult>
    </AddPointsResponse>
  </soap:Body>
</soap:Envelope>

AddPointsKeyed

The AddPointsKeyed method adds points to a card's point balance.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
amount string (integer) 1-100 The point amount to be added to the card's point balance.
cardNumber string 7-26 The PAN or card number of the payment card.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftLoyaltyResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/AddPointsKeyed
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddPointsKeyed xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>50</amount>
      <cardNumber>123456789012345</cardNumber>
      <expirationDate></expirationDate>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </AddPointsKeyed>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddPointsKeyedResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <AddPointsKeyedResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <PointsBalance>100</PointsBalance>
        <LifePointsBalance>200</LifePointsBalance>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********2345</CardNumber>
        <Type>4</Type>
        <EntryMode>1</EntryMode>
        <ExtraData />
      </AddPointsKeyedResult>
    </AddPointsKeyedResponse>
  </soap:Body>
</soap:Envelope>

AddValue

The AddValue method add value to a stored value card.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
amount string (double) 1-100 The dollar amount to be added to the card.
trackData string 1-1000 The complete track data (all tracks) for the payment card returned from a card reader.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/AddValue
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddValue xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>5.15</amount>
      <trackData> [magnetic stripe data] </trackData>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </AddValue>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddValueResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <AddValueResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <Amount>5.15</Amount>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********9640</CardNumber>
        <Type>2</Type>
        <EntryMode>2</EntryMode>
        <ExtraData />
      </AddValueResult>
    </AddValueResponse>
  </soap:Body>
</soap:Envelope>

AddValueKeyed

The AddValueKeyed method adds value to a stored value card.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
amount string (double) 1-100 The dollar amount to be added to the card.
cardNumber string 7-26 The PAN or card number of the payment card.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/AddValueKeyed
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddValueKeyed xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>5.15</amount>
      <cardNumber>123456789012345</cardNumber>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </AddValueKeyed>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddValueKeyedResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <AddValueKeyedResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <Amount>5.15</Amount>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********2345</CardNumber>
        <Type>2</Type>
        <EntryMode>1</EntryMode>
        <ExtraData />
      </AddValueKeyedResult>
    </AddValueKeyedResponse>
  </soap:Body>
</soap:Envelope>

ApplyTip

The ApplyTip web method adds a tip amount to a prior transaction.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
tipAmount string (double) 1-100 The additional tip amount added to the original sale.
token string 1-100 The token identifier returned from a previous sale transaction.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/ApplyTip
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ApplyTip xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>5.15</amount>
      <token>1236559</token>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </ApplyTip>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ApplyTipResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <ApplyTipResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <Amount>5.15</Amount>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********9640</CardNumber>
        <Type>10</Type>
        <EntryMode>1</EntryMode>
        <ExtraData />
      </ApplyTipResult>
    </ApplyTipResponse>
  </soap:Body>
</soap:Envelope>

BalanceInquiry

The BalanceInquiry method inquires the balance of a card.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
trackData string 1-1000 The complete track data (all tracks) for the payment card returned from a card reader.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftLoyaltyResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/BalanceInquiry
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <BalanceInquiry xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <trackData> [magnetic stripe data] </trackData>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </BalanceInquiry>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <BalanceInquiryResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <BalanceInquiryResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <PointsBalance>100</PointsBalance>
        <LifePointsBalance>100</LifePointsBalance>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********9640</CardNumber>
        <Type>5</Type>
        <EntryMode>2</EntryMode>
        <ExtraData />
      </BalanceInquiryResult>
    </BalanceInquiryResponse>
  </soap:Body>
</soap:Envelope>

BalanceInquiryKeyed

The BalanceInquiryKeyed method inquires the balance of a card.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
cardNumber string 7-26 The PAN or card number of the payment card.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftLoyaltyResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/BalanceInquiryKeyed
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <BalanceInquiryKeyed xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <cardNumber>123456789012345</cardNumber>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </BalanceInquiryKeyed>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <BalanceInquiryKeyedResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <BalanceInquiryKeyedResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <PointsBalance>100</CardBalance>
        <LifePointsBalance>200</CardBalance>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********2345</CardNumber>
        <Type>5</Type>
        <EntryMode>1</EntryMode>
        <ExtraData />
      </BalanceInquiryKeyedResult>
    </BalanceInquiryKeyedResponse>
  </soap:Body>
</soap:Envelope>

ForceSale

The ForceSale method withdraws from a card's stored dollar value. If the balance of the card is less than the amount, the full balance of the card will be used.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
amount string (double) 1-100 The dollar amount to withdraw from the card. If the balance is less than the amount, the full balance of the card is used.
trackData string 1-1000 The complete track data (all tracks) for the payment card returned from a card reader.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Tip_Amount string (double) 1-100 Designates this portion of transaction amount as tip.
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/ForceSale
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ForceSale xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>5.15</amount>
      <trackData> [magnetic stripe data] </trackData>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </ForceSale>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ForceSaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <ForceSaleResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <Amount>5.15</Amount>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********9640</CardNumber>
        <Type>19</Type>
        <EntryMode>2</EntryMode>
        <ExtraData />
      </ForceSaleResult>
    </ForceSaleResponse>
  </soap:Body>
</soap:Envelope>

ForceSaleKeyed

The ForceSaleKeyed method dwithdraws from a card's stored dollar value. If the balance of the card is less than the amount, the full balance of the card will be used.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
amount string (double) 1-100 The dollar amount to withdraw from the card. If the balance is less than the amount, the full balance of the card is used.
cardNumber string 7-26 The PAN or card number of the payment card.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Tip_Amount string (double) 1-100 Designates this portion of transaction amount as tip.
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/ForceSaleKeyed
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ForceSaleKeyed xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>5.15</amount>
      <cardNumber>123456789012345</cardNumber>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </ForceSaleKeyed>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ForceSaleKeyedResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <ForceSaleKeyedResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <Amount>5.15</Amount>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********2345</CardNumber>
        <Type>19</Type>
        <EntryMode>1</EntryMode>
        <ExtraData />
      </ForceSaleKeyedResult>
    </ForceSaleKeyedResponse>
  </soap:Body>
</soap:Envelope>

RedeemPoints

The RedeemPoints method withdraws points from a card's point balance.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
amount string (integer) 1-100 The point amount to be withdrawn from the card's point balance.
trackData string 1-1000 The complete track data (all tracks) for the payment card returned from a card reader.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftLoyaltyResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/RedeemPoints
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RedeemPoints xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>50</amount>
      <trackData> [magnetic stripe data] </trackData>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </RedeemPoints>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RedeemPointsResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <RedeemPointsResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance />
        <PointsBalance>100</PointsBalance>
        <LifePointsBalance>100</LifePointsBalance>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********9640</CardNumber>
        <Type>3</Type>
        <EntryMode>2</EntryMode>
        <ExtraData />
      </RedeemPointsResult>
    </RedeemPointsResponse>
  </soap:Body>
</soap:Envelope>

RedeemPointsKeyed

The RedeemPointsKeyed method withdraws points from a card's point balance.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
amount string (integer) 1-100 The point amount to be withdrawn from the card's point balance.
cardNumber string 7-26 The PAN or card number of the payment card.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftLoyaltyResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/RedeemPointsKeyed
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RedeemPointsKeyed; xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>50</amount>
      <cardNumber>123456789012345</cardNumber>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </RedeemPointsKeyed>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RedeemPointsKeyedResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <RedeemPointsKeyedResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance />
        <PointsBalance>100</CardBalance>
        <LifePointsBalance>200</CardBalance>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********2345</CardNumber>
        <Type>3</Type>
        <EntryMode>1</EntryMode>
        <ExtraData />
      </RedeemPointsKeyedResult>
    </RedeemPointsKeyedResponse>
  </soap:Body>
</soap:Envelope>

Sale

The Sale method withdraws value from a stored value card.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
amount string (double) 1-100 The dollar amount to withdraw from the card.
trackData string 1-1000 The complete track data (all tracks) for the payment card returned from a card reader.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Tip_Amount string (double) 1-100 Designates this portion of transaction amount as tip.
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/Sale
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Sale xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>5.15</amount>
      <trackData> [magnetic stripe data] </trackData>
      <extraData>Business_Type=F;Tip_Amount=1.00;Server_ID=1234</extraData>
    </Sale>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <SaleResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <Amount>5.15</Amount>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********9640</CardNumber>
        <Type>1</Type>
        <EntryMode>2</EntryMode>
        <ExtraData />
      </SaleResult>
    </SaleResponse>
  </soap:Body>
</soap:Envelope>

SaleKeyed

The SaleKeyed method withdraws from a card's stored dollar value.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
amount string (double) 1-100 The dollar amount to withdraw from the card.
cardNumber string 7-26 The PAN or card number of the payment card.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Tip_Amount string (double) 1-100 Designates this portion of transaction amount as tip.
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/SaleKeyed
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SaleKeyed xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <amount>5.15</amount>
      <cardNumber>123456789012345</cardNumber>
      <extraData>Business_Type=F;Tip_Amount=1.00;Server_ID=1234</extraData>
    </SaleKeyed>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SaleKeyedResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <SaleKeyedResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <Amount>5.15</Amount>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********2345</CardNumber>
        <Type>1</Type>
        <EntryMode>1</EntryMode>
        <ExtraData />
      </SaleKeyedResult>
    </SaleKeyedResponse>
  </soap:Body>
</soap:Envelope>

TransferBalance

The TransferBalance method transfers balance from one stored value card to another.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
sourceCardNumber string 7-26 The PAN or card number to transfer from.
recipientCardNumber string 7-26 The PAN or card number to transfer to.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/TransferBalance
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <TransferBalance xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <sourceCardNumber>123456789012345</sourceCardNumber>
      <recipientCardNumber>098765432154321</recipientCardNumber>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </TransferBalance>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <TransferBalanceResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <TransferBalanceResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <Amount></Amount>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********4321</CardNumber>
        <Type>9</Type>
        <EntryMode></EntryMode>
        <ExtraData />
      </TransferBalanceResult>
    </TransferBalanceResponse>
  </soap:Body>
</soap:Envelope>

VoidSale

The VoidSale method voids a prior transaction.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
invoiceNumber string 0-100 The invoice or order number associated with the transaction.
token string 1-100 The token identifier returned from a previous sale transaction.
extraData string 0-200 The place to add additional optional parameters to the transaction. Please see Notes for detailed description.

Return Values

A GiftResponse4 is returned.

Notes

The field 'extraData' uses more optional parameters to describe the transaction. It can be left blank if no additional description is needed. The format of this field is "FieldName1=value1;FieldName2=value2". Possible field names are:

Name Type Size Description
Business_Type string R or F R=Retail/Other, F=Restaurant. Default is R.
Clerk_ID string (integer) 1-4 Typically used for non-Restaurant transaction.
Server_ID string (integer) 1-4 Typically used for Restaurant transaction.
Ticket string 1-20 Ticket number for transaction.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/VoidSale
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <VoidSale xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>Transaction1000</invoiceNumber>
      <token>1236559</token>
      <extraData>Clerk_Id=20;Ticket=Ticket100</extraData>
    </VoidSale>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <VoidSaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Giftcard/">
      <VoidSaleResult>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <ResponseMessage>928061</ResponseMessage>
        <MiscMessage />
        <Token>MC0110</Token>
        <TransactionID>Transaction1000</TransactionID>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <Cardholder />
        <CardBalance>100.00</CardBalance>
        <Amount>5.15</Amount>
        <ExpirationDate>080729</ExpirationDate>
        <CardNumber>***********9640</CardNumber>
        <Type>11</Type>
        <EntryMode>1</EntryMode>
        <ExtraData />
      </VoidSaleResult>
    </VoidSaleResponse>
  </soap:Body>
</soap:Envelope>

Data Structures

GiftResponse4

The GiftResponse4 structure encapsulates the results of a gift Merchantware transaction.

Fields

Name Type Description
Amount string (double) The amount of the transaction if it has been approved.
ApprovalStatus string The status of the transaction, whether approved or declined. This value may also have other definitions depending on CardType and context.
CardBalance string (double) The amount balance of the card.
Cardholder string The Cardholder associated with the payment card used in a transaction.
CardNumber string This is a string representing the truncated card number of the payment card used in a transaction.
EntryMode int (POSEntryType) This describes the method used to submit a transaction. This value matches up with the POSEntryType enumeration.
ErrorMessage string This field contains a message describing the reason the transaction could not complete.
ExpirationDate string (Date) The expiration date of the card.
ExtraData string This is a string reserved for future use.
MiscMessage string This is a string to give merchant additional message to display on reseipt.
ResponseMessage string This is a string describing the result of an ApprovalStatus.
Token string This an authorization Code issued by the processor upon receipt of a transaction.
TransactionDate string (DateTime, UTC) The date and time when a transaction is issued, in UTC time.
TransactionID string The TransactionID is The invoice or order number associated with the transaction.
TransactionType int (GiftTransactionType) The type of transaction, and this value matches up with the GiftTransactionType enumeration.

Notes

Card numbers are always truncated when methods return data in this structure.

ApprovalStatus currently may contain the values 'APPROVED' and 'DECLINED'.

Only the value 'APPROVED' will be returned on any approval. It is safe to assume that no charge, refund, or any other action or transfer of value has occurred if you do not receive this return value.

APPROVED

The 'DECLINED' value may be returned on a decline or other failure.

DECLINED

References

A GiftResponse4 is returned by these web methods.

GiftLoyaltyResponse4

The GiftLoyaltyResponse4 structure encapsulates the results of a gift Merchantware loyalty transaction.

Fields

Name Type Description
ApprovalStatus string The status of the transaction, whether approved or declined. This value may also have other definitions depending on CardType and context.
CardBalance string (double) The amount balance of the card.
Cardholder string The Cardholder associated with the payment card used in a transaction.
CardNumber string This is a string representing the truncated card number of the payment card used in a transaction.
EntryMode int (POSEntryType) This describes the method used to submit a transaction. This value matches up with the POSEntryType enumeration.
ErrorMessage string This field contains a message describing the reason the transaction could not complete.
ExpirationDate string (Date) The expiration date of the card.
ExtraData string This is a string reserved for future use.
LifePointsBalance string (integer) The life points balance of the card.

GiftLoyaltyBalances

Complex XML  type

Each balance is optional so GiftLoyaltBalances may contain 1 or more of them. If there are zero balances then the GiftLoyaltyBalances section would not be added to the ExtData.

For example:-

<GiftLoyaltyBalances>

    <Balance>

        <Type> Gift </Type>

        <Value>12.35</Value>

    </Balance>

</GiftLoyaltyBalances>

MiscMessage string This is a string to give merchant additional message to display on receipt.
PointsBalance string (integer) The points balance of the card.
ResponseMessage string This is a string describing the result of an ApprovalStatus.
Token string This an authorization Code issued by the processor upon receipt of a transaction.
TransactionID string The TransactionID is The invoice or order number associated with the transaction.
TransactionDate string (DateTime, UTC) The date and time when a transaction is issued, in UTC time.
TransactionType int (GiftTransactionType) The type of transaction, and this value matches up with the GiftTransactionType enumeration.

Type

string

This identifies the type of balance for example:

Type

Description

Gift

Electronic Gift Card (EGC)

Reward

Retail Merchandise Credit (RMC)

Points  

Points   Electronic Points Bank (EPB)

Frequency          

Frequency           Club Card (CLUB)

Redeemable      

Redeemable       EGC + RMC summed together

Value decimel

The monetary or points value of the account balance.

Notes

Card numbers are always truncated when methods return data in this structure.

ApprovalStatus currently may contain the values 'APPROVED' and 'DECLINED'.

Only the value 'APPROVED' will be returned on any approval. It is safe to assume that no charge, refund, or any other action or transfer of value has occurred if you do not receive this return value.

APPROVED

The 'DECLINED' value may be returned on a decline or other failure.

DECLINED

References

A GiftLoyaltyResponse4 is returned by these web methods.