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.

EdgeExpress CNP | Global Payments

EdgeExpress CNP

Complete API Spec

Overview

The Edge Express Card Not Present API offers Integrators the ability to process manual-entry Credit Card and ACH transactions. Manual entry is performed on a secure, customizable, web-hosted payment form which can be rendered within a native browser control or iFrame. This hosted service is also ideal for running follow on transactions such as voids or refunds or subsequent sales using a token (Alias) that represents the card or bank account on file within the OpenEdge Vault. Combined with the EdgeExpress API, EdgeExpress merchants have the option of processing both card present and card not present transactions with a single integration API specification.

How Do I Integrate?

1. Application initiates an HTTPS request to EdgeExpress with the minimum required request fields.

2. EdgeExpress will return a Secure Payment URL.

3. The application may fully redirect the consumer or clerk to the Secure Payment URL or Render it within an embedded Browser or an iFrame by pointing the source to the EdgeExpress PayPage URL appended with the value returned in the sealedSetupParameters hidden HTML tag. For example, the full path of an EdgeExpress URL for a specific payment would be similar to: https://ee.paygateway.com/HostPayService/v1/paypage/0TY0poS2mcmoJUHQJkAWlOY4cjo7ZwOqC5RQbpoL

4. The Consumer or Clerk will fill in the Payment Page and submit the transaction for processing.

5. Upon payment completion, EdgeExpress will notify the Partner Application that the Payment has been completed using one of the following methods and depending on the application type.

6. Integrator uses the Payment Details to generate a payment receipt for the consumer.

SaaS Applications

For web based applications, EdgeExpress will post back minimal parameters appended to the RETURNURL, if it is provided in Step 2, to let the partner know that the payment has been completed. Once the application has received the Post to the RETURNURL, it should initiate the Query request to EdgeExpress using the ORDERID to retrieve the transaction details.

Locally Installed Applications

For installed applications using an embedded browser, it is recommended that you use an event listener to detect the value returned in the paymentFinishedSignal hidden HTML tag. After the payment has been completed, EdgeExpress will set the value within this tag to "Done". Once the Application has detected this signal, it should initiate the Query request to EdgeExpress using the ORDERID to retrieve the transaction details.

XML Format

A simple XML format is used for XML request strings. Only one transaction request is allowed in each XML request string. All fields must provide a value.
Example:

<REQUEST> <Field1>Value</Field1> <Field2>Value</Field2> </REQUEST>

EdgeExpress URLs

For all Setup requests and to get the SessionToken (OTK), post to the following URL:

Production (Live) Gateway: https://ee.paygateway.com/HostPayService/v1/hostpay/transactions/
Test Gateway: https://ee.test.paygateway.com/HostPayService/v1/hostpay/transactions/

To retrieve the rendered payment page, post to the following URL:

Production (Live) Gateway: https://ee.paygateway.com/HostPayService/v1/hostpay/paypage/
Test Gateway: https://ee.test.paygateway.com/HostPayService/v1/hostpay/paypage/

For transactions that do not require displaying the payment page, post to the following URL:

Production (Live) Gateway: https://ee.paygateway.com/HostPayService/v1/directpay/express
Test Gateway: https://ee.test.paygateway.com/HostPayService/v1/directpay/express

Credit Card Transactions

Listed below are the request fields REQUIRED for processing a transaction through the EdgeExpress API.

Field	Type	Length	Description
XWEBID	Numeric	12	This is the ID given to the merchant once they have been enrolled in the system. The XWEBID, XWEBTERMINALID, and XWEBAUTHKEY are required for all CREDIT CARD transactions.
XWEBTERMINALID	Numeric	8	This is the ID given to the merchant once they have been enrolled in the system. The XWEBID, XWEBTERMINALID, and XWEBAUTHKEY are required for all CREDIT CARD transactions.
XWEBAUTHKEY	Alphanumeric	32	This is the ID given to the merchant once they have been enrolled in the system. The XWEBID, XWEBTERMINALID, and XWEBAUTHKEY are required for all CREDIT CARD transactions.
ORDERID	Numeric	1-20	Unique transaction identifier designated by the integrating application. The Order ID is also used on queries to retrieve transaction details, as well as processing follow on transactions.
TRANSACTIONTYPE	Defined	Variable	'CREDITSALE', 'CREDITVOID', 'CREDITRETURN', 'CREDITAUTH', 'CREDITONLINECAPTURE'
AMOUNT	Numeric	0.00 -999999.99	The charge total of the transaction. Required for all 'TRANSACTIONTYPE' except 'CREDITVOID' and 'QUERYPAYMENT'.

CREDITSALE - Credit Sale Transaction

Transaction Type used to purchase goods and services in a Card Not Present environment. The Integrator will be provided a "Session Token", which will be used for generation of the Hosted Payment Page.

CREDIT SALE - Request

