Elavon downloads and stores cookies on your device when you visit our website. We use these cookies to better understand and improve your browsing experience by identifying most visited pages, personalising content, and measuring site performance.

Essential cookies enable core functionality such as page navigation and access to secure areas. The website cannot function properly without these cookies; they can only be disabled by changing your browser preferences.

These are cookies that support site functionality that is visible or advantageous to you or your experience of the site, they enable websites to remember choices and provide a more personalized experience.   Functional cookies help to provide services that you request, such as language preference or layout.

Performance cookies help us to improve our website by collecting and reporting information on its usage (for example, which of our pages are most frequently visited).

These cookies and similar technologies gather information about your browsing habits. They remember that you've visited a website and share this information with other organisations, such as advertisers and platforms on which we advertise. They do this in order to provide you with ads that are more relevant to you and your interests. Although these cookies and similar technologies can track your visits to other websites, they don't usually know who you are. Without these cookies, online advertisements you encounter will be less relevant to you and your interests.

Cookie Settings

U.S. Bank Europe DAC. Registered in Ireland – Number 418442..  Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.
U.S. Bank Europe DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.
 
U.S. Bank Europe DAC. Registered in Ireland with Companies Registration Office. The liability of the member is limited. United Kingdom branch registered in England and Wales under the number BR022122.
U.S. Bank Europe DAC, trading as Elavon Merchant Services, is a credit institution authorised and regulated by the Central Bank of Ireland.  Authorised by the Prudential Regulation Authority.  Subject to regulation by the Financial Conduct Authority and limited regulation by the Prudential Regulation Authority.  Details about the extent of our regulation by the Prudential Regulation Authority are available from us on request.

Most popular solutions

Additional solutions

Fusebox integration & options

Optional platform features

Documentation

North America

Europe

Regions

Transaction management is done via XML API and allows you to modify transactions, resend emails or receipts, search for a transaction, run a summary report, or settle transactions.

:::::notice{important}
If you are building a backend page that collects credit card information, your PCI requirements may change. 
:::::

## Request format

You must include system fields marked as required. Required fields are determined by the transaction type `ssl_transaction_type` sent in the :magic-link[/processxml.do]{id="api-reference#tag/Process-Transaction-Online"} request. If you receive any errors while testing, refer to the :magic-link[error codes]{id="error-codes"} page for more details.

XML supports content type application/x-www-form-urlencoded where the XML-formatted request is assigned to a single value. 

| Key | Value |
|--------------------|---------------------------------------|
| xmldata | ```<txn><ssl_account_id>my_account_id</ssl_account_id><ssl_user_id>my_user_id</ssl_user_id><ssl_pin>my_pin</ssl_pin></txn> ``` |

**Example format**
```curl
curl -X POST 'https://api.demo.convergepay.com/VirtualMerchantDemo/processxml.do' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 
'xmldata= 
<txn> 
 <ssl_transaction_type>ccvoid</ssl_transaction_type> 
 <ssl_account_id>my_account_id</ssl_account_id> 
 <ssl_user_id>my_user_id</ssl_user_id> 
 <ssl_pin>my_pin</ssl_pin> 
 <ssl_vendor_id>my_vendor_id</ssl_vendor_id>
 <ssl_txn_id>******</ssl_txn_id>
</txn>'
```

## Credit card management

Select the transaction type and send it in the :magic-link[/processxml.do]{id="api-reference#tag/Process-Transaction-Online"} request:

