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.

Authorize

The Authorize web method applies an authorization or an incremental authorization to a credit card which can be captured at a later time.

Arguments

Name	Type	Description
Credentials	MerchantCredentials	A MerchantCredentials object used to authenticate against Merchantware.
PaymentData	PaymentData	A PaymentData object containing the payment details of the card used to process the transaction.
Request	AuthorizationRequest	An AuthorizationRequest object containing the transactional data used to create the authorization.

Response

A TransactionResponse46 object is returned.

Allowed Payment Data Sources

Reader, Keyed, Vault, Wallet

Notes

To add a surcharge fee to an authorize transaction, you must meet the eligibility rules; US-issued credit card and surcharging enabled on your merchant account.
To finish committing a transaction, the token obtained from this method should be used with the Capture web method.
You can't increment the amount of an authorization run on an American Express card.
You must follow the card brands' rules for incrementing the amount of an authorization. Our gateway does not:
- Validate the merchant's category code (MCC)
- Enforce the threshold limits of incrementing the amount of an authorization.
  Note: Contact the card brand for their rules about incrementing the amount of an authorization.

Example Keyed 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>
        <Authorize xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>KEYED</Source>
                <CardNumber>************</CardNumber>
                <ExpirationDate>1226</ExpirationDate>
                <CardHolder>Test</CardHolder>
                <AvsStreetAddress>1 Federal Street</AvsStreetAddress>
                <AvsZipCode>02110</AvsZipCode>
                <CardVerificationValue>123</CardVerificationValue>
                <CardPresence>NotPresent</CardPresence>
            </PaymentData>
            <Request>
                <Amount>10.00</Amount>
                <InvoiceNumber>CREDIT12</InvoiceNumber>
                <TaxAmount>0</TaxAmount>
                <PurchaseOrderNumber />
                <ForceDuplicate>False</ForceDuplicate>
                <CardAcceptorTerminalId>42</CardAcceptorTerminalId>
            </Request>
        </Authorize>
    </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>
        <AuthorizeResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <AuthorizeResult>
                <ExtensionPoint>e5469–5943-2e</ExtensionPoint>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971226912</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 1:28:10 PM</TransactionDate>
                <Amount>10.30</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>Test</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>1</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <SurchargeAmount>0.30</SurchargeAmount>
            </AuthorizeResult>
        </AuthorizeResponse>
    </soap12:Body>
</soap12:Envelope>

Example Vault 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>
        <Authorize xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>VAULT</Source>
                <VaultToken>100000101RT2T38BUABU</VaultToken>
            </PaymentData>
            <Request>
                <Amount>15.00</Amount>
                <InvoiceNumber>CREDIT12</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
                <StoredCardReason>Unscheduledmit</StoredCardReason>
            </Request>
        </Authorize>
    </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>
        <AuthorizeResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <AuthorizeResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971226912</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 1:28:10 PM</TransactionDate>
                <Amount>15.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>John Doe</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>8</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin />
            </AuthorizeResult>
        </AuthorizeResponse>
    </soap12:Body>
</soap12:Envelope>

Example Wallet SOAP Request

Note: Amount is not included in the AuthorizeRequest object for Apple Pay. It is part of the EncryptedPaymentData.

Sample Encrypted 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>
        <Authorize xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>Wallet</Source>
                <WalletId>100000101RT2T38BUABU</WalletId>
                <EncryptedPaymentData>ew0KCSJ2ZXJzaW9uIjogIkVDX3YxIiwNCgkiZ</EncryptedPaymentData>
            </PaymentData>
            <Request>
                <InvoiceNumber>CREDIT12</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
            </Request>
        </Authorize>
    </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>
        <AuthorizeResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <AuthorizeResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971321455</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 4:12:02 PM</TransactionDate>
                <Amount>150.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>John Doe</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>7</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin />
            </AuthorizeResult>
        </AuthorizeResponse>
    </soap12:Body>
</soap12:Envelope>

