LevelUp

LevelUp Transactions

The LevelUp web service provides processing through the LevelUp mobile payment network.

 

Service Information

Service Endpoint - https://ps1.merchantware.net/Merchantware/ws/RetailTransaction/v4/LevelUp.asmx

Methods

AccountSupportsLevelUp

Determines whether the merchant with the provided credentials has a LevelUp account configured.

Arguments

NameTypeSizeDescription
merchantNamestring1-160The name of the business or organization owning the Merchantware account.
merchantSiteIdstring8-160The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKeystring1-160The software key or password for the site accessing a Merchantware account.

Return Values

A boolean value of true is returned if the merchant has a LevelUp account configured, otherwise false is returned.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/LevelUp/AccountSupportsLevelUp
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>
    <AccountSupportsLevelUp
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/LevelUp/AccountSupportsLevelUp/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
    </AccountSupportsLevelUp>
  </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>
    <AccountSupportsLevelUpResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/LevelUp/">
      <AccountSupportsLevelUpResult>true</AccountSupportsLevelUpResult>
    </AccountSupportsLevelUpResponse>
  </soap:Body>
</soap:Envelope>

Refund

Performs a refund through the LevelUp mobile payment network.

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.
token string 1-100 The token identifier returned from a previous transaction.
invoiceNumber string 0-8 The invoice or order number associated with the transaction.
registerNumber string 0-100 The identifier for the register or point of sale device submitting the transaction.
merchantTransactionId string 0-100 The merchant-defined identifier for the transaction.

Return Values

A LevelUpResponse is returned.

Notes

A LevelUp Refund can also be done through the Credit Refund by Reference Method.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/LevelUp
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>
    <Refund
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/LevelUp/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <token>654982</token>
      <invoiceNumber>ZZS20</invoiceNumber>      
      <registerNumber></registerNumber>
      <merchantTransactionId></merchantTransactionId>
    </Refund>
  </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>
    <RefundResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/LevelUp/">
      <RefundResult>
        <Amount>5.00</Amount>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <AuthorizationCode>MC0110</AuthorizationCode>
        <AvsResponse></AvsResponse>
        <Cardholder></Cardholder>
        <CardNumber></CardNumber>
        <CardType>0</CardType>
        <CustomerCode></CustomerCode>
        <CvResponse></CvResponse>
        <EntryMode>0</EntryMode>
        <ErrorMessage></ErrorMessage>
        <ExtraData></ExtraData>
        <InvoiceNumber></InvoiceNumber>
        <PurchaseOrderNumber></PurchaseOrderNumber>
        <TaxAmount></TaxAmount>
        <Token>1236564</Token>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <TransactionType>7</TransactionType>
        <LevelUpTotal></LevelUpTotal>
        <LevelUpDiscountAmount></LevelUpDiscountAmount>
        <LevelUpChargedAmount></LevelUpChargedAmount>
        <LevelUpTipAmount></LevelUpTipAmount>
        <LevelUpLifetimeTxCount></LevelUpLifetimeTxCount>
      </RefundResult>
    </RefundResponse>
  </soap:Body>
</soap:Envelope>

Sale

Performs a sale through the LevelUp mobile payment network.

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.
amount string (double) 1-100 The amount of the sale.
qrCodeData string 1-500 The complete track data (all tracks) for the payment card returned from a card reader.
invoiceNumber string 0-8 The invoice or order number associated with the transaction.
customerCode string 0-100 The merchant-defined identifier for the customer involved in the transaction.
registerNumber string 0-100 The identifier for the register or point of sale device submitting the transaction.
poNumber string 0-100 The customer-defined identifier declaring a purchase order for the transaction.
taxAmount string (double) 0-100 The declared tax amount of the transaction.
merchantTransactionId string 0-100 The merchant-defined identifier for the transaction.

Return Values

A LevelUpResponse is returned.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/LevelUp
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/LevelUp/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <amount>1.20</amount>
      <qrCode> [qr code data] </qrCode>
      <invoiceNumber>ZZS20</invoiceNumber>      
      <customerCode></customerCode>
      <registerNumber></registerNumber>
      <poNumber></poNumber>
      <taxAmount></taxAmount>
      <merchantTransactionId></merchantTransactionId>
    </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/LevelUp/">
      <SaleResult>
        <Amount>5.00</Amount>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <AuthorizationCode>MC0110</AuthorizationCode>
        <AvsResponse></AvsResponse>
        <Cardholder></Cardholder>
        <CardNumber></CardNumber>
        <CardType>0</CardType>
        <CustomerCode></CustomerCode>
        <CvResponse></CvResponse>
        <EntryMode>0</EntryMode>
        <ErrorMessage></ErrorMessage>
        <ExtraData></ExtraData>
        <InvoiceNumber></InvoiceNumber>
        <PurchaseOrderNumber></PurchaseOrderNumber>
        <TaxAmount></TaxAmount>
        <Token>1236564</Token>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <TransactionType>7</TransactionType>
        <LevelUpTotal></LevelUpTotal>
        <LevelUpDiscountAmount></LevelUpDiscountAmount>
        <LevelUpChargedAmount></LevelUpChargedAmount>
        <LevelUpTipAmount></LevelUpTipAmount>
        <LevelUpLifetimeTxCount></LevelUpLifetimeTxCount>
      </SaleResult>
    </SaleResponse>
  </soap:Body>
</soap:Envelope>

Data Structures

LevelUpResponse

The LevelUpResponse structure encapsulates the results of a Merchantware LevelUp transaction.

Fields

Name Type Description
Amount string (double) The amount of the transaction.
ApprovalStatus string The status of the transaction, whether approved or declined. This value may also have other definitions depending on CardType and context.
AuthorizationCode string Authorization Code issued by the processor upon receipt of a transaction.
AvsResponse string A string describing the result of an AVS lookup.
Cardholder string The Cardholder associated with the payment card used in a transaction.
CardNumber string A string representing the truncated card number of the payment card used in a transaction.
CardType int (CardType) The issuer type of payment card used in a transaction. This value matches up with the CardType enumeration.
CustomerCode string The merchant-defined identifier for the customer involved in the transaction.
CvResponse string A string describing the result of a Card Verification or CVD check.
EntryMode int (POSEntryType) A value from the POSEntryType enumeration indicating the method used to submit a transaction.
ErrorMessage string A message indicating why the transaction could not be processed.
ExtraData string Contains extra information, when applicable.
InvoiceNumber string The invoice or order number associated with the transaction.
PurchaseOrderNumber string This is a client-string declaring the purchase order number for this customer and transaction.
TaxAmount string The declared tax amount of the transaction.
Token string The identifier received by the Merchantware client when a transaction has been issued. This value may be used to lookup a specific transaction in the history log.
TransactionDate string (DateTime, UTC) The date and time when a transaction is issued, in UTC time.
TransactionType int The type of transaction, and this value matches up with the TransactionType enumeration.
LevelUpTotal string Total amount of transaction including the tip amount.
LevelUpDiscountAmount string The amount discounted from the total purchase.
LevelUpChargedAmount string The amount billed to the customer's credit card.
LevelUpTipAmount string The additional tip amount added to the original sale.
LevelUpLifetimeTxCount string The number of times the customer has used LevelUp to make a purchase from the merchant.

References

A LevelUpResponse is returned by these web methods: