Add Recurring - ccaddrecurring

This topic describes the message parameters for Credit Card Add Recurring transaction processing, which you can submit using the Hosted Payments, Checkout.js, and XML API integration methods. Refer to the Integration Methods section for more information.

The ccaddrecurring transaction adds a credit card recurring record to the Converge recurring batch. Once added, the transaction will run automatically within the specified billing cycle on the scheduled payment day without the need to send it for authorization.

In this topic:

• Request
• Response
• Example

Request

Field name	Description	Required	Length	Data type
ssl_merchant_id	Merchant ID Elavon-assigned Converge account ID.	Required	15	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. error_outline important 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: ccaddrecurring	Required	20	alphanumeric
[Card Data]	Use the appropriate card data parameters for the transaction.
ssl_card_number	Card Number Card Number as it appears on the credit card. error_outline important Required when adding a recurring record using a card number.	Conditional	18	numeric
ssl_exp_date	Card's Expiry Date Date when the card becomes invalid. Format: MMYY error_outline important Required if ssl_card_number is not null.	Conditional	4	numeric
ssl_token	Credit Card Token Encrypted card data that can replace ssl_card_number. error_outline important Required when adding a recurring record using a token. If token is stored in Card Manager, the expiration date, first name, last name, and AVS data on file are used. Use only if the terminal is set up with the Tokenization terminal option.	Conditional	20	alphanumeric
ssl_txn_id	Transaction ID Unique identifier of the approved Sale (ccsale), Auth Only (ccauthonly), Force (ccforce), or Return (ccreturn) transaction. Only applicable to XML API. error_outline important Required when adding a recurring record based on a previously approved transaction.	Required	46	alphanumeric
[Payment Schedule]
ssl_amount	Transaction Amount The recurring amount that includes the Net and Sales Tax amounts. Format: Number with 2 decimals places	Required	11	numeric
ssl_next_payment_date	Next Payment Date The date of the next scheduled payment for the recurring record. Format: MM/DD/YYYY	Required	10	alphanumeric
ssl_billing_cycle	Billing Cycle Valid values: DAILY, WEEKLY, BIWEEKLY, SEMIMONTHLY, MONTHLY, BIMONTHLY, QUARTERLY, SEMESTER, SEMIANNUALLY, ANNUALLY, SUSPENDED	Required	12	alphanumeric
ssl_bill_on_half	Half of the Month or Semimonthly Indicator Indicates when to process recurring payment transactions if ssl_billing_cycle = SEMIMONTHLY. Valid values: 1 - 1st and 15th of the month 2 - 15th and last day of the month	Conditional	1	numeric
ssl_end_of_month	End of Month Indicator Indicates whether to process the recurring transaction on the last day of the month. Valid values: Y - Yes N - No Select Y to process the recurring transaction: If ssl_billing_cycle = MONTHLY, BIMONTHLY, QUARTERLY, SEMESTER or SEMIANNUALLY and the Start Payment Date is April 30, June 30, September 30, November 30, February 28 (non-Leap year) or February 29 (Leap year). If ssl_billing_cycle = ANNUALLY and the Start Payment Date is February 28 (non-Leap year) or February 29 (Leap year).	Conditional	1	alphanumeric
ssl_skip_payment	Skip Payment Indicator Valid values: Y - Skip payment N - Do not skip payment (Default)	Optional	1	alphanumeric
[Optional Fields]
ssl_avs_address	Address Line 1 Commonly the house number and street name on the cardholder's / customer's account or billing address. Address Verification Service (AVS) data compared with the address on the card issuer's file.	Optional	30	alphanumeric
ssl_avs_zip	Postal or ZIP Code ZIP code on the cardholder's account or billing address. Address Verification Service (AVS) data compared with the postal or ZIP code on the card issuer's file.	Optional	9	alphanumeric
ssl_first_name	First Name First name on the cardholder's / customer's account or billing address.	Optional	20	alphanumeric
ssl_last_name	Last Name Last name on the cardholder's / customer's account or billing address.	Optional	30	alphanumeric
[Purchasing Cards]	Use only on terminals that are set up with the Purchasing Card 2 credit card payment option.
ssl_customer_code	Customer Code or Purchase Order Number Customer ID or PO number specified in the billing statement of the cardholder.	Optional	17	alphanumeric
ssl_salestax	Sales Tax Tax amount to add to the purchase or sales amount. For a tax exempt transaction, enter 0.00. Format: Amount with 2 decimal places.	Optional	8	alphanumeric
[Invoice Number]	Returned only if Invoice Number parameters are sent in the request.
ssl_invoice_number	Invoice Number The invoice number or ticket number sent in the original request.	Optional	25	alphanumeric
[Doing Business As]	Use only on terminals that are set up with the DBA Name terminal option.
ssl_dynamic_dba	Doing Business As Name Merchant-defined descriptors that replace the merchant's business name on credit card statements. Format: Prefix*Descriptor Length: Prefix = 3, 7, or 12, Asterisk = 1, Descriptor = 21 - (Prefix + Asterisk) Example: MANYMAG*BAKERS MONTHLY	Optional	21	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 A result of SUCCESS indicates that the recurring record was added. A result of ERROR indicates that the recurring record was not added.
ssl_user_id	Converge User ID
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 added recurring record. error_outline important Returned only if ssl_result_message = SUCCESS.
ssl_amount	Recurring Amount
ssl_billing_cycle	Billing Cycle
ssl_next_payment_date	Next Payment Due Date
ssl_start_payment_date	Payment 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_recurring_batch_count	Recurring Batch Count The current number of transactions sitting in the recurring batch after the recurring transaction has been added.
[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

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>ccaddrecurring</ssl_transaction_type>
    <ssl_card_number>0000000000000000</ssl_card_number>
    <ssl_exp_date>1212</ssl_exp_date>
    <ssl_amount>10.36</ssl_amount>
    <ssl_billing_cycle>MONTHLY</ssl_billing_cycle>
    <ssl_next_payment_date>01/31/2012</ssl_next_payment_date>
    <ssl_end_of_month>Y</ssl_end_of_month>
    <ssl_invoice_number>1111</ssl_invoice_number>
</txn>

Response

<txn>
    <ssl_start_payment_date>01/31/2012</ssl_start_payment_date>
    <ssl_transaction_type>CCADDRECURRING</ssl_transaction_type>
    <ssl_card_number>00**********00000</ssl_card_number>
    <ssl_exp_date>1212</ssl_exp_date>
    <ssl_amount>10.36</ssl_amount>
    <ssl_next_payment_date>01/31/2012</ssl_next_payment_date>
    <ssl_billing_cycle>MONTHLY</ssl_billing_cycle>
    <ssl_result_message>SUCCESS</ssl_result_message>
    <ssl_recurring_id>AA484C3-8E5D1201-A05E-824D-9DAD-E3534E83F078</ssl_recurring_id>
    <ssl_number_of_payments>0</ssl_number_of_payments>
    <ssl_skip_payment>N</ssl_skip_payment>
    <ssl_recurring_batch_count>65</ssl_recurring_batch_count>
</txn>

• previous Signature - ccsignature
• next Update Recurring - ccupdaterecurring