<REQUEST>
    <XWEBID>800000032599</XWEBID>
    <XWEBTERMINALID>80033511</XWEBTERMINALID>
    <XWEBAUTHKEY>YJev4b2G1xVXj7c2C9BxBCrIFBf9vdTF</XWEBAUTHKEY>
    <TRANSACTIONTYPE>CREDITSALE</TRANSACTIONTYPE>
    <AMOUNT>10.00</AMOUNT>
    <ORDERID>{{$timestamp}}</ORDERID>
    <INVOICENUMBER>{{$timestamp}}</INVOICENUMBER>
    <PONUMBER>{{$timestamp}}</PONUMBER>
    <ADDRESS>321 Test Road</ADDRESS>
    <ZIP>54321</ZIP>
    <CUSTOMEREMAILADDRESS>JohnDoe@Test.com</CUSTOMEREMAILADDRESS>
    <CUSTOMERNAME>John Doe</CUSTOMERNAME>
    <CUSTOMERPHONENUMBER>555-555-5555</CUSTOMERPHONENUMBER>
    <BILLINGADDRESS1>321 Test Road</BILLINGADDRESS1>
    <BILLINGADDRESS2>Suite 123</BILLINGADDRESS2>
    <BILLINGCITY>Salt Lake City</BILLINGCITY>
    <BILLINGSTATE>UT</BILLINGSTATE>
    <BILLINGPOSTALCODE>54321</BILLINGPOSTALCODE>
    <BILLINGCOUNTRY>US</BILLINGCOUNTRY>
    <BILLINGFIRSTNAME>John</BILLINGFIRSTNAME>
    <BILLINGMIDDLENAME>Q</BILLINGMIDDLENAME>
    <BILLINGLASTNAME>Doe</BILLINGLASTNAME>
    <ECI>7</ECI>
    <PARTIALAPPROVALSUPPORT>TRUE</PARTIALAPPROVALSUPPORT>
    <CLERK>Best Employee 1</CLERK>
      <CREATEALIAS>TRUE</CREATEALIAS>
    <ALLOWDUPLICATES>TRUE</ALLOWDUPLICATES>
    <RECEIPTFORMAT>TEXT</RECEIPTFORMAT>
    <RECEIPTCARDHOLDERNAME>Jon Q Doe</RECEIPTCARDHOLDERNAME>
    <RECEIPTCOPYLABEL>BOTH</RECEIPTCOPYLABEL>
    <RECEIPTHEADER>Sale Receipt</RECEIPTHEADER>
    <RECEIPTSTORENAME>My Store Inc.</RECEIPTSTORENAME>
    <RECEIPTADDRESS>123 Happy Street Suite 1</RECEIPTADDRESS>
    <RECEIPTPHONE>555-555-1234</RECEIPTPHONE>
    <RECEIPTLINEITEMS>1 - Sample Product</RECEIPTLINEITEMS>
    <RECEIPTPOLICY>Return Policy - You Have 30 Calendar Days To Return Purchased Items.</RECEIPTPOLICY>
    <RECEIPTFOOTER>Thank You For Your Purchase!</RECEIPTFOOTER>
    <RECEIPTSIGNATURELINE>TRUE</RECEIPTSIGNATURELINE>
    <USERDEFINED1>Optional Data 1</USERDEFINED1>
    <USERDEFINED2>Optional Data 2</USERDEFINED2>
    <USERDEFINED3>Optional Data 3</USERDEFINED3>
    <HOSTPAYSETTING>
                 <POSDEVICE>
                                 <TYPE>KEYED</TYPE>
                 </POSDEVICE>
        <CUSTOMIZATION>
            <BRANDING>
                <BODY>
                    <BACKGROUNDCOLOR>#FFFF00;</BACKGROUNDCOLOR>
                    <COLOR>#0F0F0F;</COLOR>
                    <FONTFAMILY>TIMES NEW ROMAN, HELVETICA-NEUE,HELVETICA,ARIAL,SANS-SERIF;</FONTFAMILY>
                    <FONTSIZE>12PX;</FONTSIZE>
                    <INPUTFIELDHEIGHT />
                </BODY>
            </BRANDING>
        </CUSTOMIZATION>
    </HOSTPAYSETTING>
</REQUEST>

Query Payment - Request

<REQUEST>
    <XWEBID>800000032599</XWEBID>
    <XWEBTERMINALID>80033511</XWEBTERMINALID>
    <XWEBAUTHKEY>YJev4b2G1xVXj7c2C9BxBCrIFBf9vdTF</XWEBAUTHKEY>
    <TRANSACTIONTYPE>QUERYPAYMENT</TRANSACTIONTYPE>
    <ORDERID>246019520191637</ORDERID>
</REQUEST>

Query Payment - Response