Example Level 3 Transaction 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>
        <Authorize xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>KEYED</Source>
                <CardNumber>4012000033330026</CardNumber>
                <ExpirationDate>0820</ExpirationDate>
                <CardHolder>John Doe</CardHolder>
                <AvsStreetAddress>1 Federal Street</AvsStreetAddress>
                <AvsZipCode>02110</AvsZipCode>
                <CardVerificationValue>123</CardVerificationValue>
                <CardPresence>Present</CardPresence>
            </PaymentData>
            <Request>
                <Amount>25.00</Amount>
                <InvoiceNumber>1</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>1000</MerchantTransactionId>
                <CardAcceptorTerminalId>3</CardAcceptorTerminalId>>
                <EnablePartialAuthorization>True</EnablePartialAuthorization>
                <TaxAmount>0.00</TaxAmount>
                <PurchaseOrderNumber>17801</PurchaseOrderNumber>
                <CustomerCode>20</CustomerCode>
                <Invoice>
                    <TaxIndicator>Provided</TaxIndicator>
                    <ProductDescription>Misc Goods</ProductDescription>
                    <DiscountAmount>1.00</DiscountAmount>
                    <ShippingAmount>6.00</ShippingAmount>
                    <DutyAmount>0.00</DutyAmount>
                    <DestinationPostalCode>06033</DestinationPostalCode>
                    <DestinationCountryCode>840</DestinationCountryCode>
                    <ShipFromPostalCode>06030</ShipFromPostalCode>
                    <LineItems>
                        <LineItem>
                            <CommodityCode>030</CommodityCode>
                            <Description>Misc Good</Description>
                            <Upc>012345678901</Upc>
                            <Quantity>2.5</Quantity>
                            <UnitOfMeasure>kg</UnitOfMeasure>
                            <UnitCost>10.00</UnitCost>
                            <DiscountAmount>0.00</DiscountAmount>
                            <TotalAmount>25.00</TotalAmount>
                            <TaxAmount>0.00</TaxAmount>
                            <ExtendedAmount>25.00</ExtendedAmount>
                            <DebitOrCreditIndicator>Credit</DebitOrCreditIndicator>
                            <NetOrGrossIndicator>Gross</NetOrGrossIndicator>
                        </LineItem>
                    </LineItems>
                </Invoice>
                <CustomerEmailAddress>na@email.com</CustomerEmailAddress>
                <StoreCardInVault>False</StoreCardInVault>
            </Request>
        </Authorize>
    </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>
        <AuthorizeResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <AuthorizeResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971235551</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 1:58:33 PM</TransactionDate>
                <Amount>25.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>John Doe</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>1</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin />
                <Invoice>
                    <TaxIndicator>Provided</TaxIndicator>
                    <ProductDescription>Misc Goods</ProductDescription>
                    <DiscountAmount>1.00</DiscountAmount>
                    <ShippingAmount>6.00</ShippingAmount>
                    <DutyAmount>0.00</DutyAmount>
                    <DestinationPostalCode>06033</DestinationPostalCode>
                    <DestinationCountryCode>840</DestinationCountryCode>
                    <ShipFromPostalCode>06030</ShipFromPostalCode>
                    <LineItems>
                        <LineItem>
                            <CommodityCode>030</CommodityCode>
                            <Description>Misc Good</Description>
                            <Upc>012345678901</Upc>
                            <Quantity>2.5</Quantity>
                            <UnitOfMeasure>kg</UnitOfMeasure>
                            <UnitCost>10.00</UnitCost>
                            <DiscountAmount>0.00</DiscountAmount>
                            <TotalAmount>25.00</TotalAmount>
                            <TaxAmount>0.00</TaxAmount>
                            <ExtendedAmount>25.00</ExtendedAmount>
                            <DebitOrCreditIndicator>Credit</DebitOrCreditIndicator>
                            <NetOrGrossIndicator>Gross</NetOrGrossIndicator>
                        </LineItem>
                    </LineItems>
                </Invoice>
                <CustomerEmailAddress>na@email.com</CustomerEmailAddress>
            </AuthorizeResult>
        </AuthorizeResponse>
    </soap12:Body>
</soap12:Envelope>

Example Initial Storing Card Details 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>
        <Authorize xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>READER</Source>
                <TrackData>TRACKDATA</TrackData>
            </PaymentData>
            <Request>
                <Amount>15.00</Amount>
                <InvoiceNumber>CREDIT12</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
                <StoreCardInVault>True</StoreCardInVault>
                <StoredCardReason>Installment</StoredCardReason>
            </Request>
        </Authorize>
    </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>
        <AuthorizeResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <AuthorizeResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971238639</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 2:07:14 PM</TransactionDate>
                <Amount>15.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>TEST CARD/GENIUS</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>2</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin />
                <VaultBoardingResponse>
                    <VaultToken>100000101RT3C3AZNTGX</VaultToken>
                    <ErrorCode />
                    <ErrorMessage />
                </VaultBoardingResponse>
            </AuthorizeResult>
        </AuthorizeResponse>
    </soap12:Body>
</soap12:Envelope>

Authorize | Global Payments

Policies

Connect

Additional Resources

Authorize

Arguments

Response

Allowed Payment Data Sources

Notes

Sample Request Packet (raw)

Sample Return Packet

Example Vault SOAP Request

Sample Request Packet (raw)

Sample Return Packet

Example Wallet SOAP Request

Sample Encrypted Request Packet (raw)

Sample Return Packet

Example Level 3 Transaction SOAP Request

Sample Request Packet (raw)

Sample Return Packet

Example Initial Storing Card Details Request

Sample Request Packet (raw)

Sample Return Packet

Authorize

Arguments

Response

Allowed Payment Data Sources

Notes

Sample Request Packet (raw)

Sample Return Packet

Example Vault SOAP Request

Sample Request Packet (raw)

Sample Return Packet

Example Wallet SOAP Request

Sample Encrypted Request Packet (raw)

​Sample Return Packet

Example Level 3 Transaction SOAP Request

Sample Request Packet (raw)

Sample Return Packet

Example Initial Storing Card Details Request

Sample Request Packet (raw)

Sample Return Packet

Sample Return Packet