Authenticate is used to authenticate a specific user. For this call, the header must include username and password.

CancelImpersonation is used to terminate a previously started impersonation session.

CashReturn creates a log of a transaction that is returning cash to a customer.

NOTE:  This is processed offline.

CashSale creates a log of a transaction, in which cash is collected from a customer.

This is processed offline.

CheckSale transactions use bank account information as the payment method.

There are sub-actions that can be taken as part of the CheckSale as indicated by the CheckAction field.

CheckVoid is used to cancel a previously successful CheckSale transaction. It can also be used to cancel a prior CheckSale transaction.

This should be used in timeout situations or when a complete response is not received.

CreditAdditionalAuth is typically used in a bar or restaurant situation where the merchant obtains the payment information for an original CreditAuth but does not want to hold the card or ask for it on each additional authorization.

CreditAddToBatch is primarily used to add a previously approved open authorization (CreditAuth, CreditOfflineAuth, or RecurringBillingAuth) to the current open batch.

If a batch is not open, this transaction will create one. It also provides the opportunity to alter data associated with the transaction (i.e., add a tip amount).

CreditAuth authorizes a credit card transaction.

These authorization only transactions are not added to the batch to be settled. They can be added to a batch at a later time using CreditAddToBatch.

Approved authorizations that have not yet been added to a batch are called open auths.

CreditCPCEdit attaches Corporate Purchase Card (CPC) data to a prior transaction.

This information will be passed to the issuer at settlement when the associated card was a corporate card or an AMEX card.

CreditIPQuery returns the Installment Payment terms available to the cardholder.

This is currently only supported for the AP Region. Refer to the Authorization Platform section for further details.

CreditOfflineAuth records an authorization obtained outside of the gateway (e.g., voice authorization, chip card offline approval).

These authorization only transactions are not added to the batch to be settled. They can be added to a batch at a later time using CreditAddToBatch.

Approved authorizations that have not yet been added to a batch are called open auths.

CreditReturn allows the merchant to return funds back to the cardholder.

Returns can be for the entire amount associated with the original sale or a partial amount.

Returns made using the GatewayTxnId can be performed for up to one year from the original authorization date.

For the Exchange host only, refunds may be processed offline or online, depending on merchant settings.  To enable online refunds, contact your representative.  For all other Authorization Platforms, refunds are sent online to the host and the host determines whether the issuer participates in online returns.

CreditReversal cancels a prior authorization in the current open batch. This can be used in timeout situations or when a complete response is not received. In either case, the client is unsure of the outcome of the prior transaction.

CreditSale authorizes a credit card transaction. These authorizations are automatically added to the batch to be settled. If a batch is not already open, this transaction will create one.

CreditVoid is used to cancel an open auth or remove a transaction from the current open batch.

The original transaction must be a CreditAuth, CreditSale, CreditReturn, CreditOfflineAuth, CreditOfflineSale, RecurringBilling, or Recurring Billing Auth.

DebitAddToBatch is used to add a pre-authorized debit transaction to the open batch. If a batch is not open this transaction will create one. 

NOTE:  For Canadian Interac debit only.

DebitAuth obtains a pre-authorization of funds on a debit card. These authorization-only transactions are not added to the batch to be settled. They can be added to a batch at a later time using DebitAddToBatch.

NOTE:  For Canadian Interac debit only.

DebitReturn allows the merchant to return funds from a prior debit sale back to the cardholder.

Returns can be for the entire amount associated with the original sale or a partial amount. Returns made using the GatewayTxnId can be performed for up to one year from the original authorization date.

Support for EMV PIN Debit has been added.

DebitReversal cancels a previous DebitSale transaction.

This should be used in timeout situations or when a complete response is not received. In either case, the client is unsure of the outcome of the prior transaction.

Support for EMV PIN Debit has been added.

DebitSale authorizes a debit card transaction.

Support for EMV PIN Debit has been added.

EBTFSPurchase is used to purchase goods with SNAP.

EBTFSReturn is used to credit previously debited funds to a SNAP account for merchandise returned.

EBTFSReversal cancels a previous EBTFSPurchase, EBTCashBackPurchase, EBTFSReturn, and EBTCashBenefitWithdrawal transactions.

This should be used in timeout situations or when a complete response is not received. In either case, the client is unsure of the outcome of the prior transaction.

GiftCardAlias allows the client to manage stored account aliases. An alias is an alternate identifier used to reference a stored value account.

GiftCardCurrentDayTotals is used to retrieve stored value transaction totals for the current day.

This transaction is obsolete and should no longer be used. FindTransactions can be used as an alternative.

GiftCardReplace transfers balances from one stored value account to another.

This is typically to replace a lost or stolen account with a new one or to consolidate two or more accounts into a single account.

GiftCardReversal is used to cancel a prior stored value transaction.

This should be used in timeout situations or when a complete response is not received. In either case, the client is unsure of the outcome of the prior transaction.

GiftCardReward is used when an account holder makes a payment using a payment form other than a stored value account (e.g., cash or credit card).

The account holder may present their stored value account to earn points or other loyalty rewards, which would be added to their account.

GiftCardVoid is used to cancel a prior successful transaction.

When voiding a transaction, all changes to the account are reversed, including any additional value added by rewards programs or automated promotions.

Like the RecurringBilling service, this also authorizes a one-time or scheduled recurring transaction. However, these authorization only transactions are not added to the batch to be settled. They can be added to a batch at a later time using CreditAddToBatch.

Approved authorizations that have not yet been added to a batch are called open auths.

ReportActivity returns all activity between the client devices and gateway for a period of time. This can be filtered to a single DeviceId if needed.

This report is obsolete and should not be used.

FindTransactions can be used as an alternative.

ReportBatchDetail returns information on each transaction currently associated to the specified batch.

This report is for the SiteId and DeviceId referenced in the header.

ReportBatchHistory returns information about previous batches over a period of time.

This report is for the SiteId referenced in the header.

ReportBatchSummary returns a batch's status information and totals broken down by payment type.

This report is for the SiteId and DeviceId referenced in the header.

ReportOpenAuths returns all authorizations that have not been added to a batch for settlement.

This report is for the SiteId referenced in the header.

ReportSearch returns transaction information for a specified time period.

This report is obsolete and should not be used. FindTransactions can be used as an alternative.

ReportTxnDetail returns detailed information about a single transaction.

This report is for the SiteId and DeviceId referenced in the header.

RewardCashQuery returns the available points from a stored account, if any, and authorizes a loyalty transaction.

It is applicable only for Reward Cash terminals in the AP Region and is for future use.

RewardCashRedeem is a loyalty transaction that redeems value from a stored account.

This transaction is automatically added to the Reward Cash batch. It is applicable only for Reward Cash terminals in the AP Region and is for future use.

SendReceipt is for internal use only. It allows a client to send a receipt from a prior transaction out to specific destinations.

The prior transaction must belong to the SiteId and DeviceId referenced in the header.

Tokenize allows the client to request a multi-use token using the provided card data without having the card data verified by the issuer.