<RESULT>
    <ALIAS>UefNbBKDUI</ALIAS>
    <APPROVEDAMOUNT>10.00</APPROVEDAMOUNT>
    <APPROVALCODE>145116</APPROVALCODE>
    <AUTHORIZEDAMOUNT>10.00</AUTHORIZEDAMOUNT>
    <AVSRESPONSECODE>Y</AVSRESPONSECODE>
    <BATCHNO>000004</BATCHNO>
    <ADDRESS1>321 Test Road</ADDRESS1>
    <ADDRESS2>Suite 123</ADDRESS2>
    <BILLINGCITY>Salt Lake City</BILLINGCITY>
    <BILLINGCOUNTRY>US</BILLINGCOUNTRY>
    <BILLINGPOSTALCODE>54321</BILLINGPOSTALCODE>
    <BILLINGSTATE>UT</BILLINGSTATE>
    <CAPTUREDAMOUNT>10.00</CAPTUREDAMOUNT>
    <CARDBRAND>MasterCard</CARDBRAND>
    <CARDCODERESPONSE>M</CARDCODERESPONSE>
    <CARDTYPE>Credit</CARDTYPE>
    <CUSTOMEREMAILADDRESS>JohnDoe@Test.com</CUSTOMEREMAILADDRESS>
    <CUSTOMERNAME>John Doe</CUSTOMERNAME>
    <CUSTOMERPHONENUMBER>555-555-5555</CUSTOMERPHONENUMBER>
    <EXPMONTH>12</EXPMONTH>
    <EXPYEAR>22</EXPYEAR>
    <INDUSTRY>ECOMMERCE</INDUSTRY>
    <MASKEDCARDNUMBER>541333XXXXXX9130</MASKEDCARDNUMBER>
    <ORDERID>246019520191637</ORDERID>
    <ORIGINALAUTHORIZEDAMOUNT>10.00</ORIGINALAUTHORIZEDAMOUNT>
    <ORIGINALPROCESSORRESPONSE>DEVELOPMENT APPROVAL</ORIGINALPROCESSORRESPONSE>
    <ORIGINALREQUESTEDAMOUNT>10.00</ORIGINALREQUESTEDAMOUNT>
    <ORIGINALRESPONSECODE>000</ORIGINALRESPONSECODE>
    <ORIGINALRESPONSEDESCRIPTION>Approval</ORIGINALRESPONSEDESCRIPTION>
    <ORIGINALTRANSACTIONDATETIME>20190905173903</ORIGINALTRANSACTIONDATETIME>
    <ORIGINALTRANSACTIONTYPE>CREDITSALE</ORIGINALTRANSACTIONTYPE>
    <PONUMBER>9520191637</PONUMBER>
    <PROCESSORRESPONSE>DEVELOPMENT APPROVAL</PROCESSORRESPONSE>
    <RECEIPTID>183</RECEIPTID>
    <RESPONSECODE>000</RESPONSECODE>
    <RESPONSEDESCRIPTION>Approval</RESPONSEDESCRIPTION>
    <RETURNID>0</RETURNID>
    <STATE>CAPTURED</STATE>
    <TRANSACTIONDATETIME>20190905173903</TRANSACTIONDATETIME>
    <TRANSACTIONID>000000000183</TRANSACTIONID>
    <TRANSACTIONTYPE>CREDITSALE</TRANSACTIONTYPE>
</RESULT>

CREDITRETURN - Credit Return Transaction

This transaction will return the funds to a customer’s account after settlement of the original batch has occurred. Returns can be processed in one of two different methods:

Dependent Return -

Return is processed using an "ORDERID" from a previous transaction; this method is recommended for use wherever possible. When performing a Dependent Return, the payment page is not required; the Edge Gateway will use the card details of the previous transaction being referenced.

Independent Return -

Return is processed without reference to a previous transaction; this method requires use of a payment page for manual entry of the customer's credit card details.

Dependent Return - Request

<REQUEST>
    <XWEBID>800000032599</XWEBID>
    <XWEBTERMINALID>80033511</XWEBTERMINALID>
    <XWEBAUTHKEY>YJev4b2G1xVXj7c2C9BxBCrIFBf9vdTF</XWEBAUTHKEY>
    <TRANSACTIONTYPE>CREDITRETURN</TRANSACTIONTYPE>
    <ORDERID>246039520191637</ORDERID>
    <AMOUNT>10.00</AMOUNT>
</REQUEST>

Independent Return - Request

