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 topic:
Request
ssl_merchant_id 15 | numeric | required | Merchant ID Elavon-assigned Converge account ID. |
ssl_user_id 15 | alphanumeric | required | Converge User ID The user ID with Hosted Payment API User status that can send transaction requests through the terminal. |
ssl_pin 64 | alphanumeric | required | Terminal 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. |
ssl_transaction_type 20 | alphanumeric | required | Transaction Type Value: ccrecurringsale |
ssl_recurring_id 50 | alphanumeric | required | Recurring ID Unique identifier of the recurring payment record to be submitted for payment. |
[Tokenization] | Use only on terminals that are set up with the Tokenization terminal option. |
ssl_add_token 1 | alphanumeric | optional | Add to Card Manager Indicator Indicates whether to generate and store the token in Card Manager. Valid values:
|
ssl_first_name 20 | alphanumeric | conditional | First Name First name on the cardholder's / customer's account or billing address. Important:: Required if ssl_add_token is set to Y. |
ssl_last_name 30 | alphanumeric | conditional | Last Name Last name on the cardholder's / customer's account or billing address. Important:: Required if ssl_add_token is set to Y. |
ssl_get_token 1 | alphanumeric | optional | Generate Token Indicator Indicates whether to generate a token when submitting the card data. Valid values:
|
[Card On File] | |
ssl_merchant_initiated_unscheduled 1 | alphanumeric | optional | 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:
|
Response
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 ran 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
This example demonstrates the XML code needed to pass the minimum required data to send a recurring sale outside of the billing cycle.
<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>AA484C3-B08B6F1B-4765-A1FF-C0BC-5722F21A0EB6</ssl_recurring_id>
</txn>