Settlement Query - stlquery

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

The settlement query transaction searches 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.

Settlement query can be performed by using any of the parameters like batch response (GBOK), batch_id or correlation_id.

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_search_start_dateSearch Filter - Start Date
Start date for the transaction date range. If you submit a start date without an end date, Converge sets the value of ssl_search_end_date to ssl_search_start_date plus 31 days.
Default: End date - 31 days
Format: MM/DD/YYYY10
Conditional10alphanumeric
ssl_search_end_dateSearch Filter - End Date
End date for the transaction date range. If you submit an end date without a start date, Converge sets the value of ssl_search_start_date to ssl_search_end_date minus 31 days.
Default: Start date + 31 days
Format: MM/DD/YYYY
Optional10alphanumeric
ssl_service_fee_txn_time_utcService Fee Processing Date and Time in UTC format
Indicates when Converge processed the service fee transaction.
Format: MM/DD/YYYY hh:mm:ss

Example: 12/28/2021 10:34:10
ssl_settle_time_utcSettling Date and Time in UTC format
Indicates when Converge settled the transaction.
Format: MM/DD/YYYY hh:mm:ss

Example: 12/28/2021 10:34:10
ssl_time_zone_request_utcTime zone in Coordinated Universal Time (UTC)
Format: MM/DD/YYYY hh:mm:ss
Example: 12/28/2021 10:34:10
  • Y - Convert any provided timestamps into UTC format
  • N - Does not convert the timestamps into UTC

Important:ssl_time_zone_request_utc works completely independent of ssl_time_zone_response_utc.
Conditional20alphanumeric
ssl_time_zone_response_utcTime zone in Coordinated Universal Time (UTC)
Format: MM/DD/YYYY hh:mm:ss
Example: 12/28/2021 10:34:10
  • Y - Display the time zone in UTC
  • N - Does not display the time zone in UTC
If Y is selected, then ssl_txn_time_utc, ssl_settle_time_utc, ssl_service_fee_txn_time_utc, ssl_search_start_date, ssl_search_end_date will display in UTC format
Conditional20alphanumeric
ssl_transaction_typeTransaction Type
Value:stlquery
Required20alphanumeric
ssl_txn_time_utcProcessing Date and Time in UTC format
Indicates when Converge processed the transaction.
Format: MM/DD/YYYY hh:mm:ss

Example: 12/28/2021 10:34:10
ssl_settlement_batch_responseMain ID
It can used to query a group of settled transactions from server by passing the GBOK number.
Example: GBOK 32910121808
Optional30alphanumeric
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_settlement_batch_idBatch ID
This is a user-defined ID used to query a group of settled transaction from API.
Optional50alphanumeric

note

  • Users can use any of the optional fields (batch response (GBOK), batch_id or correlation_id) for performing Settlement query.

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 Result
Refer to the Transaction Query Response Codes section for an extensive list of possible returned messages.
batchbatch ID
Unique identifier of the batch.
settleddate_utcSettled Date and Time in UTC format
Indicates when Converge settled the transaction.
Format: MM/DD/YYYY hh:mm:ss
ssl_settlement_batch_responseMain ID
Specifies the main ID used to query a group of settled transactions from server by passing the GBOK number.
Example: GBOK 32910121808
settleddateSettled Date and Time
Indicates when Converge settled the transaction.
Format: MM/DD/YYYY hh:mm:ss
Example: 09/28/2021 02:09:10
ssl_settlement_batch_idBatch ID
Specifies the user-defined ID used to query a group of settled transaction from API.

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.

You must do any settle transaction to perform settlement query. Refer to the Settle section for more information.

Settlement Query using GBOK

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_transaction_type>STLQUERY</ssl_transaction_type>
    <ssl_settlement_batch_response>GBOK 36909281459</ssl_settlement_batch_response>
</txn>

Response

<transaction>
    <ssl_result>0</ssl_result>
    <batch>369</batch>
    <ssl_settlement_batch_response>GBOK 36909281459</ssl_settlement_batch_response>
    <settleddate>09/28/2021 02:09:09</settleddate>
    <ssl_settlement_batch_id>00102020202020208</ssl_settlement_batch_id>
    <main>
        <netcount>2</netcount>
        <baseamount>0.00</baseamount>
        <tipamount>0.00</tipamount>
        <netamount>2.00</netamount>
        <numberpurchaseforces>2</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </main>
    <gift>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </gift>
    <loyalty>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </loyalty>
    <cash>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </cash>
    <paypal>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </paypal>
</transaction>

Settlement Query using Batch ID

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_transaction_type>STLQUERY</ssl_transaction_type>
    <ssl_settlement_batch_id>00102020202020208</ssl_settlement_batch_id>
</txn>

Response

<transaction>
    <ssl_result>0</ssl_result>
    <batch>369</batch>
    <ssl_settlement_batch_response>GBOK 36909281459</ssl_settlement_batch_response>
    <settleddate>09/28/2021 02:09:09</settleddate>
    <ssl_settlement_batch_id>00102020202020208</ssl_settlement_batch_id>
    <main>
        <netcount>2</netcount>
        <baseamount>0.00</baseamount>
        <tipamount>0.00</tipamount>
        <netamount>2.00</netamount>
        <numberpurchaseforces>2</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </main>
    <gift>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </gift>
    <loyalty>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </loyalty>
    <cash>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </cash>
    <paypal>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </paypal>
</transaction>

Settlement Query using Correlation ID

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_transaction_type>STLQUERY</ssl_transaction_type>
    <ssl_settlement_correlation_id>12345-aaaaa-11111-22222-bbbbb</ssl_settlement_correlation_id>
</txn>

Response

<transaction>
    <ssl_result>0</ssl_result>
    <batch>369</batch>
    <ssl_settlement_batch_response>GBOK 36909281459</ssl_settlement_batch_response>
    <settleddate>09/28/2021 02:09:09</settleddate>
    <ssl_settlement_batch_id>00102020202020208</ssl_settlement_batch_id>
    <main>
        <netcount>2</netcount>
        <baseamount>0.00</baseamount>
        <tipamount>0.00</tipamount>
        <netamount>2.00</netamount>
        <numberpurchaseforces>2</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </main>
    <gift>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </gift>
    <loyalty>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </loyalty>
    <cash>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </cash>
    <paypal>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </paypal>
</transaction>