<REQUEST>
    <XWEBID>800000032599</XWEBID>
    <XWEBTERMINALID>80033511</XWEBTERMINALID>
    <XWEBAUTHKEY>YJev4b2G1xVXj7c2C9BxBCrIFBf9vdTF</XWEBAUTHKEY>
    <TRANSACTIONTYPE>CREDITRETURN</TRANSACTIONTYPE>
    <AMOUNT>15.00</AMOUNT>
    <ORDERID>246019520191650</ORDERID>
    <INVOICENUMBER>11223344</INVOICENUMBER>
    <PONUMBER>11223344</PONUMBER>
    <ADDRESS>321 Test Road</ADDRESS>
    <ZIP>54321</ZIP>
    <CUSTOMEREMAILADDRESS>JohnDoe@Test.com</CUSTOMEREMAILADDRESS>
    <CUSTOMERNAME>John Doe</CUSTOMERNAME>
    <CUSTOMERPHONENUMBER>555-555-5555</CUSTOMERPHONENUMBER>
    <BILLINGADDRESS1>321 Test Road</BILLINGADDRESS1>
    <BILLINGADDRESS2>Suite 123</BILLINGADDRESS2>
    <BILLINGCITY>Salt Lake City</BILLINGCITY>
    <BILLINGSTATE>UT</BILLINGSTATE>
    <BILLINGPOSTALCODE>54321</BILLINGPOSTALCODE>
    <BILLINGCOUNTRY>US</BILLINGCOUNTRY>
    <BILLINGFIRSTNAME>John</BILLINGFIRSTNAME>
    <BILLINGMIDDLENAME>Q</BILLINGMIDDLENAME>
    <BILLINGLASTNAME>Doe</BILLINGLASTNAME>
    <ECI>7</ECI>
    <PARTIALAPPROVALSUPPORT>TRUE</PARTIALAPPROVALSUPPORT>
    <CLERK>Best Employee 1</CLERK>
    <CREATEALIAS>TRUE</CREATEALIAS>
    <ALLOWDUPLICATES>TRUE</ALLOWDUPLICATES>
    <RECEIPTFORMAT>TEXT</RECEIPTFORMAT>
    <RECEIPTCARDHOLDERNAME>Jon Q Doe</RECEIPTCARDHOLDERNAME>
    <RECEIPTCOPYLABEL>BOTH</RECEIPTCOPYLABEL>
    <RECEIPTHEADER>Sale Receipt</RECEIPTHEADER>
    <RECEIPTSTORENAME>My Store Inc.</RECEIPTSTORENAME>
    <RECEIPTADDRESS>123 Happy Street Suite 1</RECEIPTADDRESS>
    <RECEIPTPHONE>555-555-1234</RECEIPTPHONE>
    <RECEIPTLINEITEMS>1 - Sample Product</RECEIPTLINEITEMS>
    <RECEIPTPOLICY>Return Policy - You Have 30 Calendar Days To Return Purchased Items.</RECEIPTPOLICY>
    <RECEIPTFOOTER>Thank You For Your Purchase!</RECEIPTFOOTER>
    <RECEIPTSIGNATURELINE>TRUE</RECEIPTSIGNATURELINE>
    <USERDEFINED1>Optional Data 1</USERDEFINED1>
    <USERDEFINED2>Optional Data 2</USERDEFINED2>
    <USERDEFINED3>Optional Data 3</USERDEFINED3>
    <HOSTPAYSETTING>
        <POSDEVICE>
            <TYPE>KEYED</TYPE>
        </POSDEVICE>
        <CUSTOMIZATION>
            <BRANDING>
                <BODY>
                    <BACKGROUNDCOLOR>#FFFF00;</BACKGROUNDCOLOR>
                    <COLOR>#0F0F0F;</COLOR>
                    <FONTFAMILY>TIMES NEW ROMAN, HELVETICA-NEUE,HELVETICA,ARIAL,SANS-SERIF;</FONTFAMILY>
                    <FONTSIZE>12PX;</FONTSIZE>
                    <INPUTFIELDHEIGHT />
                </BODY>
            </BRANDING>
        </CUSTOMIZATION>
    </HOSTPAYSETTING>
</REQUEST>

CREDITVOID - Credit Void Transaction

This transaction removes a Sale, Capture or Return transaction from the current batch. It can also be used to reverse the Authorization or Sale transaction; thereby, replenishing the authorized amount on the consumer card.

Credit Void - Request

<REQUEST>
    <XWEBID>800000032599</XWEBID>
    <XWEBTERMINALID>80033511</XWEBTERMINALID>
    <XWEBAUTHKEY>YJev4b2G1xVXj7c2C9BxBCrIFBf9vdTF</XWEBAUTHKEY>
    <TRANSACTIONTYPE>CREDITVOID</TRANSACTIONTYPE>
    <ORDERID>246019520191637</ORDERID>
</REQUEST>

CREDITAUTH - Credit Authorization Transaction

This transaction will verify the available funds on the card. The funds will be reserved on the cardholders account for a period of time. The subsequent CREDITCAPTURE on this transaction will flag the transaction for settlement.

Credit Authorization - Request

