This article outlines how to configure and use the credit card integration between Spire v3.13 and Global Payments, including both Card Present (CP) and Card Not Present (CNP) processing, MID setup, payment method creation, and transaction workflows.


Last updated: 19 June 2025


Overview and Support


Global Payments is a payment solution provider that integrates with Spire to allow credit card processing for both Card Present and Card Not Present transactions. Spire’s integration supports taking payments through Sales Order Deposits, Sales Invoices, and A/R Invoices and Refunds.


Partners and clients must complete specific steps prior to enabling the integration in Spire Server Administration. This includes account registration with Global Payments and internal setup within Spire.


*Note: Global Payments integration requires that the client maintains their Spire Software Assurance.*


The following is a checklist of steps to complete the Global Payments integration with Spire, starting with a group of tasks that can be performed prior to enabling the integration in Spire Server Administration, followed by tasks that can be done after the integration is completed.


Before You Begin: Spire and Global Payments Setup 


Registration and Spire Central


1. Complete Spire Pre-Integration Check List

2. Spire Central Activation - Access Customer record in Spire Central. From the top menu, select the Change License. Under Modules select Global Payments. Note that for this integration to remain active, Spire clients must maintain their annual software assurance.

3. Customer needs to apply for account with Global Payments via this form. If customer has exisitngaccount with Global, a new application is still required.

4. Once the customer receives their merchant approval, ID and any terminals required, they will receive an implementation meeting request from Global Payments.

5. It is up to the customer and the Spire partner to ensure the pre-integration checklist is completed, and that the partner is available for the scheduled meeting with Global for the implementation.


Please Note: Global Payments Integration and Terminal support are provided by Global Payments.


Global Payments Technical Support

Hardware, Installs, processing issues or otherwise broken, existing merchant hardware orders,

trackinginfo and incmpete shipments.

Global Payments Technical Support

800-774-6462 Option 2

support@openedgepay.com

Open 24/7, 365 days a year


 

Spire Pre-Integration Check List  - Setting Up Payment Methods in Spire

  1. Go to Edit > Payment Methods.



    For integration with Global Payments, at least one Credit-type payment method must be created. Assign a Credit Card Clearing GL account to the payment method.
    If your business accepts multiple card types (e.g., Visa, MasterCard), you may wish to create separate payment methods and GL accounts to track them individually.

  2. Create a new payment method record with the Plus (Add) toolbar button, or edit an existing payment method with the Pencil (Edit) toolbar button.

  3. Code: A unique value for this payment method.
  4. Description: Identification for users to know the payment method when selecting.
  5. Type: Credit
  6. Assign the correct GL Account.
  7. For use within Sales Orders Display:
    • Check Display payment method to allow selection.
    • Set the Sequence position for this payment method in the list.
    • (Optional) Choose an icon image for display in Sales Orders.
  8. For defining the Integrationwith Global Payments:
    • Enable the integration
    • Set Type to: External Terminal (Card Present)
  9. Click Save and Close.


Spire Pre-Integration Check List  - Tills and Terminals Setup

Create Tills (Optional but Recommended)

  1. Go to Sales > Tills

  2. Create or edit tills to define where terminals are located (e.g., “Front Register”).

  3. If using GL Segments for Location, assign the appropriate Location Code.


Create Terminal Codes

Even if you haven’t received devices yet, you can pre-create terminal entries:

  1. Go to Sales > Payment Terminals

  2. Use the Add (+) button to create each expected terminal.

  3. These will later be configured once the Global Payments software is installed.


(Optional) Multi-Terminal Setup

If you have multiple terminals (e.g. for multi-lane or multi-till setups):

  1. Go to Sales > Payment Terminals.

  2. Click the Plus (Add) toolbar button to create a new terminal.

  3. Code: Name of device (e.g. Register 1)
  4. Terminal No: Format cedevice::xxxxxx
  5. Choose Language and Currency.
  6. Assign the appropriate Sales Till to assign the location of the device.
  7. Click Save and Close.
  8. Repeat for each additional terminal.


Card Present Setup (In-Store Terminals)


NOTE: If you're evaluating the integration prior to going live, enable the Sandbox Environment option for testing. Each configuration must include a unique Label, Region (USD/CAD), and optional Location or Division if applicable. For multi-currency or multi-location setups, create separate connections with distinct Labels.


1. Setting Up Global Payments Integration in Spire

  1. From the Spire Server Admin menu, click Integrations.
  2. Under Global Payments Integrated – Card Present, click SETUP.

  3. Give the connection a unique label (e.g., “Main Retail MID”).
  4. Enter your credentials in format: XWebID:XWebTerminalID.
  5. Enter your AuthKey as the Account Password.
  6. Leave the Sandbox Environment checkbox unmarked for live integration.
  7. Select the appropriate Region (e.g., USD or CAD).
  8. (Optional) Enter the Location and/or Division name if using multiple.
  9. Click Save.
  10. For multi-MID setups, click Create New Connection and repeat.

