Submit Recurring Payment - ccrecurringsale
This topic describes the message parameters for Credit Card Recurring Sale transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
The ccrecurringsale transaction allows you to run a credit card recurring payment outside of its billing cycle. This will increase the payment number.
In this section:
For the entire list of API endpoints, refer to API Endpoints.
Request
| Field name | Description | Required | Length | Data type |
|---|---|---|---|---|
ssl_merchant_id | Merchant ID Elavon-assigned Converge Account ID (AID). | Required | 6 or 7 | numeric |
ssl_user_id | Converge user ID The user ID with Hosted Payment API user status that can send transaction requests through the terminal. | Required | 15 | alphanumeric |
ssl_pin | Terminal ID Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway. The ssl_user_id sending the transaction request must be associated with the terminal that will process the request. | Required | 64 | alphanumeric |
ssl_transaction_type | Transaction Type Valid Value: ccrecurringsale | Required | 20 | alphanumeric |
ssl_recurring_id | Recurring ID Unique identifier of the recurring payment record to be submitted for payment. | Required | 50 | alphanumeric |
| [Tokenization] | Use only on terminals that are set up with the Tokenization terminal option. | |||
ssl_add_token | Add to Card Manager Indicator Indicates whether to generate and store the token in Card Manager. Valid values:
| Optional | 1 | alphanumeric |
ssl_first_name | First Name First name on the cardholder’s / customer’s account or billing address. Required if ssl_add_token is set to Y. | Conditional | 50 | alphanumeric |
ssl_last_name | Last Name Last name on the cardholder’s / customer’s account or billing address. Required if ssl_add_token is set to Y. | Conditional | 50 | alphanumeric |
ssl_get_token | Generate Token Indicator Indicates whether to generate a token when submitting the card data. Valid values:
| Optional | 1 | alphanumeric |
| [Card On File] | ||||
ssl_merchant_initiated_unscheduled | Merchant-Initiated Unscheduled Transaction Indicator Indicates the transaction was initiated by a merchant using a stored credential (token or stored card number) for a fixed or variable amount that does not occur on a scheduled or regularly occurring transaction date. Valid values:
| Optional | 1 | alphanumeric |
Response
| Field name | Description |
|---|---|
ssl_result | Transaction Outcome An ssl_result = 0 indicates an approved transaction.An ssl_result not equal to 0 indicates a declined and unauthorized transaction. |
ssl_result_message | Transaction Result Message Refer to the Payment Card Response Codes section for an extensive list of possible returned messages. |
ssl_txn_id | Transaction ID Unique identifier of the transaction. |
ssl_txn_time | Processing 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_approval_code | Transaction Approval Code Unique code returned by the credit card processor that indicates the approval status of the transaction. |
ssl_amount | Total Authorized/Approved Transaction Amount Returned based on merchant setup. |
ssl_card_number | Masked 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_date | Card’s Expiry Date Returned based on merchant setup. |
ssl_recurring_id | Recurring ID Unique identifier of the submitted recurring record. Important: Returned only if ssl_result_message = SUCCESS. |
ssl_billing_cycle | Billing Cycle |
ssl_next_payment_date | Next Payment Due Date |
ssl_number_of_payments | Number of Payments The current number of payments run on the system. Returned by Converge. |
ssl_invoice_number | Invoice Number The invoice number or ticket number sent in the original request. Returned based on merchant setup. |
| [Error] | Returned only if an error occurs. Refer to the Error Codes section for more information. |
errorCode | Error 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. |
errorMessage | Error Message Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface. |
errorName | Error Name Error name or reason for the error. |
Example
error_outline
important
- In this example, 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.
This example demonstrates the XML code needed to pass the minimum required data to send a recurring sale outside of the billing cycle.
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>ccrecurringsale</ssl_transaction_type>
<ssl_recurring_id>220422A41-E6397287-F9F4-4D7C-8163-F6EE302192EA</ssl_recurring_id>
</txn>
Response
<txn>
<ssl_company></ssl_company>
<ssl_phone></ssl_phone>
<ssl_ship_to_last_name></ssl_ship_to_last_name>
<ssl_amount>15.00</ssl_amount>
<ssl_transaction_currency>CAD</ssl_transaction_currency>
<ssl_recurring_id>220422A41-E6397287-F9F4-4D7C-8163-F6EE302192EA</ssl_recurring_id>
<ssl_card_short_description>VISA</ssl_card_short_description>
<ssl_start_payment_date>05/31/2022</ssl_start_payment_date>
<ssl_avs_address>first street</ssl_avs_address>
<ssl_recurring_batch_count>135</ssl_recurring_batch_count>
<ssl_ps2000_data>A000000000000000 A</ssl_ps2000_data>
<ssl_state></ssl_state>
<ssl_ship_to_zip></ssl_ship_to_zip>
<ssl_ship_to_phone></ssl_ship_to_phone>
<ssl_ship_to_city></ssl_ship_to_city>
<ssl_ship_to_address1></ssl_ship_to_address1>
<ssl_ship_to_address2></ssl_ship_to_address2>
<ssl_merchant_initiated_unscheduled>N</ssl_merchant_initiated_unscheduled>
<ssl_issuer_response>00</ssl_issuer_response>
<ssl_last_name></ssl_last_name>
<ssl_billing_cycle>SUSPENDED</ssl_billing_cycle>
<ssl_card_number>41**********1111</ssl_card_number>
<ssl_oar_data>010010855604221642390000047554200000000000476322211216108556</ssl_oar_data>
<ssl_result>0</ssl_result>
<ssl_txn_id>270422E3A-83BCDD1F-C442-4AB4-BEE8-DE74674387B9</ssl_txn_id>
<ssl_avs_response>N</ssl_avs_response>
<ssl_approval_code>693856</ssl_approval_code>
<ssl_email></ssl_email>
<ssl_avs_zip>95391</ssl_avs_zip>
<ssl_txn_time>04/27/2022 07:07:56 PM</ssl_txn_time>
<ssl_exp_date>1222</ssl_exp_date>
<ssl_address2></ssl_address2>
<ssl_country></ssl_country>
<ssl_card_type>CREDITCARD</ssl_card_type>
<ssl_transaction_type>CCRECURRINGSALE</ssl_transaction_type>
<ssl_next_payment_date>05/31/2022</ssl_next_payment_date>
<ssl_ship_to_first_name></ssl_ship_to_first_name>
<ssl_ship_to_company></ssl_ship_to_company>
<ssl_ship_to_state></ssl_ship_to_state>
<ssl_account_balance>0.00</ssl_account_balance>
<ssl_ship_to_country></ssl_ship_to_country>
<ssl_city></ssl_city>
<ssl_result_message>APPROVAL</ssl_result_message>
<ssl_first_name></ssl_first_name>
<ssl_skip_payment>N</ssl_skip_payment>
<ssl_cvv2_response></ssl_cvv2_response>
<ssl_partner_app_id>01</ssl_partner_app_id>
</txn>