Recurring Query - recurringquery

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

The recurringquery transaction searches for a recurring or installment transaction details based on a recurring or installment id.

In this section:

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

Request

note

Search only allows the use of a single card information and installment id or recurring id. Search does not allow multiple card information data on a single request.

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_installment_idRecurring ID
Unique Identifier of the installment transaction
Valid Value:  installment id
Optional46alphanumeric
ssl_recurring_idRecurring ID
Unique Identifier of the recurring transaction
Valid Value:  recurring id
Optional46alphanumeric
ssl_transaction_typeTransaction Type
Valid Value:   recurringquery
Required20alphanumeric

Response

note

  • Converge lists the query result in descending date/time order.
  • When the query is based on Transaction ID, the query result contains one single unique transaction or lists all the product line items for Level 3 transactions.
  • When the query is based on a Card Data parameter, Converge retrieves transactions from the Open and Settled batches that are within the last two months.
  • When the query is based on Card Data and Date Range parameters, Converge retrieves transactions from the Open and Settled batches that match the specified date range.
  • When the query returns more than a single transaction, the detailed response of each transaction will contain the original response along with the Transaction Status (ssl_trans_status).
Field nameDescription
ssl_amountTotal Authorized/Approved Transaction Amount
Returned based on merchant setup.
ssl_card_typeCard Type
Payment method used for the transaction.
Valid Values:
  • CREDITCARD
  • DEBITCARD
  • FOODSTAMP
  • CASHBENEFIT
  • ELECTRONICCHECK
  • GIFTCARD
  • LOYALTY
  • CASH
ssl_card_numberMasked Card Number
Converge only returns the first 2 or last 4 digits of the regular PAN, or the last 4 digits of the actual card number if it is an association token (example, ApplePay).
ssl_exp_dateCard’s Expiry Date
Returned based on merchant setup.
ssl_billing_cycleBilling Cycle
ssl_last_payment_datePayment last Date
The date when the payment ends.
Format: MM/DD/YYYY
ssl_next_payment_dateNext Payment Due Date
The date when the next payment is due.
Format: MM/DD/YYYY
ssl_next_installmentCount of the next installments
ssl_total_installmentsNumber of total installments
ssl_installment_idInstallment ID
Unique Identifier of the added installment transaction.
ssl_recurring_idRecurring ID
Unique identifier of the added recurring record.
ssl_start_payment_datePayment Start Date
The date when the first payment started. If recently added, the start date is the same as the next payment due date.
Format: MM/DD/YYYY
ssl_total_installmentsNumber of total installments

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.

Recurring Query

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>recurringquery</ssl_transaction_type>
    <ssl_recurring_id>160720MB-105A1B2E-DDEC-4D17-B898-A88E4C91ACF2</ssl_recurring_id>
</txn>

Response

<txn>
    <ssl_recurring_id>160720MB-105A1B2E-DDEC-4D17-B898-A88E4C91ACF2</ssl_recurring_id>
    <ssl_amount>4.24</ssl_amount>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_card_number>54**********4111</ssl_card_number>
    <ssl_exp_date>1228</ssl_exp_date>
    <ssl_start_date>07/24/2020</ssl_start_date>
    <ssl_billing_cycle>MONTHLY</ssl_billing_cycle>
    <ssl_next_payment_date>11/24/2020</ssl_next_payment_date>
    <ssl_last_payment_date>05/19/2021</ssl_last_payment_date>
    <ssl_number_of_payments>5</ssl_number_of_payments>
</txn>

Installment Query

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>recurringquery</ssl_transaction_type>
    <ssl_installment_id>070122MB-757EB32C-BF68-4A3B-B3AE-2D68934C0BAA</ssl_installment_id>
</txn>

Response

<txn>
    <ssl_installment_id>070122MB-757EB32C-BF68-4A3B-B3AE-2D68934C0BAA</ssl_installment_id>
    <ssl_amount>22</ssl_amount>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_card_number>54**********4111</ssl_card_number>
    <ssl_exp_date>1228</ssl_exp_date>
    <ssl_start_date>12/24/2022</ssl_start_date>
    <ssl_billing_cycle>MONTHLY</ssl_billing_cycle>
    <ssl_next_payment_date>02/07/2022</ssl_next_payment_date>
    <ssl_last_payment_date>01/07/2022</ssl_last_payment_date>
    <ssl_next_installment>2</ssl_next_installment>
    <ssl_total_installments>12</ssl_total_installments>          
</txn>