Assign Access

  1. Click MANAGE ACCESS.

  2. Enable the databases that should use this MID.
  3. Click CLOSE.




5. Running a Card Present (CP) Sale

  1. Go to Sales, click + to create a new sales order.

  2. Enter sales order information including the Customer No and Part No details.
  3. Click Invoice.
  4. Click the Card Present payment icon.
  5. If prompted, choose the correct device.
  6. Enter the amount, click OK.
  7. Follow prompts on the terminal.
  8. Once complete, click Invoice to finish.

 

 

Card Not Present Setup (Manual Entry / Ecommerce)


NOTE: If you're evaluating the integration prior to going live, enable the Sandbox Environment option for testing. Each configuration must include a unique Label, Region (USD/CAD), and optional Location or Division if applicable. For multi-currency or multi-location setups, create separate connections with distinct Labels.


1. Setting Up Global Payments Integration in Spire

  1. Still in Integrations, find Global Payments Integrated – Card Not Present.
  2. Click SETUP.

  3. Enter a unique label for the account.
  4. Provide credentials in format: XWebID:XWebTerminalID.
  5. Enter the AuthKey.
  6. Leave the checkbox unmarked.
  7. Select the Region.
  8. (Optional) Add Location or Division if needed.
  9. Click Save.
  10. Use Create New Connection to add additional MIDs.

Assign Access

  1. Click MANAGE ACCESS, enable desired databases.

  2. Click CLOSE.

2. Setting Up Payment Methods in Spire

  1. Create a new payment method record with the Plus (Add) toolbar button, or edit an existing payment method with the Pencil (Edit) toolbar button.

  2. Code: A unique value for this payment method.
  3. Description: Identification for users to know the payment method when selecting.
  4. Type: Credit
  5. Assign the correct GL Account.
  6. For use within Sales Orders Display:
    • Check Display payment method to allow selection.
    • Set the Sequence position for this payment method in the list.
    • (Optional) Choose an icon image for display in Sales Orders.
  7. For defining the Integrationwith Global Payments:
    • Enable the integration
    • Set Type to: External Terminal (Card Present)
  8. Click Save and Close.

3. Customer Cards with Tokenization (CNP)

  1. Go to Customers, locate the customer, and edit with double-click or the Pencil icon.

  2. Open the Credit Cards tab.
  3. Click the Plus (Add)  toolbar button to create a new tokenized card.
  4. Manually enter the card info.
  5. Enable Default if this card is typically used for Sales invoices.
  6. Click Submit, then Save the customer.

4. Deleting a Saved (Tokenized) Card

  1. Go to Customers, open the customer profile.
  2. Click the Credit Cards tab.

  3. Select the saved card.
  4. Click the X icon to remove it.

5. Sales order entry with Tokenization (CNP)

  1. Go to Sales, click + to create a new sales order.
  2. Enter sales order information including the Customer No and Part No details.
  3. Click Invoice.

  4. Click the Card Not Present payment icon.

  5. Select a tokenized (saved) credit card or manually enter a new one.
  6. (Optional) If a new card was entered, check Save payment method to save the card to the customer.
  7. Use the Enter Manual Payment process only if you want to escape the integrated entry method and simply enter the information of a credit card payment that has already been externally processed.
  8. Click OK to process the payment.
  9. Multiple payments can be taken for the same invoice.
  10. Click Invoice to complete the sale.


Processes available to both Card Present and Card Not Present transactions


1. Voiding a Transaction (CP Only)


Must be done immediately after sale before invoice is closed.

  1. On the payment list screen, click Void.
  2. Select the terminal if needed.
  3. Follow the device prompts.
  4. Click Invoice to finalize, or Cancel to escape from this screen without invoicing.


2. Issuing an Independent Refund (CP Only)

  1. Go to Sales History.
  2. Double-click the transaction to refund.

  3. Click Reverse, then Invoice to reverse both the invoice and the payment.

  4. Select Card Present icon.
  5. Choose the terminal if prompted.
  6. Complete prompts and finalize.


3. Authorizing and Capturing Payments

a. Authorization

  1. Go to Sales, and edit the sales order.
  2. Click Credit Authorizations.

  3. Click Authorize, select the integrated credit card payment method.
  4. Choose the terminal or tokenized customer card, depending on Card Present or Not, and complete prompts.

  5. Click OK to save the transaction in the Credit Authorizations list.


b. Capture

  1. Open the order in Sales.
  2. Click Credit Authorizations to open the list.

  3. Highlight the saved payment authorization.
  4. Click Capture to process the payment and remove the authorization from the list.