<REQUEST>
    <XWEBID>800000032599</XWEBID>
    <XWEBTERMINALID>80033511</XWEBTERMINALID>
    <XWEBAUTHKEY>YJev4b2G1xVXj7c2C9BxBCrIFBf9vdTF</XWEBAUTHKEY>
    <TRANSACTIONTYPE>CREDITAUTH</TRANSACTIONTYPE>
    <AMOUNT>10.00</AMOUNT>
    <ORDERID>246019520191656</ORDERID>
    <INVOICENUMBER>112233</INVOICENUMBER>
    <PONUMBER>112233</PONUMBER>
    <ADDRESS>321 Test Road</ADDRESS>
    <ZIP>54321</ZIP>
    <CUSTOMEREMAILADDRESS>JohnDoe@Test.com</CUSTOMEREMAILADDRESS>
    <CUSTOMERNAME>John Doe</CUSTOMERNAME>
    <CUSTOMERPHONENUMBER>555-555-5555</CUSTOMERPHONENUMBER>
    <BILLINGADDRESS1>321 Test Road</BILLINGADDRESS1>
    <BILLINGADDRESS2>Suite 123</BILLINGADDRESS2>
    <BILLINGCITY>Salt Lake City</BILLINGCITY>
    <BILLINGSTATE>UT</BILLINGSTATE>
    <BILLINGPOSTALCODE>54321</BILLINGPOSTALCODE>
    <BILLINGCOUNTRY>US</BILLINGCOUNTRY>
    <BILLINGFIRSTNAME>John</BILLINGFIRSTNAME>
    <BILLINGMIDDLENAME>Q</BILLINGMIDDLENAME>
    <BILLINGLASTNAME>Doe</BILLINGLASTNAME>
    <ECI>7</ECI>
    <PARTIALAPPROVALSUPPORT>TRUE</PARTIALAPPROVALSUPPORT>
    <CLERK>Best Employee 1</CLERK>
    <CREATEALIAS>TRUE</CREATEALIAS>
    <ALLOWDUPLICATES>TRUE</ALLOWDUPLICATES>
    <RECEIPTFORMAT>TEXT</RECEIPTFORMAT>
    <RECEIPTCARDHOLDERNAME>Jon Q Doe</RECEIPTCARDHOLDERNAME>
    <RECEIPTCOPYLABEL>BOTH</RECEIPTCOPYLABEL>
    <RECEIPTHEADER>Sale Receipt</RECEIPTHEADER>
    <RECEIPTSTORENAME>My Store Inc.</RECEIPTSTORENAME>
    <RECEIPTADDRESS>123 Happy Street Suite 1</RECEIPTADDRESS>
    <RECEIPTPHONE>555-555-1234</RECEIPTPHONE>
    <RECEIPTLINEITEMS>1 - Sample Product</RECEIPTLINEITEMS>
    <RECEIPTPOLICY>Return Policy - You Have 30 Calendar Days To Return Purchased Items.</RECEIPTPOLICY>
    <RECEIPTFOOTER>Thank You For Your Purchase!</RECEIPTFOOTER>
    <RECEIPTSIGNATURELINE>TRUE</RECEIPTSIGNATURELINE>
    <USERDEFINED1>Optional Data 1</USERDEFINED1>
    <USERDEFINED2>Optional Data 2</USERDEFINED2>
    <USERDEFINED3>Optional Data 3</USERDEFINED3>
    <HOSTPAYSETTING>
        <POSDEVICE>
            <TYPE>KEYED</TYPE>
        </POSDEVICE>
        <CUSTOMIZATION>
            <BRANDING>
                <BODY>
                    <BACKGROUNDCOLOR>#FFFF00;</BACKGROUNDCOLOR>
                    <COLOR>#0F0F0F;</COLOR>
                    <FONTFAMILY>TIMES NEW ROMAN, HELVETICA-NEUE,HELVETICA,ARIAL,SANS-SERIF;</FONTFAMILY>
                    <FONTSIZE>12PX;</FONTSIZE>
                    <INPUTFIELDHEIGHT />
                </BODY>
            </BRANDING>
        </CUSTOMIZATION>
    </HOSTPAYSETTING>
</REQUEST>

CREDITONLINECAPTURE - Credit Capture Transaction

This transaction is a request to post a previously authorized transaction. An online capture is a transaction that flags an authorization previously approved via the EdgeExpress Gateway for settlement.

Credit Capture - Request

<REQUEST>
    <XWEBID>800000032599</XWEBID>
    <XWEBTERMINALID>80033511</XWEBTERMINALID>
    <XWEBAUTHKEY>YJev4b2G1xVXj7c2C9BxBCrIFBf9vdTF</XWEBAUTHKEY>
    <TRANSACTIONTYPE>CREDITONLINECAPTURE</TRANSACTIONTYPE>
    <AMOUNT>15.00</AMOUNT>
    <ORDERID>246019520191656</ORDERID>
</REQUEST>

CREDITAUTH (Zero Dollar Authorization/Alias Creation)

Zero Dollar Authorization (Alias Creation) - Request

