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

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: ccaddrecurring
[Card Data]
Use the appropriate card data parameters for the transaction.
ssl_card_number
18 | numeric | conditional
Card Number
Card Number as it appears on the credit card.
Important: Required when adding a recurring record using a card number.
ssl_exp_date
4 | numeric | conditional
Card's Expiry Date
Date when the card becomes invalid.
Important: Required if ssl_card_number is not null.
Format: MMYY
ssl_token
20 | alphanumeric | conditional
Credit Card Token
Encrypted card data that can replace ssl_card_number.
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.
ssl_txn_id
46 | alphanumeric | required
Transaction ID
Unique identifier of the approved Sale (ccsale), Auth Only (ccauthonly), Force (ccforce), or Return (ccreturn) transaction.
Important:
  • Required when adding a recurring record based on a previously approved transaction.
  • Only applicable to XML API.
[Payment Schedule]
 
ssl_amount
11 | numeric | required
Transaction Amount
The Recurring amount that includes the Net and Sales Tax amounts.
Format: Number with 2 decimals places
ssl_next_payment_date
10 | alphanumeric | required
Next Payment Date
The date of the next scheduled payment for the recurring record.
Format: MM/DD/YYYY
ssl_billing_cycle
12 | alphanumeric | required
Billing Cycle
Valid values: DAILY,  WEEKLY,  BIWEEKLY,  SEMIMONTHLY,  MONTHLY,  BIMONTHLY,  QUARTERLY,  SEMESTER,  SEMIANNUALLY,  ANNUALLY,  SUSPENDED
ssl_bill_on_half
1 | numeric | conditional
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
ssl_end_of_month
1 | alphanumeric | conditional
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).
ssl_skip_payment
1 | alphanumeric | optional
Skip Payment Indicator
Valid values:
  • Y - Skip payment
  • N - Do not skip payment (Default)
[Optional Fields]
 
ssl_avs_address
30 | alphanumeric | optional
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.
ssl_avs_zip
9 | alphanumeric | optional
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.
ssl_first_name
20 | alphanumeric | optional
First Name
First name on the cardholder's / customer's account or billing address.
ssl_last_name
30 | alphanumeric | optional
Last Name
Last name on the cardholder's / customer's account or billing address.
[Purchasing Cards]
Use only on terminals that are set up with the Purchasing Card 2   credit card payment option.
ssl_customer_code
17 | alphanumeric | optional
Customer Code or Purchase Order Number
Customer ID or PO number specified in the billing statement of the cardholder.
ssl_salestax
8 | alphanumeric | optional
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.
[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.
[Doing Business As]
Use only on terminals that are set up with the DBA Name   terminal option.
ssl_dynamic_dba
21 | alphanumeric | optional
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

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
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.
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

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.

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>