| Transaction type | Description |
|------------------|----------------------------------------------------|
| `ccsale` (Credit card payment) | Obtains real-time authorization for a credit card sale transaction and enters the transaction into the unsettled batch. Batch settlement can be done [manually](https://support.convergepay.com/s/article/Settle-a-Batch-Manually) or automatically. |
| `cccomplete` (Credit card authorization completion) | Places an approved auth only transaction into the open batch for settlement and converts the approved auth only transaction into a sale transaction. |
| `ccauthonly` (Credit card authorization add funds) | The auth only increment transaction lets merchants check if a customer has the necessary funds for additional charges tied to an existing auth only transaction - this extends an existing auth only and avoids the difficulty of managing two independent auth only transactions. |
| `ccverify` (Credit card verification) | Verifies the credit card account for AVS and CVV data. :magic-link[AVS]{id="response-codes#avs"} and :magic-link[CVV]{id="response-codes#cvv2cvc2"} are returned to indicate if the AVS and CVV data passed originally were correct and matched the cardholder statement billing address and the CVV value located on the card. | |
| `ccreturn` (Credit card refund) | Issues a partial or full refund to a cardholder’s credit card using the transaction ID of the original sale or force. This will guarantee that the same credit card used previously for the purchase is the one being refunded. |
| `ccvoid` (Credit card void) | Removes a sale, credit or force transaction from the open batch. Commonly used for same day returns or to correct cashier mistakes and can only be performed before the batch is settled. No funds will be deposited into the merchant’s bank account at settlement. |
| `ccdelete` (Credit card delete) | Deletes and attempts a reversal on a credit card sale or auth only transaction. |
| `ccaddrecurring` (Credit card add recurring) | Adds a credit card recurring record to the Converge recurring batch. Once added, the transaction will run automatically within the specified billing cycle on the scheduled payment day without the need to send it for authorization. Recurring transactions will run indefinitely, unless suspended by the user. |
| `ccupdaterecurring` (Credit card recurring update) | Updates a credit card recurring record in Converge. |
| `ccdeleterecurring` (Credit card recurring delete) | Deletes a credit card recurring record from Converge. |
| `ccrecurringsale` (Credit card recurring additional payment) | Allows you to run a credit card recurring payment outside of its billing cycle. This will increase the payment number. |
| `ccaddinstall` (Credit card add installment) | Adds a credit card installment record to the Converge recurring batch. Once added, the transaction will run automatically within the specified billing cycle on the scheduled payment day without the need to send it for authorization. Installment transactions will run until the number of installments specified is reached. |
| `ccupdateinstall` (Credit card installment update) | Updates a credit card installment record in Converge. |
| `ccdeleteinstall` (Credit card installment delete) | Deletes a credit card installment record from Converge. |
| `ccinstallsale` (Credit card installment additional payment) | Allows you to run a credit card installment payment outside of its billing cycle. This will increase the payment number. |

### Sample void transaction

Here is a valid example with which xmldata is included with any API request:
```curl
curl -X POST 'https://api.demo.convergepay.com/VirtualMerchantDemo/processxml.do' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 
'xmldata= 
<txn>
 <ssl_transaction_type>ccvoid</ssl_transaction_type>
 <ssl_account_id>my_account_id</ssl_account_id>
 <ssl_user_id>my_user_id</ssl_user_id>
 <ssl_pin>my_pin</ssl_pin>
 <ssl_vendor_id>my_vendor_id</ssl_vendor_id>
 <ssl_txn_id>xxxxxxxxxxxxxxxxxxxxxxxxxxx</ssl_txn_id>
</txn>'
```
## Token management 
Only :magic-link[Converge managed tokens]{id="transaction-types#store-a-card-token"} can be modified. Select the transaction type and send it in the :magic-link[/processxml.do]{id="api-reference#tag/Process-Transaction-Online"} request:

| Transaction type | Description |
|-------------------|------------------------------------------------------|
| `ccgettoken` (Credit card generate token) | :magic-link[Generates a token]{id="transaction-types#generate-a-card-token"} from a card number. The token generated can be used in place of a credit card number in any subsequent transactions made in :magic-link[transaction management]{id="transaction-management"}. | 
| `ccquerytoken` (Token Query) | Retrieves information associated with a token. | 
| `ccupdatetoken` (Token Update) | Updates the information associated with a token. |
| `ccdeletetoken` (Token Delete) | Deletes a token. |
| `accountupdatequery` (:magic-link[Account Update Query]{id="/products/xml-api/v1/account-update"}) | Elavon subscription service that automatically updates the card status for Visa and MasterCard. |

## Electronic check management

Select the transaction type and send it in the :magic-link[/processxml.do]{id="api-reference#tag/Process-Transaction-Online"} request:

| Transaction type | Description |
|-------------------|------------------------------------------------------|
| `ecspurchase` (Electronic check purchase) | Debits the purchase amount from a checking account. |
| `ecsvoid` (Electronic check void) | Reverses a check purchase. This transaction is typically used to correct cashier mistakes. No funds will be deposited into the merchant’s bank account. | 
| `ecsaddrecurring` (Electronic check add recurring) | Adds an ACH ECheck recurring payment to the Converge recurring batch. Once added, the transaction will run automatically within the specified billing cycle on the scheduled payment day without the need to send it for authorization. Recurring transactions will run indefinitely, unless suspended by the user. |
| `ecsupdaterecurring` (Electronic check update recurring) | Updates an existing ACH ECheck recurring payment in the Converge recurring batch. |
| `ecsdeleterecurring` (Electronic check delete recurring) | Deletes an ACH ECheck recurring payment from the Converge recurring batch. |
| `ecsrecurringsale` (Electronic check recurring additional payment) | Allows you to run an ACH ECheck recurring payment outside of its billing cycle and increase the total number of payments. |
| `ecsupdateinstall` (Electronic check update installment) | Allows you to run an ACH ECheck installment payment outside of its billing cycle and increase the total number of payments. |
| `ecsdeleteinstall` (Electronic check delete installment) | Deletes an ACH ECheck recurring payment from the Converge recurring batch. |
| `ecsinstalllsale` (Electronic check installment additional payment) | Allows you to run an ACH ECheck recurring payment outside of its billing cycle and increase the total number of payments. |

## Gift card management

Select the transaction type and send it in the :magic-link[/processxml.do]{id="api-reference#tag/Process-Transaction-Online"} request:

| Transaction type | Description |
|-----------------|-------------------------------------------------------------|
| `egcsale` (Electronic Gift Card Redemption) | Deducts the purchase amount from the balance of the gift card account. |
| `egcactivation` (Gift card activation) | This transaction activates the gift card. |
| `egccredit` (Gift card refund) | Refunds money back to a gift card account. |
| `egcreload` (Gift card reload) | Increases the current balance of the gift card account. |
| `egcbalinquiry` (Gift card balance inquiry) | Checks the current balance of a gift card account. |
| `egccredit` (Gift card refund) | Resets the balance of a gift card account to zero (card becomes unusable). |
| `egcgettoken` (Gift card generate token) | Generates a token from a gift card number. The token generated can be used in place of a gift card number in any subsequent transactions. |


## End of day transactions

Select the transaction type and send it in the :magic-link[/processxml.do]{id="api-reference#tag/Process-Transaction-Online"} request:

| Transaction type | Description |
|--------------|-------------------------|
| `txnemail` (Transaction email) | Initiates or resends an email to the merchant or customer for a specific transaction. |
| `txnquery` (Transaction query) | Searches for specific transactions based on parameters you set, such as transaction ID, date range, recurring ID, card data or invoice number. |
| `total` (End of day total/summary) | Obtains a summary of all transactions waiting to be settled. This transaction allows the merchant to review the batch prior to settlement. Generate an End of Day summary report before settlement to compare and match the data with the POS system. |
| `settle` (End of day settlement) | Initiates a manual settlement on a single, multiple, or batch of transactions. **Important**<ul><li>Open batches must be reviewed prior to settlement for accuracy. You may opt to set up auto-settlement or submit a manual settlement from the integrated application. Elavon highly recommends that batches be closed out on a daily basis.</li><li>Manual settlement is not allowed for multi-currency.</li><li>Settings are available within the admin feature that can block transactions from being added to a current open batch if these do not meet certain qualifications. Elavon recommends that merchants review these settings prior to accepting transactions.</li><li>Users must have the batches-settle transactions user right to settle transactions.</li><li>Settling a single gift card or cash transaction is not supported, the gift or cash batch must be settled entirely.</li><li>Only open transactions can be settled. Transactions set to pend or review must be set to un-pend or release prior to settlement.</li></ul>|
| `stlquery` (End of day settlement query) | Searches a manual settlement on a single, multiple or batch of transactions. **Important**<ul><li>Open batches must be reviewed prior to settlement for accuracy. You may opt to setup auto-settlement or submit a manual settlement from the integrated application. Elavon highly recommends that batches be closed out on a daily basis.</li><li>Manual settlement is not allowed for multi-currency.</li><li>Settings are available within the admin feature that can block transactions from being added to a current open batch if these do not meet certain qualifications. Elavon recommends that merchants review these settings prior to accepting transactions.</li><li>Users must have the batches-settle transactions user right to settle transactions.</li><li>Settling a single gift card or cash transaction is not supported, the gift or cash batch must be settled entirely.</li><li>Only open transactions can be settled. Transactions set to pend or review must be set to un-pend or release prior to settlement.</li></ul> |
| `recurringquery` (End of day recurring query) | Searches for a recurring or installment transaction details based on a recurring or installment id. |

### Sample credit card transaction query

Searches credit card transaction between start and end date. 
```curl
curl -X POST 'https://api.demo.convergepay.com/VirtualMerchantDemo/processxml.do' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 
'xmldata= 
<txn>
 <ssl_transaction_type>txnquery</ssl_transaction_type>
 <ssl_account_id>my_account_id</ssl_account_id>
 <ssl_user_id>my_user_id</ssl_user_id>
 <ssl_pin>my_pin</ssl_pin>
 <ssl_vendor_id>my_vendor_id</ssl_vendor_id>
 <ssl_search_start_date>MM/DD/YYYY</ssl_search_start_date>
 <ssl_search_end_date>MM/DD/YYYY</ssl_search_end_date>
 <ssl_search_card_type>creditcard</ssl_search_card_type>
</txn>'
```