Appendix: External Gateway Reference

Table 1. Virtual Terminal Payload
Parameter Value Details
userid Gateway user ID Required
password Gateway password

Required

Base64 URL Encoded string

merchantid Gateway vendor/merchant ID Optional
customercode Customer ID for Order/Invoice Required
address Customer Street Address Optional
city Customer City Optional
state Customer State Optional
zip Customer Zip Code Optional
invoice Order number or invoice number associated to request Required
amount Decimal amount of transaction Required
levelIIIdata Level III data

Optional

Base64 string

See the Level III Data section below

urlresponse Response page to post back to after processing

Required

Base64 string

This will be the existing CCIWebResponse.aspx endpoint of the current relay web service

receipts True Hard coded value auto sent for all integrations
redirecttype Self Hard coded value sent for all integrations
sessionid Current web session ID
referencenumber Prior gateway reference number Required for returns or repeat transactions
token Gateway card token Required for Repeat transaction
type Transaction Type

Values:

"auth",

"credit",

"force", "createtoken", "moto", "recurringauth", "return", "repeatsale", "repeatauth", "reversal", "sale", "recurringsale", "void"

CardExpMonth Card expiration month

Optional

MM

CardExpYear

Card expiration

Year

Optional

YY

Level III Data
<LevelIIIData>
            <Header>
                <CustomerCode></CustomerCode>
                <ShiptofromZIPcode></ShiptofromZIPcode>
                <VATinvoicereferencenumber></VATinvoicereferencenumber>
              <VATtaxamountrate></VATtaxamountrate>
              <Freightshippingamount></Freightshippingamount>
              <Dutyamount></Dutyamount>
              <Orderdate></Orderdate>
              <Discountamount></Discountamount>
            </Header>
            <Products>
                <product>
                    <ItemCommodityCode></ItemCommodityCode>
                    <ItemDescription></ItemDescription>
                    <ItemSequenceNumber></ItemSequenceNumber>
                    <LineItemTotal></LineItemTotal>
                    <ProductCode></ProductCode>
                    <Quantity></Quantity>
                    <Selected></Selected>
                    <UnitCost></UnitCost>
                    <UnitofMeasureCode></UnitofMeasureCode>
                </product>
                <product>
                    <ItemCommodityCode></ItemCommodityCode>
                    <ItemDescription></ItemDescription>
                    <ItemSequenceNumber></ItemSequenceNumber>
                    <LineItemTotal></LineItemTotal>
                    <ProductCode></ProductCode>
                    <Quantity></Quantity>
                    <Selected></Selected>
                    <UnitCost></UnitCost>
                    <UnitofMeasureCode></UnitofMeasureCode>
                </product>
            </Products>
</LevelIIIData>
ProcessRecurringSaleRequest
<ProcessRecurringSaleRequest>
              <MerchantId></MerchantId>
              <Password></Password>
              <UserId></UserId>
              <Amount></Amount>
              <AuthorizationNumber></AuthorizationNumber>
              <CardExpirationDate xsi:nil="true" />
              <CardLastFourDigits xsi:nil="true" />
              <CardNumber xsi:nil="true" />
              <CardVerificationNumber xsi:nil="true" />
              <CustomerBillingAddress xsi:nil="true" />
              <CustomerCity xsi:nil="true" />
              <CustomerCode></CustomerCode>
              <CustomerEmailAddress xsi:nil="true" />
              <CustomerPhone xsi:nil="true" />
              <CustomerState xsi:nil="true" />
              <CustomerZipCode xsi:nil="true" />
              <InvoiceDetail></InvoiceDetail>
              <InvoiceNumber></InvoiceNumber>
              <MagneticData xsi:nil="true" />
              <NameOnCard xsi:nil="true" />
              <ReferenceNumber xsi:nil="true" />
              <TaxAmount></TaxAmount>
              <TransactionType></TransactionType>
              <RecurringSaleTokenId></RecurringSaleTokenId>
          </ProcessRecurringSaleRequest>
ProcessCreditCardRequest
<ProcessCreditCardRequest>
              <MerchantId></MerchantId>
              <Password></Password>
              <UserId></UserId>
              <Amount></Amount>
              <AuthorizationNumber></AuthorizationNumber>
              <CardExpirationDate xsi:nil="true" />
              <CardLastFourDigits></CardLastFourDigits>
              <CardNumber xsi:nil="true" />  --token
              <CardVerificationNumber xsi:nil="true" />
              <CustomerBillingAddress />
              <CustomerCity />
              <CustomerCode></CustomerCode>
              <CustomerEmailAddress xsi:nil="true" />
              <CustomerPhone xsi:nil="true" />
              <CustomerState />
              <CustomerZipCode></CustomerZipCode>
              <InvoiceDetail>encoded level III data</InvoiceDetail>
              <InvoiceNumber></InvoiceNumber>
              <MagneticData xsi:nil="true" />
              <NameOnCard xsi:nil="true" />
              <ReferenceNumber></ReferenceNumber>
              <TaxAmount></TaxAmount>
              <TransactionType> </TransactionType>
          </ProcessCreditCardRequest>
SLProcessCreditCardResponse
<SLProcessCreditCardResponse>
              <Message></Message>
              <Result></Result>
              <AutorizationNumber></AutorizationNumber>
              <CardType xsi:nil="true" />
              <ParameterValidationResultList xsi:nil="true" />
              <ReferenceNumber></ReferenceNumber>
              <TraceNumber xsi:nil="true" />
         </SLProcessCreditCardResponse>