For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

Adjust Tip

The AdjustTip web methods adds or alters the tip amount to a prior transaction.

Important: If your merchant account is enabled for surcharging, we recommend not to reduce a tip amount as there is a potential that you could exceed your allowed surcharge percentage.

Arguments

Name	Type	Description
Credentials	MerchantCredentials	A MerchantCredentials object used to authenticate against Merchantware.
Request	TipRequest	A TipRequest object containing the transactional data used to perform a tip adjustment.

Response

A TransactionResponse46 object is returned.

Notes

The AdjustTip method changes the tip amount to a prior sale in the current batch. It is not possible to adjust the tip of a transaction settled in a previous batch.

Example SOAP Request

Sample Request Packet (raw)

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>
        <AdjustTip xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <Request>
                <Token>1971219347</Token>
                <Amount>4.50</Amount>
            </Request>
        </AdjustTip>
    </soap12:Body>
</soap12:Envelope>

Sample Return Packet

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>
        <AdjustTipResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <AdjustTipResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971219433</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 12:56:46 PM</TransactionDate>
                <Amount />
                <RemainingCardBalance />
                <CardNumber />
                <Cardholder />
                <CardType>0</CardType>
                <FsaCard />
                <ReaderEntryMode>0</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <DebitTraceNumber />
            </AdjustTipResult>
        </AdjustTipResponse>
    </soap12:Body>
</soap12:Envelope>

Policies

Connect

Additional Resources