Settle - settle

This section describes the message parameters for End of Day Settle transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.

The settle transaction initiates a manual settlement on a single, multiple or batch of transactions.

important

  • Open batches must be reviewed prior to settlement for accuracy. You may opt to set the terminal for auto-settlement or submit a manual settlement from the integrated application. Elavon highly recommends that batches be closed out on a daily basis.
  • Manual settlement is not allowed for terminals that are setup for Multi-Currency.
  • Settings are available within the Admin feature of the Virtual Terminal 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.

In this section:

For the entire list of API endpoints, refer to API Endpoints.

Request

note

  • Users must have the Batches-Settle Transactions user right in order to settle transactions.
  • Settling a single Gift Card or Cash transaction is not supported, the Gift or Cash batch must be settled entirely.
  • Only Open transactions can be settled. Transactions set to Pend or Review must be set to Unpend or Release prior to settlement.
Field nameDescriptionRequiredLengthData type
ssl_merchant_idMerchant ID
Elavon-assigned Converge Account ID (AID).		Required6 or 7numeric
ssl_user_idConverge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.		Required15alphanumeric
ssl_pinTerminal ID
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
Important: The ssl_user_id sending the transaction request must be associated with the terminal that will process the request.		Required64alphanumeric
ssl_settlement_batch_idBatch ID
This is a user-defined ID used to query a group of settled transaction from API.		Optional50alphanumeric
ssl_settlement_correlation_idCorrelation ID
Specifies the number of transactions processed from eMoney. This is a user-defined ID which has specific format used to query settled transaction.
  • Characters with four hyphens
Optional36alphanumeric
ssl_transaction_typeTransaction Type
Value:  settle		Required20alphanumeric
ssl_txn_idTransaction ID
Unique identifier of the original transaction.
Important:
  • Only submit this parameter when settling a single Credit Card transaction or multiple (but not all) transactions.
  • For multiple transactions, this parameter must be nested within a single txnGroup/txnGroup element. The number of ssl_txn_id parameters in this element corresponds to the number of transactions to be settled.
Conditional46alphanumeric

Response

note

Funds will be moved from the customer’s account to the merchant account once the batch is successfully settled.

Field nameDescription
ssl_resultTransaction Outcome
An ssl_result = 0 indicates an approved transaction.
An ssl_result not equal to 0 indicates a declined and unauthorized transaction.
ssl_result_messageTransaction Result Message
Refer to the Transaction Settlement Response Codes section for an extensive list of possible returned messages.
Important:
  • An Empty batch response indicates that there are no transactions in the current batches waiting to be settled.
  • A Scheduled for Settlement response indicates that the batch will be submitted for settlement. In order to check the status of a transaction, the integrated application may use Transaction Query (txnquery) to obtain information on the status of the transaction.
ssl_settlement_batch_idBatch ID
Specifies the user-defined ID used to query a group of settled transaction from API.
ssl_settlement_correlation_idCorrelation ID
Specifies the number of transactions processed from eMoney. This is a user-defined ID which has specific format used to query settled transaction.
ssl_txn_idTransaction ID
Unique identifier returned on the original transaction. This is to settle an individual transaction sent in the request.
ssl_txn_timeProcessing Date and Time
Indicates when Converge processed the transaction.
Format: MM/DD/YYYY hh:mm:ss AM/PM
Example: 03/18/2010 10:34:10 AM
ssl_txn_main_countTotal Transaction Count in Main Batch
ssl_txn_main_amountTotal Transaction Amount in Main Batch
ssl_txn_cash_countTotal Cash Count in Cash Batch
ssl_txn_cash_amountTotal Cash Amount in Cash Batch
ssl_txn_loyalty_countTotal Loyalty Card Count in Loyalty Batch
ssl_txn_loyalty_amountTotal Loyalty Card Amount in Loyalty Batch
ssl_txn_ecg_countTotal Gift Card Count in Gift Batch
ssl_txn_ecg_amountTotal Gift Card Amount in Gift Batch
[Error]Returned only if an error occurs. Refer to the Error Codes section for more information.
errorCodeError Code
Typically, when the transaction failed validation or the request is incorrect. This will prevent the transaction from going to authorization. This is a numeric field.
errorMessageError Message
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
errorNameError Name
Error name or reason for the error.

Examples

important

  • In these examples, you will have to change the data values, such as my_merchant_id, my_user_id, my_pin, and transaction data to match your Converge account and meet the needs of your website.
  • Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.

Single Transaction Settlement

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_test_mode>false</ssl_test_mode>
    <ssl_transaction_type>settle</ssl_transaction_type>
    <ssl_txn_id>AA48439-65E7D601-5E31-4809-882A-2028CBC3A979</ssl_txn_id>
</txn>

Response

<txn>
    <ssl_result>0</ssl_result>
    <ssl_result_message>Scheduled for Settlement</ssl_result_message>
    <ssl_txn_id>AA48439-65E7D601-5E31-4809-882A-2028CBC3A979</ssl_txn_id>
    <ssl_txn_main_count>1</ssl_txn_main_count>
    <ssl_txn_main_amount>16.00</ssl_txn_main_amount>
    <ssl_txn_ecg_count>0</ssl_txn_ecg_count>
    <ssl_txn_ecg_amount/>
</txn>

Settle a Group of Transactions

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>settle</ssl_transaction_type>
    <txnGroup>
    <ssl_txn_id>TXN ID</ssl_txn_id>
    <ssl_txn_id>TXN ID</ssl_txn_id>
    </txnGroup>
</txn>

Batch Settlement

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_test_mode>false</ssl_test_mode>
    <ssl_transaction_type>settle</ssl_transaction_type>
</txn>

Response

<txn>
    <ssl_result>0</ssl_result>
    <ssl_result_message>Scheduled for Settlement</ssl_result_message>
    <ssl_txn_id/>
    <ssl_txn_main_count>10</ssl_txn_main_count>
    <ssl_txn_main_amount>220.00</ssl_txn_main_amount>
    <ssl_txn_ecg_count>2</ssl_txn_ecg_count>
    <ssl_txn_ecg_amount>50.00</ssl_txn_ecg_amount>
</txn>

Use Batch ID

Request

xmldata=
<txn>
    <ssl_merchant_id>000006</ssl_merchant_id>
    <ssl_user_id>user</ssl_user_id>
    <ssl_pin>W5E5G</ssl_pin>
    <ssl_transaction_type>SETTLE</ssl_transaction_type>
    <ssl_settlement_batch_id>00102020202020200</ssl_settlement_batch_id>
</txn>

Response

<txn>
<ssl_result>0</ssl_result>
<ssl_result_message>Scheduled for Settlement</ssl_result_message>
<ssl_txn_id/>
<ssl_settlement_batch_id>00102020202020208</ssl_settlement_batch_id>
<ssl_txn_main_count>2</ssl_txn_main_count>
<ssl_txn_main_amount>2.00</ssl_txn_main_amount>
<ssl_txn_ecg_count>0</ssl_txn_ecg_count>
<ssl_txn_ecg_amount>0.00</ssl_txn_ecg_amount>
</txn>