<REQUEST>
    <XWEBID>800000032599</XWEBID>
    <XWEBTERMINALID>80033511</XWEBTERMINALID>
    <XWEBAUTHKEY>YJev4b2G1xVXj7c2C9BxBCrIFBf9vdTF</XWEBAUTHKEY>
    <TRANSACTIONTYPE>CREDITAUTH</TRANSACTIONTYPE>
    <AMOUNT>0.00</AMOUNT>
    <ORDERID>246029520191656</ORDERID>
    <INVOICENUMBER>112233</INVOICENUMBER>
    <PONUMBER>112233</PONUMBER>
    <ADDRESS>321 Test Road</ADDRESS>
    <ZIP>54321</ZIP>
    <CUSTOMEREMAILADDRESS>JohnDoe@Test.com</CUSTOMEREMAILADDRESS>
    <CUSTOMERNAME>John Doe</CUSTOMERNAME>
    <CUSTOMERPHONENUMBER>555-555-5555</CUSTOMERPHONENUMBER>
    <BILLINGADDRESS1>321 Test Road</BILLINGADDRESS1>
    <BILLINGADDRESS2>Suite 123</BILLINGADDRESS2>
    <BILLINGCITY>Salt Lake City</BILLINGCITY>
    <BILLINGSTATE>UT</BILLINGSTATE>
    <BILLINGPOSTALCODE>54321</BILLINGPOSTALCODE>
    <BILLINGCOUNTRY>US</BILLINGCOUNTRY>
    <BILLINGFIRSTNAME>John</BILLINGFIRSTNAME>
    <BILLINGMIDDLENAME>Q</BILLINGMIDDLENAME>
    <BILLINGLASTNAME>Doe</BILLINGLASTNAME>
    <ECI>7</ECI>
    <PARTIALAPPROVALSUPPORT>TRUE</PARTIALAPPROVALSUPPORT>
    <CLERK>Best Employee 1</CLERK>
    <CREATEALIAS>TRUE</CREATEALIAS>
    <ALLOWDUPLICATES>TRUE</ALLOWDUPLICATES>
    <RECEIPTFORMAT>TEXT</RECEIPTFORMAT>
    <RECEIPTCARDHOLDERNAME>Jon Q Doe</RECEIPTCARDHOLDERNAME>
    <RECEIPTCOPYLABEL>BOTH</RECEIPTCOPYLABEL>
    <RECEIPTHEADER>Sale Receipt</RECEIPTHEADER>
    <RECEIPTSTORENAME>My Store Inc.</RECEIPTSTORENAME>
    <RECEIPTADDRESS>123 Happy Street Suite 1</RECEIPTADDRESS>
    <RECEIPTPHONE>555-555-1234</RECEIPTPHONE>
    <RECEIPTLINEITEMS>1 - Sample Product</RECEIPTLINEITEMS>
    <RECEIPTPOLICY>Return Policy - You Have 30 Calendar Days To Return Purchased Items.</RECEIPTPOLICY>
    <RECEIPTFOOTER>Thank You For Your Purchase!</RECEIPTFOOTER>
    <RECEIPTSIGNATURELINE>TRUE</RECEIPTSIGNATURELINE>
    <USERDEFINED1>Optional Data 1</USERDEFINED1>
    <USERDEFINED2>Optional Data 2</USERDEFINED2>
    <USERDEFINED3>Optional Data 3</USERDEFINED3>
    <HOSTPAYSETTING>
        <POSDEVICE>
            <TYPE>KEYED</TYPE>
        </POSDEVICE>
        <CUSTOMIZATION>
            <BRANDING>
                <BODY>
                    <BACKGROUNDCOLOR>#FFFF00;</BACKGROUNDCOLOR>
                    <COLOR>#0F0F0F;</COLOR>
                    <FONTFAMILY>TIMES NEW ROMAN, HELVETICA-NEUE,HELVETICA,ARIAL,SANS-SERIF;</FONTFAMILY>
                    <FONTSIZE>12PX;</FONTSIZE>
                    <INPUTFIELDHEIGHT />
                </BODY>
            </BRANDING>
        </CUSTOMIZATION>
    </HOSTPAYSETTING>
</REQUEST>

Credit Sale (Using Alias)

Credit Sale (Using Alias) - Request

<REQUEST>
    <XWEBID>800000032599</XWEBID>
    <XWEBTERMINALID>80033511</XWEBTERMINALID>
    <XWEBAUTHKEY>YJev4b2G1xVXj7c2C9BxBCrIFBf9vdTF</XWEBAUTHKEY>
    <TRANSACTIONTYPE>CREDITSALE</TRANSACTIONTYPE>
    <AMOUNT>10.00</AMOUNT>
    <ALIAS>tIMDbCe139</ALIAS>
    <ORDERID>246010707952019</ORDERID>
    <INVOICENUMBER>223311</INVOICENUMBER>
    <PONUMBER>223311</PONUMBER>
    <ADDRESS>321 Test Road</ADDRESS>
    <ZIP>54321</ZIP>
    <CUSTOMEREMAILADDRESS>JohnDoe@Test.com</CUSTOMEREMAILADDRESS>
    <CUSTOMERNAME>John Doe</CUSTOMERNAME>
    <CUSTOMERPHONENUMBER>555-555-5555</CUSTOMERPHONENUMBER>
    <BILLINGADDRESS1>321 Test Road</BILLINGADDRESS1>
    <BILLINGADDRESS2>Suite 123</BILLINGADDRESS2>
    <BILLINGCITY>Salt Lake City</BILLINGCITY>
    <BILLINGSTATE>UT</BILLINGSTATE>
    <BILLINGPOSTALCODE>54321</BILLINGPOSTALCODE>
    <BILLINGCOUNTRY>US</BILLINGCOUNTRY>
    <BILLINGFIRSTNAME>John</BILLINGFIRSTNAME>
    <BILLINGMIDDLENAME>Q</BILLINGMIDDLENAME>
    <BILLINGLASTNAME>Doe</BILLINGLASTNAME>
    <ECI>7</ECI>
    <PARTIALAPPROVALSUPPORT>TRUE</PARTIALAPPROVALSUPPORT>
    <CLERK>Best Employee 1</CLERK>
    <ALLOWDUPLICATES>TRUE</ALLOWDUPLICATES>
    <RECEIPTFORMAT>TEXT</RECEIPTFORMAT>
    <RECEIPTCARDHOLDERNAME>Jon Q Doe</RECEIPTCARDHOLDERNAME>
    <RECEIPTCOPYLABEL>BOTH</RECEIPTCOPYLABEL>
    <RECEIPTHEADER>Sale Receipt</RECEIPTHEADER>
    <RECEIPTSTORENAME>My Store Inc.</RECEIPTSTORENAME>
    <RECEIPTADDRESS>123 Happy Street Suite 1</RECEIPTADDRESS>
    <RECEIPTPHONE>555-555-1234</RECEIPTPHONE>
    <RECEIPTLINEITEMS>1 - Sample Product</RECEIPTLINEITEMS>
    <RECEIPTPOLICY>Return Policy - You Have 30 Calendar Days To Return Purchased Items.</RECEIPTPOLICY>
    <RECEIPTFOOTER>Thank You For Your Purchase!</RECEIPTFOOTER>
    <RECEIPTSIGNATURELINE>TRUE</RECEIPTSIGNATURELINE>
    <USERDEFINED1>Optional Data 1</USERDEFINED1>
    <USERDEFINED2>Optional Data 2</USERDEFINED2>
    <USERDEFINED3>Optional Data 3</USERDEFINED3>
</REQUEST>

Automated Clearing House (ACH) Transactions

Listed below are the request fields REQUIRED for processing a transaction through the EdgeExpress API.

Field	Type	Length	Description
XWEBID	Numeric	12	This is the ID given to the merchant once they have been enrolled in the system. The XWEBID, XWEBTERMINALID, and XWEBAUTHKEY are required for all ACH transactions.
XWEBTERMINALID	Numeric	8	This is the ID given to the merchant once they have been enrolled in the system. The XWEBID, XWEBTERMINALID, and XWEBAUTHKEY are required for all ACH transactions.
XWEBAUTHKEY	Alphanumeric	32	This is the ID given to the merchant once they have been enrolled in the system. The XWEBID, XWEBTERMINALID, and XWEBAUTHKEY are required for all ACH transactions.
ORDERID	Numeric	1-20	Unique transaction identifier designated by the integrating application. The Order ID is also used on queries to retrieve transaction details, as well as processing follow on transactions.
TRANSACTIONTYPE	Defined	Variable	'CHECKSALE', 'CHECKCREDIT'
ENTRYCLASS	Alphanumeric	Variable	'CCD', 'PPD', 'TEL', or 'WEB'. If an Alias is used, only PPD, CCD, and WEB entry types are accepted.
BANKACCOUNTTYPE	Explicit	Variable	'CHECKING' or 'SAVINGS'. The type of account used for a CHECK transaction.
NAMEONACCOUNT	Alphanumeric	Variable	Used to submit the account holder's name. Must be submitted for transactions with an EntryClass of CCD, PPD, TEL and WEB. Must be submitted for Check transactions when CreateAlias is set to TRUE.
AMOUNT	Numeric	1-8	0.01-999999.99. Transaction amount.
CREATECHECKALIAS	Explicit	Variable	"True" or "False". If not sent, defaults to "False". If set to "True", Alias cannot be specified. If set to "True", NameOnAccount must be submitted.
ALIAS	Alphanumeric	10	The Alias can be used to reference the original account number. Length is either 10 case-sensitive alphanumeric characters, or 32 characters in UUID format (8-4-4-4-12). For check transactions, ALIAS cannot be used with AccountNumber or RoutingNumber.

CHECKSALE - ACH Sale Transaction

Transaction Type used to purchase goods and services in a Check Not Present environment. The Integrator will be provided a "Session Token", which will be used for generation of the Hosted Payment Page.

ACH Sale - Request

<REQUEST>
    <XWEBID>800000032599</XWEBID>
    <XWEBTERMINALID>80033512</XWEBTERMINALID>
    <XWEBAUTHKEY>QJGbEyVdJgCujtXhgDKRDUf1e8XoECE2</XWEBAUTHKEY>
    <TRANSACTIONTYPE>CHECKSALE</TRANSACTIONTYPE>
    <AMOUNT>10.00</AMOUNT>
    <ENTRYCLASS>PPD</ENTRYCLASS>
    <BANKACCOUNTTYPE>CHECKING</BANKACCOUNTTYPE>
    <NAMEONACCOUNT>John Doe</NAMEONACCOUNT>
    <ORDERID>246011708952019</ORDERID>
    <INVOICENUMBER>123123</INVOICENUMBER>
    <PONUMBER>123123</PONUMBER>
    <ADDRESS>321 Test Road</ADDRESS>
    <ZIP>54321</ZIP>
    <CUSTOMEREMAILADDRESS>JohnDoe@Test.com</CUSTOMEREMAILADDRESS>
    <CUSTOMERNAME>John Doe</CUSTOMERNAME>
    <CUSTOMERPHONENUMBER>555-555-5555</CUSTOMERPHONENUMBER>
    <BILLINGADDRESS1>321 Test Road</BILLINGADDRESS1>
    <BILLINGADDRESS2>Suite 123</BILLINGADDRESS2>
    <BILLINGCITY>Salt Lake City</BILLINGCITY>
    <BILLINGSTATE>UT</BILLINGSTATE>
    <BILLINGPOSTALCODE>54321</BILLINGPOSTALCODE>
    <BILLINGCOUNTRY>US</BILLINGCOUNTRY>
    <BILLINGFIRSTNAME>John</BILLINGFIRSTNAME>
    <BILLINGMIDDLENAME>Q</BILLINGMIDDLENAME>
    <BILLINGLASTNAME>Doe</BILLINGLASTNAME>
    <CLERK>Best Employee 1</CLERK>
    <CREATECHECKALIAS>TRUE</CREATECHECKALIAS>
    <ALLOWDUPLICATES>TRUE</ALLOWDUPLICATES>
    <RECEIPTFORMAT>TEXT</RECEIPTFORMAT>
    <RECEIPTCARDHOLDERNAME>Jon Q Doe</RECEIPTCARDHOLDERNAME>
    <RECEIPTCOPYLABEL>BOTH</RECEIPTCOPYLABEL>
    <RECEIPTHEADER>Sale Receipt</RECEIPTHEADER>
    <RECEIPTSTORENAME>My Store Inc.</RECEIPTSTORENAME>
    <RECEIPTADDRESS>123 Happy Street Suite 1</RECEIPTADDRESS>
    <RECEIPTPHONE>555-555-1234</RECEIPTPHONE>
    <RECEIPTLINEITEMS>1 - Sample Product</RECEIPTLINEITEMS>
    <RECEIPTPOLICY>Return Policy - You Have 30 Calendar Days To Return Purchased Items.</RECEIPTPOLICY>
    <RECEIPTFOOTER>Thank You For Your Purchase!</RECEIPTFOOTER>
    <RECEIPTSIGNATURELINE>TRUE</RECEIPTSIGNATURELINE>
    <USERDEFINED1>Optional Data 1</USERDEFINED1>
    <USERDEFINED2>Optional Data 2</USERDEFINED2>
    <USERDEFINED3>Optional Data 3</USERDEFINED3>
    <HOSTPAYSETTING>
        <POSDEVICE>
            <TYPE>KEYED</TYPE>
        </POSDEVICE>
        <CUSTOMIZATION>
            <BRANDING>
                <BODY>
                    <BACKGROUNDCOLOR>#FFFF00;</BACKGROUNDCOLOR>
                    <COLOR>#0F0F0F;</COLOR>
                    <FONTFAMILY>TIMES NEW ROMAN, HELVETICA-NEUE,HELVETICA,ARIAL,SANS-SERIF;</FONTFAMILY>
                    <FONTSIZE>12PX;</FONTSIZE>
                    <INPUTFIELDHEIGHT />
                </BODY>
            </BRANDING>
        </CUSTOMIZATION>
    </HOSTPAYSETTING>
</REQUEST>

Payment Query - Request

<REQUEST>
    <XWEBID>800000032599</XWEBID>
    <XWEBTERMINALID>80033511</XWEBTERMINALID>
    <XWEBAUTHKEY>YJev4b2G1xVXj7c2C9BxBCrIFBf9vdTF</XWEBAUTHKEY>
    <TRANSACTIONTYPE>QUERYPAYMENT</TRANSACTIONTYPE>
    <ORDERID>246011708952019</ORDERID>
</REQUEST>

Payment Query - Response

<?xml version="1.0" encoding="UTF-16" standalone="yes"?>
<RESULT>
    <ACCOUNT>X2121</ACCOUNT>
    <APPROVEDAMOUNT>10.00</APPROVEDAMOUNT>
    <CHECKNUMBER>999000000000198</CHECKNUMBER>
    <ENTRYCLASS>PPD</ENTRYCLASS>
    <ORDERID>246011156165</ORDERID>
    <RECEIPTID>198</RECEIPTID>
    <RESPONSECODE>011</RESPONSECODE>
    <RESPONSEDESCRIPTION>Check Submitted</RESPONSEDESCRIPTION>
    <RETURNID>1</RETURNID>
    <ROUTINGNUMBER>XXXXX0066</ROUTINGNUMBER>
    <TRANSACTIONID>000000000198</TRANSACTIONID>
</RESULT>

CHECKCREDIT - ACH Return Transaction

This transaction will return the funds to a customer’s account after settlement of the original batch has occurred. Return is processed using an "ORDERID" from a previous transaction. When performing a Return, the payment page is not required; the Edge Gateway will use the card details of the previous transaction being referenced.

Check Return - Request

<REQUEST>
    <XWEBID>800000032599</XWEBID>
    <XWEBTERMINALID>80033512</XWEBTERMINALID>
    <XWEBAUTHKEY>QJGbEyVdJgCujtXhgDKRDUf1e8XoECE2</XWEBAUTHKEY>
    <TRANSACTIONTYPE>CHECKCREDIT</TRANSACTIONTYPE>
    <ORDERID>246011156165</ORDERID>
    <AMOUNT>10.00</AMOUNT>
    <ENTRYCLASS>PPD</ENTRYCLASS>
    <BANKACCOUNTTYPE>CHECKING</BANKACCOUNTTYPE>
</REQUEST>

Policies

Connect

Additional Resources